bukku-client 0.1.0-test.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (231) hide show
  1. package/LICENSE +674 -0
  2. package/README.md +85 -0
  3. package/dist/accounting/accounts/index.d.ts +52 -0
  4. package/dist/accounting/accounts/index.d.ts.map +1 -0
  5. package/dist/accounting/accounts/index.js +72 -0
  6. package/dist/accounting/accounts/index.js.map +1 -0
  7. package/dist/accounting/accounts/type.d.ts +125 -0
  8. package/dist/accounting/accounts/type.d.ts.map +1 -0
  9. package/dist/accounting/accounts/type.js +4 -0
  10. package/dist/accounting/accounts/type.js.map +1 -0
  11. package/dist/accounting/index.d.ts +10 -0
  12. package/dist/accounting/index.d.ts.map +1 -0
  13. package/dist/accounting/index.js +16 -0
  14. package/dist/accounting/index.js.map +1 -0
  15. package/dist/accounting/journal-entries/index.d.ts +52 -0
  16. package/dist/accounting/journal-entries/index.d.ts.map +1 -0
  17. package/dist/accounting/journal-entries/index.js +72 -0
  18. package/dist/accounting/journal-entries/index.js.map +1 -0
  19. package/dist/accounting/journal-entries/type.d.ts +151 -0
  20. package/dist/accounting/journal-entries/type.d.ts.map +1 -0
  21. package/dist/accounting/journal-entries/type.js +4 -0
  22. package/dist/accounting/journal-entries/type.js.map +1 -0
  23. package/dist/common/type.d.ts +105 -0
  24. package/dist/common/type.d.ts.map +1 -0
  25. package/dist/common/type.js +3 -0
  26. package/dist/common/type.js.map +1 -0
  27. package/dist/contacts/contacts/index.d.ts +57 -0
  28. package/dist/contacts/contacts/index.d.ts.map +1 -0
  29. package/dist/contacts/contacts/index.js +82 -0
  30. package/dist/contacts/contacts/index.js.map +1 -0
  31. package/dist/contacts/contacts/type.d.ts +286 -0
  32. package/dist/contacts/contacts/type.d.ts.map +1 -0
  33. package/dist/contacts/contacts/type.js +4 -0
  34. package/dist/contacts/contacts/type.js.map +1 -0
  35. package/dist/contacts/groups/index.d.ts +42 -0
  36. package/dist/contacts/groups/index.d.ts.map +1 -0
  37. package/dist/contacts/groups/index.js +59 -0
  38. package/dist/contacts/groups/index.js.map +1 -0
  39. package/dist/contacts/groups/type.d.ts +34 -0
  40. package/dist/contacts/groups/type.d.ts.map +1 -0
  41. package/dist/contacts/groups/type.js +4 -0
  42. package/dist/contacts/groups/type.js.map +1 -0
  43. package/dist/contacts/index.d.ts +10 -0
  44. package/dist/contacts/index.d.ts.map +1 -0
  45. package/dist/contacts/index.js +15 -0
  46. package/dist/contacts/index.js.map +1 -0
  47. package/dist/control-panel/index.d.ts +15 -0
  48. package/dist/control-panel/index.d.ts.map +1 -0
  49. package/dist/control-panel/index.js +35 -0
  50. package/dist/control-panel/index.js.map +1 -0
  51. package/dist/control-panel/locations/index.d.ts +51 -0
  52. package/dist/control-panel/locations/index.d.ts.map +1 -0
  53. package/dist/control-panel/locations/index.js +70 -0
  54. package/dist/control-panel/locations/index.js.map +1 -0
  55. package/dist/control-panel/locations/type.d.ts +91 -0
  56. package/dist/control-panel/locations/type.d.ts.map +1 -0
  57. package/dist/control-panel/locations/type.js +4 -0
  58. package/dist/control-panel/locations/type.js.map +1 -0
  59. package/dist/control-panel/tag-groups/index.d.ts +44 -0
  60. package/dist/control-panel/tag-groups/index.d.ts.map +1 -0
  61. package/dist/control-panel/tag-groups/index.js +63 -0
  62. package/dist/control-panel/tag-groups/index.js.map +1 -0
  63. package/dist/control-panel/tag-groups/type.d.ts +64 -0
  64. package/dist/control-panel/tag-groups/type.d.ts.map +1 -0
  65. package/dist/control-panel/tag-groups/type.js +4 -0
  66. package/dist/control-panel/tag-groups/type.js.map +1 -0
  67. package/dist/control-panel/tags/index.d.ts +43 -0
  68. package/dist/control-panel/tags/index.d.ts.map +1 -0
  69. package/dist/control-panel/tags/index.js +60 -0
  70. package/dist/control-panel/tags/index.js.map +1 -0
  71. package/dist/control-panel/tags/type.d.ts +60 -0
  72. package/dist/control-panel/tags/type.d.ts.map +1 -0
  73. package/dist/control-panel/tags/type.js +4 -0
  74. package/dist/control-panel/tags/type.js.map +1 -0
  75. package/dist/files/index.d.ts +29 -0
  76. package/dist/files/index.d.ts.map +1 -0
  77. package/dist/files/index.js +42 -0
  78. package/dist/files/index.js.map +1 -0
  79. package/dist/files/type.d.ts +50 -0
  80. package/dist/files/type.d.ts.map +1 -0
  81. package/dist/files/type.js +4 -0
  82. package/dist/files/type.js.map +1 -0
  83. package/dist/index.d.ts +73 -0
  84. package/dist/index.d.ts.map +1 -0
  85. package/dist/index.js +130 -0
  86. package/dist/index.js.map +1 -0
  87. package/dist/lists/index.d.ts +24 -0
  88. package/dist/lists/index.d.ts.map +1 -0
  89. package/dist/lists/index.js +33 -0
  90. package/dist/lists/index.js.map +1 -0
  91. package/dist/lists/type.d.ts +781 -0
  92. package/dist/lists/type.d.ts.map +1 -0
  93. package/dist/lists/type.js +3 -0
  94. package/dist/lists/type.js.map +1 -0
  95. package/dist/products/groups/index.d.ts +42 -0
  96. package/dist/products/groups/index.d.ts.map +1 -0
  97. package/dist/products/groups/index.js +59 -0
  98. package/dist/products/groups/index.js.map +1 -0
  99. package/dist/products/groups/type.d.ts +53 -0
  100. package/dist/products/groups/type.d.ts.map +1 -0
  101. package/dist/products/groups/type.js +5 -0
  102. package/dist/products/groups/type.js.map +1 -0
  103. package/dist/products/index.d.ts +10 -0
  104. package/dist/products/index.d.ts.map +1 -0
  105. package/dist/products/index.js +15 -0
  106. package/dist/products/index.js.map +1 -0
  107. package/dist/products/products/index.d.ts +51 -0
  108. package/dist/products/products/index.d.ts.map +1 -0
  109. package/dist/products/products/index.js +70 -0
  110. package/dist/products/products/index.js.map +1 -0
  111. package/dist/products/products/type.d.ts +270 -0
  112. package/dist/products/products/type.d.ts.map +1 -0
  113. package/dist/products/products/type.js +4 -0
  114. package/dist/products/products/type.js.map +1 -0
  115. package/dist/purchases/bills/index.d.ts +51 -0
  116. package/dist/purchases/bills/index.d.ts.map +1 -0
  117. package/dist/purchases/bills/index.js +75 -0
  118. package/dist/purchases/bills/index.js.map +1 -0
  119. package/dist/purchases/bills/type.d.ts +254 -0
  120. package/dist/purchases/bills/type.d.ts.map +1 -0
  121. package/dist/purchases/bills/type.js +4 -0
  122. package/dist/purchases/bills/type.js.map +1 -0
  123. package/dist/purchases/credit-notes/index.d.ts +51 -0
  124. package/dist/purchases/credit-notes/index.d.ts.map +1 -0
  125. package/dist/purchases/credit-notes/index.js +71 -0
  126. package/dist/purchases/credit-notes/index.js.map +1 -0
  127. package/dist/purchases/credit-notes/type.d.ts +204 -0
  128. package/dist/purchases/credit-notes/type.d.ts.map +1 -0
  129. package/dist/purchases/credit-notes/type.js +4 -0
  130. package/dist/purchases/credit-notes/type.js.map +1 -0
  131. package/dist/purchases/goods-received-notes/index.d.ts +51 -0
  132. package/dist/purchases/goods-received-notes/index.d.ts.map +1 -0
  133. package/dist/purchases/goods-received-notes/index.js +71 -0
  134. package/dist/purchases/goods-received-notes/index.js.map +1 -0
  135. package/dist/purchases/goods-received-notes/type.d.ts +184 -0
  136. package/dist/purchases/goods-received-notes/type.d.ts.map +1 -0
  137. package/dist/purchases/goods-received-notes/type.js +4 -0
  138. package/dist/purchases/goods-received-notes/type.js.map +1 -0
  139. package/dist/purchases/index.d.ts +18 -0
  140. package/dist/purchases/index.d.ts.map +1 -0
  141. package/dist/purchases/index.js +23 -0
  142. package/dist/purchases/index.js.map +1 -0
  143. package/dist/purchases/payments/index.d.ts +51 -0
  144. package/dist/purchases/payments/index.d.ts.map +1 -0
  145. package/dist/purchases/payments/index.js +71 -0
  146. package/dist/purchases/payments/index.js.map +1 -0
  147. package/dist/purchases/payments/type.d.ts +183 -0
  148. package/dist/purchases/payments/type.d.ts.map +1 -0
  149. package/dist/purchases/payments/type.js +4 -0
  150. package/dist/purchases/payments/type.js.map +1 -0
  151. package/dist/purchases/purchase-orders/index.d.ts +51 -0
  152. package/dist/purchases/purchase-orders/index.d.ts.map +1 -0
  153. package/dist/purchases/purchase-orders/index.js +71 -0
  154. package/dist/purchases/purchase-orders/index.js.map +1 -0
  155. package/dist/purchases/purchase-orders/type.d.ts +182 -0
  156. package/dist/purchases/purchase-orders/type.d.ts.map +1 -0
  157. package/dist/purchases/purchase-orders/type.js +4 -0
  158. package/dist/purchases/purchase-orders/type.js.map +1 -0
  159. package/dist/purchases/refunds/index.d.ts +51 -0
  160. package/dist/purchases/refunds/index.d.ts.map +1 -0
  161. package/dist/purchases/refunds/index.js +71 -0
  162. package/dist/purchases/refunds/index.js.map +1 -0
  163. package/dist/purchases/refunds/type.d.ts +181 -0
  164. package/dist/purchases/refunds/type.d.ts.map +1 -0
  165. package/dist/purchases/refunds/type.js +4 -0
  166. package/dist/purchases/refunds/type.js.map +1 -0
  167. package/dist/sales/credit-notes/index.d.ts +52 -0
  168. package/dist/sales/credit-notes/index.d.ts.map +1 -0
  169. package/dist/sales/credit-notes/index.js +72 -0
  170. package/dist/sales/credit-notes/index.js.map +1 -0
  171. package/dist/sales/credit-notes/type.d.ts +304 -0
  172. package/dist/sales/credit-notes/type.d.ts.map +1 -0
  173. package/dist/sales/credit-notes/type.js +4 -0
  174. package/dist/sales/credit-notes/type.js.map +1 -0
  175. package/dist/sales/delivery-orders/index.d.ts +51 -0
  176. package/dist/sales/delivery-orders/index.d.ts.map +1 -0
  177. package/dist/sales/delivery-orders/index.js +72 -0
  178. package/dist/sales/delivery-orders/index.js.map +1 -0
  179. package/dist/sales/delivery-orders/type.d.ts +212 -0
  180. package/dist/sales/delivery-orders/type.d.ts.map +1 -0
  181. package/dist/sales/delivery-orders/type.js +4 -0
  182. package/dist/sales/delivery-orders/type.js.map +1 -0
  183. package/dist/sales/index.d.ts +20 -0
  184. package/dist/sales/index.d.ts.map +1 -0
  185. package/dist/sales/index.js +24 -0
  186. package/dist/sales/index.js.map +1 -0
  187. package/dist/sales/invoices/index.d.ts +52 -0
  188. package/dist/sales/invoices/index.d.ts.map +1 -0
  189. package/dist/sales/invoices/index.js +73 -0
  190. package/dist/sales/invoices/index.js.map +1 -0
  191. package/dist/sales/invoices/type.d.ts +335 -0
  192. package/dist/sales/invoices/type.d.ts.map +1 -0
  193. package/dist/sales/invoices/type.js +4 -0
  194. package/dist/sales/invoices/type.js.map +1 -0
  195. package/dist/sales/payments/index.d.ts +52 -0
  196. package/dist/sales/payments/index.d.ts.map +1 -0
  197. package/dist/sales/payments/index.js +72 -0
  198. package/dist/sales/payments/index.js.map +1 -0
  199. package/dist/sales/payments/type.d.ts +242 -0
  200. package/dist/sales/payments/type.d.ts.map +1 -0
  201. package/dist/sales/payments/type.js +4 -0
  202. package/dist/sales/payments/type.js.map +1 -0
  203. package/dist/sales/quotations/index.d.ts +51 -0
  204. package/dist/sales/quotations/index.d.ts.map +1 -0
  205. package/dist/sales/quotations/index.js +71 -0
  206. package/dist/sales/quotations/index.js.map +1 -0
  207. package/dist/sales/quotations/type.d.ts +202 -0
  208. package/dist/sales/quotations/type.d.ts.map +1 -0
  209. package/dist/sales/quotations/type.js +3 -0
  210. package/dist/sales/quotations/type.js.map +1 -0
  211. package/dist/sales/refunds/index.d.ts +52 -0
  212. package/dist/sales/refunds/index.d.ts.map +1 -0
  213. package/dist/sales/refunds/index.js +72 -0
  214. package/dist/sales/refunds/index.js.map +1 -0
  215. package/dist/sales/refunds/type.d.ts +225 -0
  216. package/dist/sales/refunds/type.d.ts.map +1 -0
  217. package/dist/sales/refunds/type.js +4 -0
  218. package/dist/sales/refunds/type.js.map +1 -0
  219. package/dist/sales/sales-orders/index.d.ts +52 -0
  220. package/dist/sales/sales-orders/index.d.ts.map +1 -0
  221. package/dist/sales/sales-orders/index.js +72 -0
  222. package/dist/sales/sales-orders/index.js.map +1 -0
  223. package/dist/sales/sales-orders/type.d.ts +202 -0
  224. package/dist/sales/sales-orders/type.d.ts.map +1 -0
  225. package/dist/sales/sales-orders/type.js +4 -0
  226. package/dist/sales/sales-orders/type.js.map +1 -0
  227. package/dist/types.d.ts +17 -0
  228. package/dist/types.d.ts.map +1 -0
  229. package/dist/types.js +4 -0
  230. package/dist/types.js.map +1 -0
  231. package/package.json +44 -0
@@ -0,0 +1,335 @@
1
+ import { BukkuEmailDetails, BukkuFileAttachment, BukkuListPagination } from "../../common/type";
2
+ /**
3
+ * Represents a form item for creating or updating a Bukku Invoice.
4
+ */
5
+ export interface BukkuInvoiceFormItemCreateParams {
6
+ id?: number;
7
+ transfer_item_id?: number;
8
+ type?: null | "bundle" | "subtitle" | "subtotal";
9
+ account_id?: number;
10
+ description?: string;
11
+ service_date?: string;
12
+ product_id?: number;
13
+ product_unit_id?: number;
14
+ location_id?: number;
15
+ unit_price?: number;
16
+ quantity?: number;
17
+ discount?: string;
18
+ tax_code_id?: number;
19
+ classification_code?: string;
20
+ children?: BukkuInvoiceFormItemCreateParams[];
21
+ }
22
+ /**
23
+ * Represents a term item for creating a Bukku Invoice.
24
+ * Required when payment_mode is "credit".
25
+ */
26
+ export interface BukkuInvoiceTermItemCreateParams {
27
+ id?: number;
28
+ term_id?: number;
29
+ date?: string;
30
+ payment_due?: string;
31
+ description?: string;
32
+ }
33
+ /**
34
+ * Represents a deposit item for creating a Bukku Invoice.
35
+ * Required when payment_mode is "cash".
36
+ */
37
+ export interface BukkuInvoiceDepositItemCreateParams {
38
+ id?: number;
39
+ payment_method_id?: number;
40
+ account_id: number;
41
+ amount: number;
42
+ number?: string;
43
+ fee_text?: string;
44
+ fee_account_id?: number;
45
+ }
46
+ /**
47
+ * Parameters for creating a Bukku Invoice.
48
+ * Based on POST /sales/invoices
49
+ */
50
+ export interface BukkuInvoiceCreateParams {
51
+ payment_mode: "cash" | "credit";
52
+ contact_id: number;
53
+ number?: string;
54
+ number2?: string;
55
+ date: string;
56
+ currency_code: string;
57
+ exchange_rate: number;
58
+ billing_party?: string;
59
+ show_shipping?: boolean;
60
+ shipping_party?: string;
61
+ shipping_info?: string;
62
+ tag_ids?: number[];
63
+ title?: string;
64
+ description?: string;
65
+ remarks?: string;
66
+ tax_mode: "inclusive" | "exclusive";
67
+ form_items: Array<BukkuInvoiceFormItemCreateParams>;
68
+ term_items?: Array<BukkuInvoiceTermItemCreateParams>;
69
+ deposit_items?: Array<BukkuInvoiceDepositItemCreateParams>;
70
+ status: "draft" | "pending_approval" | "ready";
71
+ email?: BukkuEmailDetails;
72
+ files?: Array<BukkuFileAttachment>;
73
+ customs_form_no?: string | null;
74
+ customs_k2_form_no?: string | null;
75
+ incoterms?: string | null;
76
+ myinvois_action?: "NORMAL" | "VALIDATE" | "EXTERNAL";
77
+ }
78
+ /**
79
+ * Represents a form item within a Bukku Invoice response.
80
+ */
81
+ export interface BukkuInvoiceFormItem {
82
+ id: number;
83
+ type: string | null;
84
+ line: number;
85
+ account_id: number;
86
+ account_name: string;
87
+ description: string;
88
+ service_date: string;
89
+ product_id: number;
90
+ product_name: string;
91
+ product_sku: string;
92
+ product_bin_location: string;
93
+ product_unit_id: number;
94
+ product_unit_label: string;
95
+ location_id: number;
96
+ location_code: string;
97
+ quantity: number;
98
+ unit_price: number;
99
+ amount: number;
100
+ discount: string;
101
+ discount_amount: number;
102
+ tax_code_id: number;
103
+ tax_code: string;
104
+ tax_amount: number;
105
+ net_amount: number;
106
+ classification_code: string;
107
+ classification_name: string;
108
+ children?: BukkuInvoiceFormItem[];
109
+ }
110
+ /**
111
+ * Represents a term item within a Bukku Invoice response.
112
+ */
113
+ export interface BukkuInvoiceTermItem {
114
+ id: number;
115
+ term_id: number;
116
+ term_name: string;
117
+ date: string;
118
+ payment_due: string;
119
+ description: string;
120
+ amount: number;
121
+ balance: number;
122
+ }
123
+ /**
124
+ * Represents a deposit item within a Bukku Invoice response.
125
+ */
126
+ export interface BukkuInvoiceDepositItem {
127
+ id: number;
128
+ line: number;
129
+ payment_method_id: number;
130
+ account_id: number;
131
+ amount: number;
132
+ number: string;
133
+ fee_text: number | string;
134
+ fee_account_id: number;
135
+ }
136
+ /**
137
+ * Represents a linked item within a Bukku Invoice response.
138
+ */
139
+ export interface BukkuInvoiceLinkedItem {
140
+ id: number;
141
+ origin_transaction_id: number;
142
+ type: string;
143
+ number: string;
144
+ date: string;
145
+ amount: number;
146
+ balance: number;
147
+ apply_amount: number;
148
+ }
149
+ /**
150
+ * Represents the detailed file information within a Bukku Invoice's file entry.
151
+ * This is similar to BukkuDeliveryOrderFileDetail.
152
+ */
153
+ export interface BukkuInvoiceFileDetail {
154
+ id: number;
155
+ url: string;
156
+ filename: string;
157
+ mime_type: string;
158
+ size: number;
159
+ created_at: string;
160
+ }
161
+ /**
162
+ * Represents a file entry attached to a Bukku Invoice.
163
+ * This is similar to BukkuDeliveryOrderFileEntry.
164
+ */
165
+ export interface BukkuInvoiceFileEntry {
166
+ id: number;
167
+ file_id: number;
168
+ file: BukkuInvoiceFileDetail[];
169
+ is_shared: boolean;
170
+ created_at: string;
171
+ }
172
+ /**
173
+ * Represents a Bukku Invoice object as returned by the API.
174
+ */
175
+ export interface BukkuInvoice {
176
+ id: number;
177
+ payment_mode: "cash" | "credit";
178
+ contact_id: number;
179
+ contact_name: string;
180
+ number: string;
181
+ number2: string;
182
+ date: string;
183
+ currency_code: string;
184
+ currency_symbol: string;
185
+ exchange_rate: number;
186
+ billing_party: string;
187
+ show_shipping: boolean;
188
+ shipping_info: string;
189
+ shipping_party: string;
190
+ tag_ids: number[];
191
+ tag_names: string[];
192
+ title: string;
193
+ description: string;
194
+ remarks: string;
195
+ tax_mode: "inclusive" | "exclusive";
196
+ form_items: BukkuInvoiceFormItem[];
197
+ term_items: BukkuInvoiceTermItem[];
198
+ deposit_items: BukkuInvoiceDepositItem[];
199
+ linked_items: BukkuInvoiceLinkedItem[];
200
+ amount: number;
201
+ balance: number;
202
+ rounding_on: boolean;
203
+ rounding_amount: number;
204
+ status: string;
205
+ type: string;
206
+ short_link: string;
207
+ files: BukkuInvoiceFileEntry[];
208
+ customs_form_no: string | null;
209
+ customs_k2_form_no: string | null;
210
+ incoterms: string | null;
211
+ myinvois_action: "NORMAL" | "VALIDATE" | "EXTERNAL" | null;
212
+ myinvois_document_uuid: string | null;
213
+ myinvois_document_long_id: string | null;
214
+ myinvois_document_status: string | null;
215
+ issued_at: string | null;
216
+ validated_at: string | null;
217
+ rejected_at: string | null;
218
+ reject_message: string | null;
219
+ cancelled_at: string | null;
220
+ cancel_message: string | null;
221
+ }
222
+ /**
223
+ * Represents the API response structure when an invoice is created or retrieved.
224
+ */
225
+ export interface BukkuInvoiceResponse {
226
+ transaction: BukkuInvoice;
227
+ }
228
+ /**
229
+ * Parameters for listing Bukku Invoices (GET /sales/invoices).
230
+ */
231
+ export interface BukkuInvoiceListParams {
232
+ payment_status?: "PAID" | "OUTSTANDING" | "OVERDUE";
233
+ date_from?: string;
234
+ date_to?: string;
235
+ search?: string;
236
+ custom_search?: string;
237
+ contact_id?: number;
238
+ payment_mode?: "credit" | "cash";
239
+ status?: "all" | "draft" | "pending_approval" | "ready" | "void";
240
+ email_status?: "UNSENT" | "PENDING" | "SENT" | "BOUNCED" | "OPENED" | "VIEWED";
241
+ sort_by?: "number" | "date" | "contact_name" | "number2" | "title" | "description" | "amount" | "balance" | "created_at";
242
+ sort_dir?: "asc" | "desc";
243
+ page?: number;
244
+ page_size?: number;
245
+ [key: string]: any;
246
+ }
247
+ /**
248
+ * Represents a summary of a Bukku Invoice as it appears in a list.
249
+ */
250
+ export interface BukkuInvoiceListItem {
251
+ id: number;
252
+ number: string;
253
+ number2: string;
254
+ contact_id: number;
255
+ contact_name: string;
256
+ contact_email: string;
257
+ date: string;
258
+ billing_party: string;
259
+ shipping_party: string;
260
+ tag_names?: string[];
261
+ title: string;
262
+ description: string;
263
+ currency_code: string;
264
+ currency_symbol: string;
265
+ exchange_rate: number;
266
+ amount: number;
267
+ status: string;
268
+ email_status: string;
269
+ file_count: number;
270
+ short_link: string;
271
+ created_by: string;
272
+ created_at: string;
273
+ updated_at: string;
274
+ customs_form_no: string | null;
275
+ customs_k2_form_no: string | null;
276
+ incoterms: string | null;
277
+ myinvois_action: string | null;
278
+ myinvois_document_uuid: string | null;
279
+ myinvois_document_long_id: string | null;
280
+ myinvois_document_status: string | null;
281
+ issued_at: string | null;
282
+ validated_at: string | null;
283
+ rejected_at: string | null;
284
+ reject_message: string | null;
285
+ cancelled_at: string | null;
286
+ cancel_message: string | null;
287
+ }
288
+ /**
289
+ * Represents the API response structure for listing invoices.
290
+ */
291
+ export interface BukkuInvoiceListApiResponse {
292
+ paging: BukkuListPagination;
293
+ transactions: BukkuInvoiceListItem[];
294
+ }
295
+ /**
296
+ * Parameters for updating a Bukku Invoice.
297
+ * Based on PUT /sales/invoices/{transactionId}
298
+ * 'status' and 'payment_mode' are typically not updatable via this kind of request.
299
+ * 'number' becomes a required field.
300
+ */
301
+ export interface BukkuInvoiceUpdateParams {
302
+ contact_id: number;
303
+ number: string;
304
+ number2?: string;
305
+ date: string;
306
+ currency_code: string;
307
+ exchange_rate: number;
308
+ billing_party?: string;
309
+ show_shipping?: boolean;
310
+ shipping_party?: string;
311
+ shipping_info?: string;
312
+ tag_ids?: number[];
313
+ title?: string;
314
+ description?: string;
315
+ remarks?: string;
316
+ tax_mode: "inclusive" | "exclusive";
317
+ form_items: Array<BukkuInvoiceFormItemCreateParams>;
318
+ term_items?: Array<BukkuInvoiceTermItemCreateParams>;
319
+ deposit_items?: Array<BukkuInvoiceDepositItemCreateParams>;
320
+ email?: BukkuEmailDetails;
321
+ files?: Array<BukkuFileAttachment>;
322
+ customs_form_no?: string | null;
323
+ customs_k2_form_no?: string | null;
324
+ incoterms?: string | null;
325
+ myinvois_action?: "NORMAL" | "VALIDATE" | "EXTERNAL";
326
+ }
327
+ /**
328
+ * Parameters for updating the status of a Bukku Invoice.
329
+ * Based on PATCH /sales/invoices/{transactionId} request body schema.
330
+ */
331
+ export interface BukkuInvoiceStatusUpdateParams {
332
+ /** The new status for the invoice. */
333
+ status: "ready" | "draft" | "pending_approval" | "void";
334
+ }
335
+ //# sourceMappingURL=type.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/sales/invoices/type.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EAGnB,mBAAmB,EAEpB,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,gCAAgC,EAAE,CAAC;CAC/C;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IAClD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,YAAY,EAAE,MAAM,GAAG,QAAQ,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,WAAW,GAAG,WAAW,CAAC;IACpC,UAAU,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,UAAU,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACrD,aAAa,CAAC,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAC3D,MAAM,EAAE,OAAO,GAAG,kBAAkB,GAAG,OAAO,CAAC;IAC/C,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACnC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,eAAe,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;CACtD;AAID;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,MAAM,CAAC;IAE5B,QAAQ,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,qBAAqB,EAAE,MAAM,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,sBAAsB,EAAE,CAAC;IAC/B,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,GAAG,QAAQ,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,WAAW,GAAG,WAAW,CAAC;IACpC,UAAU,EAAE,oBAAoB,EAAE,CAAC;IACnC,UAAU,EAAE,oBAAoB,EAAE,CAAC;IACnC,aAAa,EAAE,uBAAuB,EAAE,CAAC;IACzC,YAAY,EAAE,sBAAsB,EAAE,CAAC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,qBAAqB,EAAE,CAAC;IAC/B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,IAAI,CAAC;IAC3D,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,YAAY,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,cAAc,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAC;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IACjC,MAAM,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,kBAAkB,GAAG,OAAO,GAAG,MAAM,CAAC;IACjE,YAAY,CAAC,EACT,QAAQ,GACR,SAAS,GACT,MAAM,GACN,SAAS,GACT,QAAQ,GACR,QAAQ,CAAC;IACb,OAAO,CAAC,EACJ,QAAQ,GACR,MAAM,GACN,cAAc,GACd,SAAS,GACT,OAAO,GACP,aAAa,GACb,QAAQ,GACR,SAAS,GACT,YAAY,CAAC;IACjB,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAI/B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,YAAY,EAAE,oBAAoB,EAAE,CAAC;CACtC;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,WAAW,GAAG,WAAW,CAAC;IACpC,UAAU,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,UAAU,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACrD,aAAa,CAAC,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAC3D,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACnC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,eAAe,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,sCAAsC;IACtC,MAAM,EAAE,OAAO,GAAG,OAAO,GAAG,kBAAkB,GAAG,MAAM,CAAC;CACzD"}
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ // src/sales/invoices/type.ts
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ //# sourceMappingURL=type.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"type.js","sourceRoot":"","sources":["../../../src/sales/invoices/type.ts"],"names":[],"mappings":";AAAA,6BAA6B"}
@@ -0,0 +1,52 @@
1
+ import type { BukkuAPIRequestFunction } from "../../types";
2
+ import { BukkuPayment, BukkuPaymentCreateParams, BukkuPaymentListParams, BukkuPaymentListApiResponse, BukkuPaymentUpdateParams, BukkuPaymentStatusUpdateParams } from "./type";
3
+ export declare class PaymentsAPI {
4
+ private _request;
5
+ constructor(_request: BukkuAPIRequestFunction);
6
+ /**
7
+ * Creates a new payment.
8
+ * Endpoint: POST /sales/payments
9
+ * @param data - The data for the new payment.
10
+ * @returns A promise that resolves to the created payment.
11
+ */
12
+ create(data: BukkuPaymentCreateParams): Promise<BukkuPayment>;
13
+ /**
14
+ * Retrieves a paginated list of payments.
15
+ * Endpoint: GET /sales/payments
16
+ * @param params - Optional parameters for filtering and pagination.
17
+ * @returns A promise that resolves to the API response for listing payments.
18
+ */
19
+ list(params?: BukkuPaymentListParams): Promise<BukkuPaymentListApiResponse>;
20
+ /**
21
+ * Retrieves a specific payment by its ID.
22
+ * Endpoint: GET /sales/payments/{id}
23
+ * @param id - The ID of the payment to retrieve.
24
+ * @returns A promise that resolves to the payment.
25
+ */
26
+ get(id: string | number): Promise<BukkuPayment>;
27
+ /**
28
+ * Updates an existing payment.
29
+ * Endpoint: PUT /sales/payments/{id}
30
+ * @param id - The ID of the payment to update.
31
+ * @param data - The data to update the payment with.
32
+ * @returns A promise that resolves to the updated payment.
33
+ */
34
+ update(id: string | number, data: BukkuPaymentUpdateParams): Promise<BukkuPayment>;
35
+ /**
36
+ * Deletes a payment.
37
+ * Endpoint: DELETE /sales/payments/{id}
38
+ * Note: Deletion policy for payments should be verified with API documentation.
39
+ * @param id - The ID of the payment to delete.
40
+ * @returns A promise that resolves when the payment is deleted.
41
+ */
42
+ delete(id: string | number): Promise<void>;
43
+ /**
44
+ * Updates the status of an existing payment.
45
+ * Endpoint: PATCH /sales/payments/{id}
46
+ * @param id - The ID of the payment to update.
47
+ * @param data - The data containing the new status.
48
+ * @returns A promise that resolves to the updated payment.
49
+ */
50
+ updateStatus(id: string | number, data: BukkuPaymentStatusUpdateParams): Promise<BukkuPayment>;
51
+ }
52
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sales/payments/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EACL,YAAY,EACZ,wBAAwB,EAExB,sBAAsB,EACtB,2BAA2B,EAC3B,wBAAwB,EACxB,8BAA8B,EAC/B,MAAM,QAAQ,CAAC;AAEhB,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ;gBAAR,QAAQ,EAAE,uBAAuB;IAErD;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,YAAY,CAAC;IASnE;;;;;OAKG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,sBAAsB,GAC9B,OAAO,CAAC,2BAA2B,CAAC;IASvC;;;;;OAKG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAQrD;;;;;;OAMG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,IAAI,EAAE,wBAAwB,GAC7B,OAAO,CAAC,YAAY,CAAC;IASxB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD;;;;;;OAMG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,IAAI,EAAE,8BAA8B,GACnC,OAAO,CAAC,YAAY,CAAC;CAQzB"}
@@ -0,0 +1,72 @@
1
+ "use strict";
2
+ // src/sales/payments/index.ts
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.PaymentsAPI = void 0;
5
+ class PaymentsAPI {
6
+ constructor(_request) {
7
+ this._request = _request;
8
+ }
9
+ /**
10
+ * Creates a new payment.
11
+ * Endpoint: POST /sales/payments
12
+ * @param data - The data for the new payment.
13
+ * @returns A promise that resolves to the created payment.
14
+ */
15
+ async create(data) {
16
+ const response = await this._request("/sales/payments", "POST", data);
17
+ return response.transaction;
18
+ }
19
+ /**
20
+ * Retrieves a paginated list of payments.
21
+ * Endpoint: GET /sales/payments
22
+ * @param params - Optional parameters for filtering and pagination.
23
+ * @returns A promise that resolves to the API response for listing payments.
24
+ */
25
+ async list(params) {
26
+ return this._request("/sales/payments", "GET", undefined, params);
27
+ }
28
+ /**
29
+ * Retrieves a specific payment by its ID.
30
+ * Endpoint: GET /sales/payments/{id}
31
+ * @param id - The ID of the payment to retrieve.
32
+ * @returns A promise that resolves to the payment.
33
+ */
34
+ async get(id) {
35
+ const response = await this._request(`/sales/payments/${id}`, "GET");
36
+ return response.transaction;
37
+ }
38
+ /**
39
+ * Updates an existing payment.
40
+ * Endpoint: PUT /sales/payments/{id}
41
+ * @param id - The ID of the payment to update.
42
+ * @param data - The data to update the payment with.
43
+ * @returns A promise that resolves to the updated payment.
44
+ */
45
+ async update(id, data) {
46
+ const response = await this._request(`/sales/payments/${id}`, "PUT", data);
47
+ return response.transaction;
48
+ }
49
+ /**
50
+ * Deletes a payment.
51
+ * Endpoint: DELETE /sales/payments/{id}
52
+ * Note: Deletion policy for payments should be verified with API documentation.
53
+ * @param id - The ID of the payment to delete.
54
+ * @returns A promise that resolves when the payment is deleted.
55
+ */
56
+ async delete(id) {
57
+ await this._request(`/sales/payments/${id}`, "DELETE");
58
+ }
59
+ /**
60
+ * Updates the status of an existing payment.
61
+ * Endpoint: PATCH /sales/payments/{id}
62
+ * @param id - The ID of the payment to update.
63
+ * @param data - The data containing the new status.
64
+ * @returns A promise that resolves to the updated payment.
65
+ */
66
+ async updateStatus(id, data) {
67
+ const response = await this._request(`/sales/payments/${id}`, "PATCH", data);
68
+ return response.transaction;
69
+ }
70
+ }
71
+ exports.PaymentsAPI = PaymentsAPI;
72
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sales/payments/index.ts"],"names":[],"mappings":";AAAA,8BAA8B;;;AAa9B,MAAa,WAAW;IACtB,YAAoB,QAAiC;QAAjC,aAAQ,GAAR,QAAQ,CAAyB;IAAG,CAAC;IAEzD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,IAA8B;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,iBAAiB,EACjB,MAAM,EACN,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,MAA+B;QAE/B,OAAO,IAAI,CAAC,QAAQ,CAClB,iBAAiB,EACjB,KAAK,EACL,SAAS,EACT,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAC,EAAmB;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,mBAAmB,EAAE,EAAE,EACvB,KAAK,CACN,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,EAAmB,EACnB,IAA8B;QAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,mBAAmB,EAAE,EAAE,EACvB,KAAK,EACL,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,EAAmB;QAC9B,MAAM,IAAI,CAAC,QAAQ,CAAO,mBAAmB,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAChB,EAAmB,EACnB,IAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,mBAAmB,EAAE,EAAE,EACvB,OAAO,EACP,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;CACF;AAjGD,kCAiGC"}