Struct CustomObjects

pub struct CustomObjects {
    pub client: Client,
}

Fields

client: Client

Implementations

impl CustomObjects

pub async fn list<'a>( &'a self, cursor: Option<String>, ) -> Result<ListCustomObjectsResponse, Error>

List custom objects

A List of custom objects

• Requires: API Tier 1

Parameters:

• cursor: Option<String>

use futures_util::TryStreamExt;
async fn example_custom_objects_list_stream() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut custom_objects = client.custom_objects();
    let mut stream = custom_objects.list_stream();
    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<'a>( &'a self, body: &CreateCustomObjectsRequestBody, ) -> Result<CustomObject, Error>

Create a new custom object

Create a new custom object

async fn example_custom_objects_create() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::CustomObject = client
        .custom_objects()
        .create(&rippling_api::types::CreateCustomObjectsRequestBody {
            name: Some("some-string".to_string()),
            description: Some("some-string".to_string()),
            category: Some("some-string".to_string()),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

Retrieve a specific custom object

Retrieve a specific custom object

Parameters:

• custom_object_api_name: &'astr (required)

async fn example_custom_objects_get() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::CustomObject = client.custom_objects().get("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

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

Delete a custom object

Parameters:

• custom_object_api_name: &'astr (required)

async fn example_custom_objects_delete() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    client.custom_objects().delete("some-string").await?;
    Ok(())
}

pub async fn update<'a>( &'a self, custom_object_api_name: &'a str, body: &UpdateCustomObjectsRequestBody, ) -> Result<CustomObject, Error>

Update a custom object

Updated a specific custom object

Parameters:

• custom_object_api_name: &'astr (required)

async fn example_custom_objects_update() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::CustomObject = client
        .custom_objects()
        .update(
            "some-string",
            &rippling_api::types::UpdateCustomObjectsRequestBody {
                name: Some("some-string".to_string()),
                description: Some("some-string".to_string()),
                category: Some("some-string".to_string()),
                plural_label: Some("some-string".to_string()),
                owner_role: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for CustomObjects

fn clone(&self) -> CustomObjects

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomObjects

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

Formats the value using the given formatter.