Struct UnifiedApiResponse

pub struct UnifiedApiResponse {
    pub status: ResponseStatus,
    pub response_type: ResponseType,
    pub data_type: Option<String>,
    pub source: Option<String>,
    pub data: Option<Value>,
    pub error: Option<ApiError>,
    pub pagination: Option<PaginationMeta>,
    pub metadata: Option<ResponseMetadata>,
    pub batch_results: Option<BatchResults>,
}

Unified API response that can handle all response types

Fields

status: ResponseStatus

Response status: “success” or “error”

response_type: ResponseType

Type of response: “single”, “list”, “paginated”, “batch”, “empty”

data_type: Option<String>

The type of data being returned (e.g., “Contact”, “Account”, “Device”)

source: Option<String>

The source endpoint that generated this response

data: Option<Value>

Optional data field - can contain any JSON value

error: Option<ApiError>

Optional error information

pagination: Option<PaginationMeta>

Optional pagination information

metadata: Option<ResponseMetadata>

Optional metadata

batch_results: Option<BatchResults>

For batch operations

Implementations

impl UnifiedApiResponse

pub fn single<T: Serialize>(item: T, data_type: &str, source: &str) -> Self

Create a successful single item response

pub fn list<T: Serialize>(items: Vec<T>, data_type: &str, source: &str) -> Self

Create a successful list response

pub fn paginated<T: Serialize>( items: Vec<T>, pagination: PaginationMeta, data_type: &str, source: &str, ) -> Self

Create a paginated response

pub fn error(error: ApiError, source: &str) -> Self

Create an error response

pub fn empty(source: &str) -> Self

Create an empty success response (e.g., for DELETE)

pub fn batch<T: Serialize, E: Serialize>( succeeded: Vec<T>, failed: Vec<(usize, Option<String>, E, ApiError)>, data_type: &str, source: &str, ) -> Self

Create a batch response

pub fn with_metadata(self, metadata: ResponseMetadata) -> Self

Add metadata to the response

Trait Implementations

impl Clone for UnifiedApiResponse

fn clone(&self) -> UnifiedApiResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnifiedApiResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UnifiedApiResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UnifiedApiResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.