Struct Companies 

pub struct Companies {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl Companies

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

List companies

A List of companies

• Requires: API Tier 1
• Expandable fields: - Sortable fields: id, created_at, updated_at

Parameters:

• cursor: Option<String>
• expand: Option<String>
• order_by: Option<String>

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

    Ok(())
}

Trait Implementations

impl Clone for Companies

fn clone(&self) -> Companies

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Companies

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

Formats the value using the given formatter.