Struct Groups 

pub struct Groups {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl Groups

pub async fn get<'a>(&'a self) -> Result<Vec<Group>, Error>

GET Groups

Please note, the Groups endpoint requires an OAuth application (i.e. approved 3rd party partners), as the end point is intended for mapping third-party application “Groups” within Rippling organizations.

Lists the current third-party groups for an organization.

async fn example_groups_get() -> anyhow::Result<()> {
    let client = rippling_base_api::Client::new_from_env();
    let result: Vec<rippling_base_api::types::Group> = client.groups().get().await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn post<'a>( &'a self, body: &PostGroupsRequestBody, ) -> Result<Group, Error>

POST Groups

Creates a generic group, that can be associated within the third-party application.

async fn example_groups_post() -> anyhow::Result<()> {
    let client = rippling_base_api::Client::new_from_env();
    let result: rippling_base_api::types::Group = client
        .groups()
        .post(&rippling_base_api::types::PostGroupsRequestBody {
            name: Some("some-string".to_string()),
            spoke_id: Some("some-string".to_string()),
            users: Some(vec!["some-string".to_string()]),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn get_id<'a>( &'a self, group_id: i64, body: &GroupUpdatePayload, ) -> Result<Group, Error>

GET Group

Please note, the Groups endpoint requires an OAuth application (i.e. approved 3rd party partners), as the end point is intended for mapping third-party application “Groups” within Rippling organizations.

Parameters:

• group_id: i64: Unique identifier for the group within Rippling. (required)

async fn example_groups_get_id() -> anyhow::Result<()> {
    let client = rippling_base_api::Client::new_from_env();
    let result: rippling_base_api::types::Group = client
        .groups()
        .get_id(
            4 as i64,
            &rippling_base_api::types::GroupUpdatePayload {
                name: Some("some-string".to_string()),
                spoke_id: Some("some-string".to_string()),
                users: Some(vec![serde_json::Value::String("some-string".to_string())]),
                version: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn put_id<'a>( &'a self, group_id: i64, body: &GroupUpdatePayload, ) -> Result<Group, Error>

PUT Group

Please note, the Groups endpoint requires an OAuth application (i.e. approved 3rd party partners), as the end point is intended for mapping third-party application “Groups” within Rippling organizations.

Using the PUT method, all of the group fields will be updated, even if the corresponding parameter is missing. If the PATCH method is used, and a param is missing, its value won’t be changed.

Parameters:

• group_id: i64: Unique identifier for the group within Rippling. (required)

async fn example_groups_put_id() -> anyhow::Result<()> {
    let client = rippling_base_api::Client::new_from_env();
    let result: rippling_base_api::types::Group = client
        .groups()
        .put_id(
            4 as i64,
            &rippling_base_api::types::GroupUpdatePayload {
                name: Some("some-string".to_string()),
                spoke_id: Some("some-string".to_string()),
                users: Some(vec![serde_json::Value::String("some-string".to_string())]),
                version: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn delete_id<'a>(&'a self, group_id: i64) -> Result<(), Error>

DELETE Group

Please note, the Groups endpoint requires an OAuth application (i.e. approved 3rd party partners), as the end point is intended for mapping third-party application “Groups” within Rippling organizations.

Deletes the specified group.

Parameters:

• group_id: i64: Unique identifier for the group within Rippling. (required)

async fn example_groups_delete_id() -> anyhow::Result<()> {
    let client = rippling_base_api::Client::new_from_env();
    client.groups().delete_id(4 as i64).await?;
    Ok(())
}

pub async fn patch_id<'a>( &'a self, group_id: i64, body: &GroupUpdatePayload, ) -> Result<Group, Error>

PATCH Group

Please note, the Groups endpoint requires an OAuth application (i.e. approved 3rd party partners), as the end point is intended for mapping third-party application “Groups” within Rippling organizations.

Using the PUT method, all of the group fields will be updated, even if the corresponding parameter is missing. If the PATCH method is used, and a param is missing, its value won’t be changed.

Parameters:

• group_id: i64: Unique identifier for the group within Rippling. (required)

async fn example_groups_patch_id() -> anyhow::Result<()> {
    let client = rippling_base_api::Client::new_from_env();
    let result: rippling_base_api::types::Group = client
        .groups()
        .patch_id(
            4 as i64,
            &rippling_base_api::types::GroupUpdatePayload {
                name: Some("some-string".to_string()),
                spoke_id: Some("some-string".to_string()),
                users: Some(vec![serde_json::Value::String("some-string".to_string())]),
                version: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Groups

fn clone(&self) -> Groups

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Groups

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

Formats the value using the given formatter.