rusty-razorpay 0.3.2

Razorpay SDK for Rust
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
#[cfg(not(feature = "std"))]
use alloc::{borrow::ToOwned, format, string::String, vec::Vec};
#[cfg(not(feature = "std"))]
use core::fmt::{Display, Formatter, Result as FormatterResult};
#[cfg(feature = "std")]
use std::fmt::{Display, Formatter, Result as FormatterResult};

use chrono::{
    serde::{ts_seconds, ts_seconds_option},
    DateTime, Utc,
};
use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::{
    address::Address,
    api::RequestParams,
    common::{Currency, Object},
    error::{InternalApiResult, RazorpayResult},
    ids::CustomerId,
    line_item::LineItem,
    util::{deserialize_notes, serialize_bool_as_int_option},
    Collection, InvoiceId, OrderId, PaymentId, Razorpay,
};

#[derive(Debug, Deserialize, Clone, Eq, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum InvoiceType {
    Invoice,
}

#[derive(Debug, Deserialize, Clone, Eq, PartialEq)]
pub struct CustomerDetails {
    pub id: String,
    pub name: String,
    pub email: String,
    pub contact: String,
    pub billing_address: Option<Address>,
    pub shipping_address: Option<Address>,
}

#[derive(Debug, Deserialize, Clone, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum InvoiceStatus {
    Draft,
    Issued,
    PartiallyPaid,
    Paid,
    Cancelled,
    Expired,
    Deleted,
}

#[derive(Debug, Deserialize, Clone, Eq, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum InvoiceMessageStatus {
    Pending,
    Sent,
}

#[derive(Debug, Deserialize, Clone, Eq, PartialEq)]
#[serde(tag = "entity", rename = "invoice")]
pub struct Invoice {
    pub id: InvoiceId,
    #[serde(rename = "type")]
    pub type_: InvoiceType,
    pub invoice_number: String,
    pub customer_id: Option<CustomerId>,
    pub customer_details: Option<CustomerDetails>,
    pub order_id: OrderId,
    pub line_items: Vec<LineItem>,
    pub payment_id: PaymentId,
    pub status: InvoiceStatus,
    #[serde(with = "ts_seconds")]
    pub expire_by: DateTime<Utc>,
    #[serde(with = "ts_seconds")]
    pub issued_at: DateTime<Utc>,
    #[serde(with = "ts_seconds_option")]
    pub paid_at: Option<DateTime<Utc>>,
    #[serde(with = "ts_seconds_option")]
    pub cancelled_at: Option<DateTime<Utc>>,
    #[serde(with = "ts_seconds_option")]
    pub expired_at: Option<DateTime<Utc>>,
    pub sms_status: InvoiceMessageStatus,
    pub email_status: InvoiceMessageStatus,
    pub partial_payment: bool,
    pub amount: u64,
    pub amount_paid: u64,
    pub amount_due: u64,
    pub currency: Currency,
    pub description: Option<String>,
    #[serde(deserialize_with = "deserialize_notes")]
    pub notes: Object,
    pub short_url: String,
    #[serde(with = "ts_seconds")]
    pub date: DateTime<Utc>,
    pub terms: Option<String>,
    pub comment: Option<String>,
}

#[derive(Debug, Default, Serialize, Clone, Eq, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum CreateOrUpdateInvoiceType {
    #[default]
    Invoice,
}

#[derive(Debug, Default, Serialize, Clone, Eq, PartialEq)]
pub struct CreateInvoiceCustomerAddress<'a> {
    pub line1: &'a str,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub line2: Option<&'a str>,
    pub city: &'a str,
    pub zipcode: &'a str,
    pub state: &'a str,
    pub country: &'a str,
}

#[derive(Debug, Default, Serialize, Clone, Eq, PartialEq)]
pub struct CreateOrUpdateInvoiceCustomer<'a> {
    pub name: &'a str,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub email: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contact: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub billing_address: Option<CreateInvoiceCustomerAddress<'a>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub shipping_address: Option<CreateInvoiceCustomerAddress<'a>>,
}

#[derive(Debug, Default, Serialize, Clone, Eq, PartialEq)]
pub struct CreateOrUpdateInvoiceLineItem<'a> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub item_id: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<Currency>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantity: Option<u64>,
}

#[derive(Debug, Default, Serialize, Clone, Eq, PartialEq)]
pub struct CreateInvoice<'a> {
    #[serde(rename = "type")]
    pub type_: CreateOrUpdateInvoiceType,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<&'a str>,
    #[serde(
        serialize_with = "serialize_bool_as_int_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub draft: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub customer_id: Option<&'a CustomerId>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub customer: Option<CreateOrUpdateInvoiceCustomer<'a>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub line_items: Option<Vec<CreateOrUpdateInvoiceLineItem<'a>>>,
    #[serde(
        skip_serializing_if = "Option::is_none",
        with = "ts_seconds_option"
    )]
    pub expire_by: Option<DateTime<Utc>>,
    #[serde(
        skip_serializing_if = "Option::is_none",
        serialize_with = "serialize_bool_as_int_option"
    )]
    pub sms_notify: Option<bool>,
    #[serde(
        skip_serializing_if = "Option::is_none",
        serialize_with = "serialize_bool_as_int_option"
    )]
    pub email_notify: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub partial_payment: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<Currency>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub notes: Option<Object>,
}

#[derive(Debug, Default, Serialize, Clone, Eq, PartialEq)]
pub struct UpdateInvoice<'a> {
    #[serde(rename = "type")]
    pub type_: CreateOrUpdateInvoiceType,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<&'a str>,
    #[serde(
        serialize_with = "serialize_bool_as_int_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub draft: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub customer_id: Option<&'a CustomerId>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub customer: Option<CreateOrUpdateInvoiceCustomer<'a>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub line_items: Option<Vec<CreateOrUpdateInvoiceLineItem<'a>>>,
    #[serde(
        skip_serializing_if = "Option::is_none",
        with = "ts_seconds_option"
    )]
    pub expire_by: Option<DateTime<Utc>>,
    #[serde(
        skip_serializing_if = "Option::is_none",
        serialize_with = "serialize_bool_as_int_option"
    )]
    pub sms_notify: Option<bool>,
    #[serde(
        skip_serializing_if = "Option::is_none",
        serialize_with = "serialize_bool_as_int_option"
    )]
    pub email_notify: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub partial_payment: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<Currency>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub notes: Option<Object>,
}

#[derive(Debug, Default, Serialize, Clone, Eq, PartialEq)]
pub struct ListInvoices<'a> {
    pub payment_id: Option<&'a PaymentId>,
    pub receipt: Option<&'a str>,
    pub customer_id: Option<&'a CustomerId>,
}

#[derive(Debug, Clone, Eq, PartialEq)]
pub enum InvoiceNotifyMedium {
    Sms,
    Email,
}

impl Display for InvoiceNotifyMedium {
    fn fmt(&self, f: &mut Formatter<'_>) -> FormatterResult {
        write!(
            f,
            "{}",
            match self {
                InvoiceNotifyMedium::Sms => "sms",
                InvoiceNotifyMedium::Email => "email",
            }
        )
    }
}

#[derive(Debug, Deserialize)]
struct InvoiceNotifyResult {
    success: bool,
}

impl Invoice {
    pub async fn create(
        razorpay: &Razorpay,
        params: CreateInvoice<'_>,
    ) -> RazorpayResult<Invoice> {
        let res = razorpay
            .api
            .post(RequestParams {
                url: "/invoices".to_owned(),
                version: None,
                data: Some(params),
            })
            .await?;

        match res {
            InternalApiResult::Ok(invoice) => Ok(invoice),
            InternalApiResult::Err { error } => Err(error.into()),
        }
    }

    pub async fn update(
        razorpay: &Razorpay,
        invoice_id: &InvoiceId,
        params: UpdateInvoice<'_>,
    ) -> RazorpayResult<Invoice> {
        let res = razorpay
            .api
            .patch(RequestParams {
                url: format!("/invoices/{}", invoice_id),
                version: None,
                data: Some(params),
            })
            .await?;

        match res {
            InternalApiResult::Ok(invoice) => Ok(invoice),
            InternalApiResult::Err { error } => Err(error.into()),
        }
    }

    pub async fn issue(
        razorpay: &Razorpay,
        invoice_id: &InvoiceId,
    ) -> RazorpayResult<Invoice> {
        let res = razorpay
            .api
            .post(RequestParams {
                url: format!("/invoices/{}/issue", invoice_id),
                version: None,
                data: None::<()>,
            })
            .await?;

        match res {
            InternalApiResult::Ok(invoice) => Ok(invoice),
            InternalApiResult::Err { error } => Err(error.into()),
        }
    }

    pub async fn delete(
        razorpay: &Razorpay,
        invoice_id: &InvoiceId,
    ) -> RazorpayResult<()> {
        let res: InternalApiResult<Value> = razorpay
            .api
            .delete(RequestParams {
                url: format!("/invoices/{}", invoice_id),
                version: None,
                data: None::<()>,
            })
            .await?;

        match res {
            InternalApiResult::Ok(_) => Ok(()),
            InternalApiResult::Err { error } => Err(error.into()),
        }
    }

    pub async fn cancel(
        razorpay: &Razorpay,
        invoice_id: &InvoiceId,
    ) -> RazorpayResult<Invoice> {
        let res = razorpay
            .api
            .post(RequestParams {
                url: format!("/invoices/{}/cancel", invoice_id),
                version: None,
                data: None::<()>,
            })
            .await?;

        match res {
            InternalApiResult::Ok(invoice) => Ok(invoice),
            InternalApiResult::Err { error } => Err(error.into()),
        }
    }

    pub async fn fetch(
        razorpay: &Razorpay,
        invoice_id: &InvoiceId,
    ) -> RazorpayResult<Invoice> {
        let res = razorpay
            .api
            .get(RequestParams {
                url: format!("/invoices/{}", invoice_id),
                version: None,
                data: None::<()>,
            })
            .await?;

        match res {
            InternalApiResult::Ok(invoice) => Ok(invoice),
            InternalApiResult::Err { error } => Err(error.into()),
        }
    }

    pub async fn list<T>(
        razorpay: &Razorpay,
        params: T,
    ) -> RazorpayResult<Collection<Invoice>>
    where
        T: for<'a> Into<Option<ListInvoices<'a>>>,
    {
        let res = razorpay
            .api
            .get(RequestParams {
                url: "/invoices".to_owned(),
                version: None,
                data: params.into(),
            })
            .await?;

        match res {
            InternalApiResult::Ok(invoice) => Ok(invoice),
            InternalApiResult::Err { error } => Err(error.into()),
        }
    }

    pub async fn notify(
        razorpay: &Razorpay,
        invoice_id: &InvoiceId,
        medium: InvoiceNotifyMedium,
    ) -> RazorpayResult<bool> {
        let res: InternalApiResult<InvoiceNotifyResult> = razorpay
            .api
            .post(RequestParams {
                url: format!("/invoices/{}/notify_by/{}", invoice_id, medium),
                version: None,
                data: None::<()>,
            })
            .await?;

        match res {
            InternalApiResult::Ok(res) => Ok(res.success),
            InternalApiResult::Err { error } => Err(error.into()),
        }
    }

    // TODO: Add more invoice APIs
    //
    // there are many other APIs which needs to be implemented, all of
    // them are list in the [docs]
    //
    // [docs]: https://razorpay.com/docs/api/payments/invoices
}