Struct CustomObjectFields

pub struct CustomObjectFields {
    pub client: Client,
}

Fields

client: Client

Implementations

impl CustomObjectFields

pub async fn list_custom_objects_custom_object_api_name_fields<'a>( &'a self, cursor: Option<String>, custom_object_api_name: &'a str, ) -> Result<ListCustomObjectsCustomObjectApiNameFieldsResponse, Error>

List custom object fields

A List of custom object fields

• Requires: API Tier 1

Parameters:

• cursor: Option<String>
• custom_object_api_name: &'astr (required)

use futures_util::TryStreamExt;
async fn example_custom_object_fields_list_custom_objects_custom_object_api_name_fields_stream(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut custom_object_fields = client.custom_object_fields();
    let mut stream = custom_object_fields
        .list_custom_objects_custom_object_api_name_fields_stream("some-string");
    loop {
        match stream.try_next().await {
            Ok(Some(item)) => {
                println!("{:?}", item);
            }
            Ok(None) => {
                break;
            }
            Err(err) => {
                return Err(err.into());
            }
        }
    }

    Ok(())
}

pub async fn create_custom_objects_custom_object_api_name_fields<'a>( &'a self, custom_object_api_name: &'a str, body: &CreateCustomObjectsCustomObjectApiNameFieldsRequestBody, ) -> Result<CustomObjectField, Error>

Create a new custom object field

Create a new custom object field

Parameters:

• custom_object_api_name: &'astr (required)

async fn example_custom_object_fields_create_custom_objects_custom_object_api_name_fields(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::CustomObjectField = client
        .custom_object_fields()
        .create_custom_objects_custom_object_api_name_fields(
            "some-string",
            &rippling_api::types::CreateCustomObjectsCustomObjectApiNameFieldsRequestBody {
                name: Some("some-string".to_string()),
                description: Some("some-string".to_string()),
                required: Some(true),
                is_unique: Some(true),
                enable_history: Some(true),
                derived_field_formula: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn get_custom_objects_custom_object_api_name_fields<'a>( &'a self, custom_object_api_name: &'a str, field_api_name: &'a str, ) -> Result<CustomObjectField, Error>

Retrieve a specific custom object field

Retrieve a specific custom object field

Parameters:

• custom_object_api_name: &'astr (required)
• field_api_name: &'astr (required)

async fn example_custom_object_fields_get_custom_objects_custom_object_api_name_fields(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::CustomObjectField = client
        .custom_object_fields()
        .get_custom_objects_custom_object_api_name_fields("some-string", "some-string")
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn delete_custom_objects_custom_object_api_name_fields<'a>( &'a self, custom_object_api_name: &'a str, field_api_name: &'a str, ) -> Result<(), Error>

Delete a custom object field

Delete a custom object field

Parameters:

• custom_object_api_name: &'astr (required)
• field_api_name: &'astr (required)

async fn example_custom_object_fields_delete_custom_objects_custom_object_api_name_fields(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    client
        .custom_object_fields()
        .delete_custom_objects_custom_object_api_name_fields("some-string", "some-string")
        .await?;
    Ok(())
}

pub async fn update_custom_objects_custom_object_api_name_fields<'a>( &'a self, custom_object_api_name: &'a str, field_api_name: &'a str, body: &UpdateCustomObjectsCustomObjectApiNameFieldsRequestBody, ) -> Result<CustomObjectField, Error>

Update a custom object field

Updated a specific custom object field

Parameters:

• custom_object_api_name: &'astr (required)
• field_api_name: &'astr (required)

async fn example_custom_object_fields_update_custom_objects_custom_object_api_name_fields(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::CustomObjectField = client
        .custom_object_fields()
        .update_custom_objects_custom_object_api_name_fields(
            "some-string",
            "some-string",
            &rippling_api::types::UpdateCustomObjectsCustomObjectApiNameFieldsRequestBody {
                name: Some("some-string".to_string()),
                description: Some("some-string".to_string()),
                required: Some(true),
                is_unique: Some(true),
                enable_history: Some(true),
                derived_field_formula: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for CustomObjectFields

fn clone(&self) -> CustomObjectFields

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CustomObjectFields

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.