Struct BatchesResource

pub struct BatchesResource { /* private fields */ }

Resource for managing message batches

Implementations

impl BatchesResource

pub fn new(http_client: Arc<HttpClient>) -> Self

Create a new batches resource

pub async fn create(&self, params: BatchCreateParams) -> Result<MessageBatch>

Create a new message batch

Arguments

• params - Parameters for creating the batch

Returns

A new MessageBatch object with status information

Errors

Returns an error if the request fails or if the batch parameters are invalid

pub async fn get(&self, batch_id: &str) -> Result<MessageBatch>

Retrieve a specific message batch by ID

Arguments

• batch_id - The ID of the batch to retrieve

Returns

The MessageBatch object with current status

Errors

Returns an error if the batch is not found or if the request fails

pub async fn list(&self, params: Option<BatchListParams>) -> Result<BatchList>

List message batches

Arguments

• params - Optional parameters for pagination and filtering

Returns

A BatchList containing batches and pagination information

Errors

Returns an error if the request fails

pub async fn cancel(&self, batch_id: &str) -> Result<MessageBatch>

Cancel a message batch

Arguments

• batch_id - The ID of the batch to cancel

Returns

The updated MessageBatch object with cancellation status

Errors

Returns an error if the batch cannot be cancelled or if the request fails

pub async fn get_results(&self, batch_id: &str) -> Result<Vec<BatchResult>>

Get the results of a completed batch

Arguments

• batch_id - The ID of the completed batch

Returns

A vector of BatchResult objects containing the results

Errors

Returns an error if the batch is not completed or if the request fails

pub async fn wait_for_completion( &self, batch_id: &str, poll_interval: Option<Duration>, timeout: Option<Duration>, ) -> Result<MessageBatch>

Wait for a batch to complete

Arguments

• batch_id - The ID of the batch to wait for
• poll_interval - How often to check the status (default: 5 seconds)
• timeout - Maximum time to wait (default: 1 hour)

Returns

The completed MessageBatch object

Errors

Returns an error if the batch fails, expires, or if the timeout is reached

pub async fn get_status( &self, batch_id: &str, ) -> Result<(BatchStatus, f64, u32)>

Get the status and progress of a batch

Arguments

• batch_id - The ID of the batch to check

Returns

A tuple containing (status, completion_percentage, pending_requests)

Errors

Returns an error if the request fails

impl BatchesResource

High-level batch processing utilities

pub async fn create_and_wait( &self, params: BatchCreateParams, poll_interval: Option<Duration>, ) -> Result<(MessageBatch, Vec<BatchResult>)>

Create and monitor a batch until completion

Arguments

• params - Parameters for creating the batch
• poll_interval - How often to check status (default: 5 seconds)

Returns

A tuple containing the completed batch and its results

Errors

Returns an error if batch creation, processing, or result retrieval fails

pub async fn monitor_progress<F>( &self, batch_id: &str, progress_callback: F, poll_interval: Option<Duration>, ) -> Result<MessageBatch>

where F: FnMut(f64, u32, u32),

Monitor batch progress with callbacks

Arguments

• batch_id - The ID of the batch to monitor
• progress_callback - Called with progress updates
• poll_interval - How often to check status

Returns

The completed batch

Errors

Returns an error if monitoring fails

Trait Implementations

impl Clone for BatchesResource

fn clone(&self) -> BatchesResource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchesResource

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

Formats the value using the given formatter.