Struct Client 

pub struct Client { /* private fields */ }

An API client for Orb.

The API client is designed to be wrapped in an Arc and used from multiple threads simultaneously.

Implementations

impl Client

pub fn list_customers( &self, params: &ListParams, ) -> impl Stream<Item = Result<Customer, Error>> + '_

Lists all customers.

The underlying API call is paginated. The returned stream will fetch additional pages as it is consumed.

pub async fn create_customer( &self, customer: &CreateCustomerRequest<'_>, ) -> Result<Customer, Error>

Creates a new customer.

pub async fn get_customer(&self, id: &str) -> Result<Customer, Error>

Gets a customer by ID.

pub async fn get_customer_by_external_id( &self, external_id: &str, ) -> Result<Customer, Error>

Gets a customer by external ID.

pub async fn update_customer( &self, id: &str, customer: &UpdateCustomerRequest<'_>, ) -> Result<Customer, Error>

Updates a customer by ID.

pub async fn update_customer_by_external_id( &self, external_id: &str, customer: &UpdateCustomerRequest<'_>, ) -> Result<Customer, Error>

Updates a customer by external ID.

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

Deletes a customer by ID.

pub fn get_customer_credit_balance( &self, id: &str, params: &ListParams, ) -> impl Stream<Item = Result<CustomerCreditBlock, Error>> + '_

Fetch all unexpired, non-zero credit blocks for a customer.

The underlying API call is paginated. The returned stream will fetch additional pages as it is consumed.

pub fn get_customer_credit_balance_by_external_id( &self, external_id: &str, params: &ListParams, ) -> impl Stream<Item = Result<CustomerCreditBlock, Error>> + '_

Fetch all unexpired, non-zero credit blocks for a customer by external ID.

The underlying API call is paginated. The returned stream will fetch additional pages as it is consumed.

pub async fn create_ledger_entry( &self, id: &str, entry: &LedgerEntryRequest<'_>, ) -> Result<LedgerEntry, Error>

Create a new ledger entry for the specified customer’s balance.

pub async fn get_customer_costs( &self, id: &str, params: &CustomerCostParams<'_>, ) -> Result<Vec<CustomerCostBucket>, Error>

Fetch a day-by-day snapshot of a customer’s costs.

pub async fn get_customer_costs_by_external_id( &self, external_id: &str, params: &CustomerCostParams<'_>, ) -> Result<Vec<CustomerCostBucket>, Error>

Fetch a day-by-day snapshot of a customer’s costs by their external ID.

impl Client

pub fn search_events( &self, params: &EventSearchParams<'_>, ) -> impl Stream<Item = Result<Event, Error>> + '_

Searches events.

pub async fn ingest_events( &self, mode: IngestionMode, events: &[IngestEventRequest<'_>], ) -> Result<IngestEventResponse, Error>

Ingests events.

pub async fn amend_event( &self, id: &str, event: &AmendEventRequest<'_>, ) -> Result<(), Error>

Amends an event by ID.

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

Deprecates an event by ID.

impl Client

pub fn list_invoices( &self, params: &InvoiceListParams<'_>, ) -> impl Stream<Item = Result<Invoice, Error>> + '_

Lists invoices as configured by params.

The underlying API call is paginated. The returned stream will fetch additional pages as it is consumed.

pub async fn get_invoice(&self, id: &str) -> Result<Invoice, Error>

Gets an invoice by ID.

impl Client

pub fn list_plans( &self, params: &ListParams, ) -> impl Stream<Item = Result<Plan, Error>> + '_

Lists all plans.

The underlying API call is paginated. The returned stream will fetch additional pages as it is consumed.

pub async fn get_plan(&self, id: &str) -> Result<Plan, Error>

Gets a plan by ID.

pub async fn get_plan_by_external_id( &self, external_id: &str, ) -> Result<Plan, Error>

Gets a plan by external ID.

impl Client

pub fn list_subscriptions( &self, params: &SubscriptionListParams<'_>, ) -> impl Stream<Item = Result<Subscription, Error>> + '_

Lists subscriptions as configured by params.

The underlying API call is paginated. The returned stream will fetch additional pages as it is consumed.

pub async fn create_subscription( &self, subscription: &CreateSubscriptionRequest<'_>, ) -> Result<Subscription, Error>

Creates a new subscription.

pub async fn get_subscription(&self, id: &str) -> Result<Subscription, Error>

Gets a subscription by ID.

impl Client

pub fn new(config: ClientConfig) -> Client

Creates a new Client from its required configuration parameters.

pub fn builder() -> ClientBuilder

Creates a builder for a Client that allows for customization of optional parameters.

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.