Struct CustomObjectRecords

pub struct CustomObjectRecords {
    pub client: Client,
}

Fields

client: Client

Implementations

impl CustomObjectRecords

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

List custom object records

A List of custom object records

• Requires: API Tier 1

Parameters:

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

use futures_util::TryStreamExt;
async fn example_custom_object_records_list_custom_objects_custom_object_api_name_records_stream(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let mut custom_object_records = client.custom_object_records();
    let mut stream = custom_object_records
        .list_custom_objects_custom_object_api_name_records_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_records<'a>( &'a self, custom_object_api_name: &'a str, body: &CreateCustomObjectsCustomObjectApiNameRecordsRequestBody, ) -> Result<CreateCustomObjectsCustomObjectApiNameRecordsResponse, Error>

Create a new custom object record

Create a new custom object record

Parameters:

• custom_object_api_name: &'astr (required)

async fn example_custom_object_records_create_custom_objects_custom_object_api_name_records(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::CreateCustomObjectsCustomObjectApiNameRecordsResponse = client
        .custom_object_records()
        .create_custom_objects_custom_object_api_name_records(
            "some-string",
            &rippling_api::types::CreateCustomObjectsCustomObjectApiNameRecordsRequestBody {
                name: Some("some-string".to_string()),
                field_api_name: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn list_by_query_custom_objects_custom_object_api_name_records<'a>( &'a self, cursor: Option<String>, custom_object_api_name: &'a str, body: &ListByQueryCustomObjectsCustomObjectApiNameRecordsRequestBody, ) -> Result<ListByQueryCustomObjectsCustomObjectApiNameRecordsResponse, Error>

List custom object records by query

A List of custom object records filtered by querying

Parameters:

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

async fn example_custom_object_records_list_by_query_custom_objects_custom_object_api_name_records(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::ListByQueryCustomObjectsCustomObjectApiNameRecordsResponse = client
        .custom_object_records()
        .list_by_query_custom_objects_custom_object_api_name_records(
            Some("some-string".to_string()),
            "some-string",
            &rippling_api::types::ListByQueryCustomObjectsCustomObjectApiNameRecordsRequestBody {
                query: Some("some-string".to_string()),
                limit: Some(4 as i64),
                cursor: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

Retrieve a specific custom object record

Retrieve a specific custom object record

Parameters:

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

async fn example_custom_object_records_get_custom_objects_custom_object_api_name_records(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::GetCustomObjectsCustomObjectApiNameRecordsResponse = client
        .custom_object_records()
        .get_custom_objects_custom_object_api_name_records("some-string", "some-string")
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

Delete a custom object record

Parameters:

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

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

pub async fn update_custom_objects_custom_object_api_name_records<'a>( &'a self, codr_id: &'a str, custom_object_api_name: &'a str, body: &UpdateCustomObjectsCustomObjectApiNameRecordsRequestBody, ) -> Result<UpdateCustomObjectsCustomObjectApiNameRecordsResponse, Error>

Update a custom object record

Updated a specific custom object record

Parameters:

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

async fn example_custom_object_records_update_custom_objects_custom_object_api_name_records(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::UpdateCustomObjectsCustomObjectApiNameRecordsResponse = client
        .custom_object_records()
        .update_custom_objects_custom_object_api_name_records(
            "some-string",
            "some-string",
            &rippling_api::types::UpdateCustomObjectsCustomObjectApiNameRecordsRequestBody {
                name: Some("some-string".to_string()),
                field_api_name: Some("some-string".to_string()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

Retrieve a specific custom object record by its external_id

Retrieve a specific custom object record by its external_id

Parameters:

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

async fn example_custom_object_records_get_custom_objects_custom_object_api_name_records_by_external_id(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: rippling_api::types::GetCustomObjectsCustomObjectApiNameRecordsByExternalIdResponse =
        client
            .custom_object_records()
            .get_custom_objects_custom_object_api_name_records_by_external_id(
                "some-string",
                "some-string",
            )
            .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn bulk_create_custom_objects_custom_object_api_name_records<'a>( &'a self, custom_object_api_name: &'a str, body: &BulkCreateCustomObjectsCustomObjectApiNameRecordsRequestBody, ) -> Result<Vec<BulkCreateCustomObjectsCustomObjectApiNameRecordsResponse>, Error>

Bulk Create custom object records

bulk create new custom object records

Parameters:

• custom_object_api_name: &'astr (required)

async fn example_custom_object_records_bulk_create_custom_objects_custom_object_api_name_records(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: Vec<rippling_api::types::BulkCreateCustomObjectsCustomObjectApiNameRecordsResponse> =
        client
            .custom_object_records()
            .bulk_create_custom_objects_custom_object_api_name_records(
                "some-string",
                &rippling_api::types::BulkCreateCustomObjectsCustomObjectApiNameRecordsRequestBody {
                    rows_to_write: Some(vec![rippling_api::types::RowsToWrite {
                        name: Some("some-string".to_string()),
                        field_api_name: Some("some-string".to_string()),
                    }]),
                    all_or_nothing: Some(true),
                },
            )
            .await?;
    println!("{:?}", result);
    Ok(())
}

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

bulk delete custom object records

Bulk Delete custom object records

Parameters:

• custom_object_api_name: &'astr (required)

async fn example_custom_object_records_bulk_delete_custom_objects_custom_object_api_name_records(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    client
        .custom_object_records()
        .bulk_delete_custom_objects_custom_object_api_name_records(
            "some-string",
            &rippling_api::types::BulkDeleteCustomObjectsCustomObjectApiNameRecordsRequestBody {
                rows_to_delete: Some("some-string".to_string()),
                all_or_nothing: Some(true),
            },
        )
        .await?;
    Ok(())
}

pub async fn bulk_update_custom_objects_custom_object_api_name_records<'a>( &'a self, custom_object_api_name: &'a str, body: &BulkUpdateCustomObjectsCustomObjectApiNameRecordsRequestBody, ) -> Result<Vec<BulkUpdateCustomObjectsCustomObjectApiNameRecordsResponse>, Error>

Bulk Update custom object records

Bulk Updated a specific custom object records

Parameters:

• custom_object_api_name: &'astr (required)

async fn example_custom_object_records_bulk_update_custom_objects_custom_object_api_name_records(
) -> anyhow::Result<()> {
    let client = rippling_api::Client::new_from_env();
    let result: Vec<rippling_api::types::BulkUpdateCustomObjectsCustomObjectApiNameRecordsResponse> =
        client
            .custom_object_records()
            .bulk_update_custom_objects_custom_object_api_name_records(
                "some-string",
                &rippling_api::types::BulkUpdateCustomObjectsCustomObjectApiNameRecordsRequestBody {
                    rows_to_update: Some(vec![rippling_api::types::RowsToUpdate {
                        name: Some("some-string".to_string()),
                        field_api_name: Some("some-string".to_string()),
                    }]),
                    all_or_nothing: Some(true),
                },
            )
            .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for CustomObjectRecords

fn clone(&self) -> CustomObjectRecords

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomObjectRecords

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

Formats the value using the given formatter.