payabli_api 1.0.18

Rust SDK for payabli_api generated by Fern
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, RequestOptions};
use reqwest::Method;

pub struct ChargeBacksClient {
    pub http_client: HttpClient,
}

impl ChargeBacksClient {
    pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
        Ok(Self {
            http_client: HttpClient::new(config.clone())?,
        })
    }

    /// Add a response to a chargeback or ACH return.
    ///
    /// # Arguments
    ///
    /// * `id` - ID of the chargeback or return record.
    /// * `options` - Additional request options such as headers, timeout, etc.
    ///
    /// # Returns
    ///
    /// JSON response from the API
    pub async fn add_response(
        &self,
        id: i64,
        request: &ResponseChargeBack,
        options: Option<RequestOptions>,
    ) -> Result<AddResponseResponse, ApiError> {
        self.http_client
            .execute_request(
                Method::POST,
                &format!("ChargeBacks/response/{}", id),
                Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
                None,
                options,
            )
            .await
    }

    /// Retrieves a chargeback record and its details.
    ///
    /// # Arguments
    ///
    /// * `id` - ID of the chargeback or return record. This is returned as `chargebackId` in the [RecievedChargeback](/developers/developer-guides/webhook-payloads#receivedChargeback) and [ReceivedAchReturn](/developers/developer-guides/webhook-payloads#receivedachreturn) webhook notifications.
    /// * `options` - Additional request options such as headers, timeout, etc.
    ///
    /// # Returns
    ///
    /// JSON response from the API
    pub async fn get_chargeback(
        &self,
        id: i64,
        options: Option<RequestOptions>,
    ) -> Result<ChargebackQueryRecords, ApiError> {
        self.http_client
            .execute_request(
                Method::GET,
                &format!("ChargeBacks/read/{}", id),
                None,
                None,
                options,
            )
            .await
    }

    /// Retrieves a chargeback attachment file by its file name.
    ///
    /// # Arguments
    ///
    /// * `id` - The ID of chargeback or return record.
    /// * `file_name` - The chargeback attachment's file name.
    /// * `options` - Additional request options such as headers, timeout, etc.
    ///
    /// # Returns
    ///
    /// Text response
    pub async fn get_chargeback_attachment(
        &self,
        id: i64,
        file_name: &str,
        options: Option<RequestOptions>,
    ) -> Result<String, ApiError> {
        self.http_client
            .execute_request(
                Method::GET,
                &format!("ChargeBacks/getChargebackAttachments/{}/{}", id, file_name),
                None,
                None,
                options,
            )
            .await
    }
}