Struct ObjectCategories

pub struct ObjectCategories {
    pub client: Client,
}

Fields

client: Client

Implementations

impl ObjectCategories

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

List object categories

A List of object categories

• Requires: API Tier 1

Parameters:

• cursor: Option<String>

use futures_util::TryStreamExt;
async fn example_object_categories_list_stream() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut object_categories = client.object_categories();
    let mut stream = object_categories.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: &CreateObjectCategoriesRequestBody, ) -> Result<ObjectCategory, Error>

Create a new object category

Create a new object category

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

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

Retrieve a specific object category

Retrieve a specific object category

Parameters:

• id: &'astr (required)

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

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

Delete a object category

Parameters:

• id: &'astr (required)

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

pub async fn update<'a>( &'a self, id: &'a str, body: &UpdateObjectCategoriesRequestBody, ) -> Result<ObjectCategory, Error>

Update a object category

Updated a specific object category

Parameters:

• id: &'astr (required)

async fn example_object_categories_update() -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::ObjectCategory = client
        .object_categories()
        .update(
            "some-string",
            &rippling_api::types::UpdateObjectCategoriesRequestBody {
                name: Some("some-string".to_string()),
                description: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for ObjectCategories

fn clone(&self) -> ObjectCategories

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectCategories

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

Formats the value using the given formatter.