mollie-api-typescript 0.0.5 → 0.0.7

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 (239) hide show
  1. package/README.md +3 -2
  2. package/bin/mcp-server.js +710 -1292
  3. package/bin/mcp-server.js.map +31 -31
  4. package/dist/commonjs/funcs/delayedRoutingList.js +4 -0
  5. package/dist/commonjs/funcs/delayedRoutingList.js.map +1 -1
  6. package/dist/commonjs/funcs/refundsGet.js +1 -1
  7. package/dist/commonjs/funcs/refundsGet.js.map +1 -1
  8. package/dist/commonjs/funcs/refundsList.js +1 -1
  9. package/dist/commonjs/funcs/refundsList.js.map +1 -1
  10. package/dist/commonjs/funcs/settlementsListRefunds.js +1 -1
  11. package/dist/commonjs/funcs/settlementsListRefunds.js.map +1 -1
  12. package/dist/commonjs/funcs/subscriptionsAll.d.ts +1 -1
  13. package/dist/commonjs/funcs/subscriptionsAll.d.ts.map +1 -1
  14. package/dist/commonjs/funcs/subscriptionsAll.js +2 -5
  15. package/dist/commonjs/funcs/subscriptionsAll.js.map +1 -1
  16. package/dist/commonjs/lib/config.d.ts +3 -3
  17. package/dist/commonjs/lib/config.js +3 -3
  18. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  19. package/dist/commonjs/mcp-server/server.js +1 -1
  20. package/dist/commonjs/models/errors/listallsubscriptions.d.ts +95 -14
  21. package/dist/commonjs/models/errors/listallsubscriptions.d.ts.map +1 -1
  22. package/dist/commonjs/models/errors/listallsubscriptions.js +80 -14
  23. package/dist/commonjs/models/errors/listallsubscriptions.js.map +1 -1
  24. package/dist/commonjs/models/operations/cancelsubscription.d.ts +40 -40
  25. package/dist/commonjs/models/operations/cancelsubscription.d.ts.map +1 -1
  26. package/dist/commonjs/models/operations/cancelsubscription.js +40 -48
  27. package/dist/commonjs/models/operations/cancelsubscription.js.map +1 -1
  28. package/dist/commonjs/models/operations/createcustomer.d.ts +22 -22
  29. package/dist/commonjs/models/operations/createcustomer.d.ts.map +1 -1
  30. package/dist/commonjs/models/operations/createcustomer.js +22 -24
  31. package/dist/commonjs/models/operations/createcustomer.js.map +1 -1
  32. package/dist/commonjs/models/operations/createmandate.d.ts +26 -26
  33. package/dist/commonjs/models/operations/createmandate.d.ts.map +1 -1
  34. package/dist/commonjs/models/operations/createmandate.js +26 -28
  35. package/dist/commonjs/models/operations/createmandate.js.map +1 -1
  36. package/dist/commonjs/models/operations/createrefund.d.ts +7 -7
  37. package/dist/commonjs/models/operations/createrefund.d.ts.map +1 -1
  38. package/dist/commonjs/models/operations/createrefund.js +8 -10
  39. package/dist/commonjs/models/operations/createrefund.js.map +1 -1
  40. package/dist/commonjs/models/operations/createsubscription.d.ts +44 -44
  41. package/dist/commonjs/models/operations/createsubscription.d.ts.map +1 -1
  42. package/dist/commonjs/models/operations/createsubscription.js +44 -53
  43. package/dist/commonjs/models/operations/createsubscription.js.map +1 -1
  44. package/dist/commonjs/models/operations/getcustomer.d.ts +28 -28
  45. package/dist/commonjs/models/operations/getcustomer.d.ts.map +1 -1
  46. package/dist/commonjs/models/operations/getcustomer.js +28 -30
  47. package/dist/commonjs/models/operations/getcustomer.js.map +1 -1
  48. package/dist/commonjs/models/operations/getmandate.d.ts +26 -26
  49. package/dist/commonjs/models/operations/getmandate.d.ts.map +1 -1
  50. package/dist/commonjs/models/operations/getmandate.js +26 -27
  51. package/dist/commonjs/models/operations/getmandate.js.map +1 -1
  52. package/dist/commonjs/models/operations/getrefund.d.ts +28 -19
  53. package/dist/commonjs/models/operations/getrefund.d.ts.map +1 -1
  54. package/dist/commonjs/models/operations/getrefund.js +25 -22
  55. package/dist/commonjs/models/operations/getrefund.js.map +1 -1
  56. package/dist/commonjs/models/operations/getsubscription.d.ts +40 -40
  57. package/dist/commonjs/models/operations/getsubscription.d.ts.map +1 -1
  58. package/dist/commonjs/models/operations/getsubscription.js +40 -48
  59. package/dist/commonjs/models/operations/getsubscription.js.map +1 -1
  60. package/dist/commonjs/models/operations/listallrefunds.d.ts +9 -15
  61. package/dist/commonjs/models/operations/listallrefunds.d.ts.map +1 -1
  62. package/dist/commonjs/models/operations/listallrefunds.js +8 -10
  63. package/dist/commonjs/models/operations/listallrefunds.js.map +1 -1
  64. package/dist/commonjs/models/operations/listallsubscriptions.d.ts +532 -2849
  65. package/dist/commonjs/models/operations/listallsubscriptions.d.ts.map +1 -1
  66. package/dist/commonjs/models/operations/listallsubscriptions.js +345 -1612
  67. package/dist/commonjs/models/operations/listallsubscriptions.js.map +1 -1
  68. package/dist/commonjs/models/operations/listcustomers.d.ts +22 -22
  69. package/dist/commonjs/models/operations/listcustomers.d.ts.map +1 -1
  70. package/dist/commonjs/models/operations/listcustomers.js +22 -22
  71. package/dist/commonjs/models/operations/listcustomers.js.map +1 -1
  72. package/dist/commonjs/models/operations/listmandates.d.ts +26 -26
  73. package/dist/commonjs/models/operations/listmandates.d.ts.map +1 -1
  74. package/dist/commonjs/models/operations/listmandates.js +26 -26
  75. package/dist/commonjs/models/operations/listmandates.js.map +1 -1
  76. package/dist/commonjs/models/operations/listrefunds.d.ts +28 -19
  77. package/dist/commonjs/models/operations/listrefunds.d.ts.map +1 -1
  78. package/dist/commonjs/models/operations/listrefunds.js +25 -24
  79. package/dist/commonjs/models/operations/listrefunds.js.map +1 -1
  80. package/dist/commonjs/models/operations/listsettlementrefunds.d.ts +28 -19
  81. package/dist/commonjs/models/operations/listsettlementrefunds.d.ts.map +1 -1
  82. package/dist/commonjs/models/operations/listsettlementrefunds.js +25 -22
  83. package/dist/commonjs/models/operations/listsettlementrefunds.js.map +1 -1
  84. package/dist/commonjs/models/operations/listsubscriptions.d.ts +81 -81
  85. package/dist/commonjs/models/operations/listsubscriptions.d.ts.map +1 -1
  86. package/dist/commonjs/models/operations/listsubscriptions.js +90 -96
  87. package/dist/commonjs/models/operations/listsubscriptions.js.map +1 -1
  88. package/dist/commonjs/models/operations/paymentcreateroute.d.ts +11 -0
  89. package/dist/commonjs/models/operations/paymentcreateroute.d.ts.map +1 -1
  90. package/dist/commonjs/models/operations/paymentcreateroute.js +2 -0
  91. package/dist/commonjs/models/operations/paymentcreateroute.js.map +1 -1
  92. package/dist/commonjs/models/operations/paymentlistroutes.d.ts +11 -0
  93. package/dist/commonjs/models/operations/paymentlistroutes.d.ts.map +1 -1
  94. package/dist/commonjs/models/operations/paymentlistroutes.js +2 -0
  95. package/dist/commonjs/models/operations/paymentlistroutes.js.map +1 -1
  96. package/dist/commonjs/models/operations/updatecustomer.d.ts +22 -22
  97. package/dist/commonjs/models/operations/updatecustomer.d.ts.map +1 -1
  98. package/dist/commonjs/models/operations/updatecustomer.js +22 -24
  99. package/dist/commonjs/models/operations/updatecustomer.js.map +1 -1
  100. package/dist/commonjs/models/operations/updatesubscription.d.ts +40 -40
  101. package/dist/commonjs/models/operations/updatesubscription.d.ts.map +1 -1
  102. package/dist/commonjs/models/operations/updatesubscription.js +40 -50
  103. package/dist/commonjs/models/operations/updatesubscription.js.map +1 -1
  104. package/dist/esm/funcs/delayedRoutingList.js +5 -1
  105. package/dist/esm/funcs/delayedRoutingList.js.map +1 -1
  106. package/dist/esm/funcs/refundsGet.js +1 -1
  107. package/dist/esm/funcs/refundsGet.js.map +1 -1
  108. package/dist/esm/funcs/refundsList.js +1 -1
  109. package/dist/esm/funcs/refundsList.js.map +1 -1
  110. package/dist/esm/funcs/settlementsListRefunds.js +1 -1
  111. package/dist/esm/funcs/settlementsListRefunds.js.map +1 -1
  112. package/dist/esm/funcs/subscriptionsAll.d.ts +1 -1
  113. package/dist/esm/funcs/subscriptionsAll.d.ts.map +1 -1
  114. package/dist/esm/funcs/subscriptionsAll.js +2 -5
  115. package/dist/esm/funcs/subscriptionsAll.js.map +1 -1
  116. package/dist/esm/lib/config.d.ts +3 -3
  117. package/dist/esm/lib/config.js +3 -3
  118. package/dist/esm/mcp-server/mcp-server.js +1 -1
  119. package/dist/esm/mcp-server/server.js +1 -1
  120. package/dist/esm/models/errors/listallsubscriptions.d.ts +95 -14
  121. package/dist/esm/models/errors/listallsubscriptions.d.ts.map +1 -1
  122. package/dist/esm/models/errors/listallsubscriptions.js +77 -12
  123. package/dist/esm/models/errors/listallsubscriptions.js.map +1 -1
  124. package/dist/esm/models/operations/cancelsubscription.d.ts +40 -40
  125. package/dist/esm/models/operations/cancelsubscription.d.ts.map +1 -1
  126. package/dist/esm/models/operations/cancelsubscription.js +40 -48
  127. package/dist/esm/models/operations/cancelsubscription.js.map +1 -1
  128. package/dist/esm/models/operations/createcustomer.d.ts +22 -22
  129. package/dist/esm/models/operations/createcustomer.d.ts.map +1 -1
  130. package/dist/esm/models/operations/createcustomer.js +22 -24
  131. package/dist/esm/models/operations/createcustomer.js.map +1 -1
  132. package/dist/esm/models/operations/createmandate.d.ts +26 -26
  133. package/dist/esm/models/operations/createmandate.d.ts.map +1 -1
  134. package/dist/esm/models/operations/createmandate.js +26 -28
  135. package/dist/esm/models/operations/createmandate.js.map +1 -1
  136. package/dist/esm/models/operations/createrefund.d.ts +7 -7
  137. package/dist/esm/models/operations/createrefund.d.ts.map +1 -1
  138. package/dist/esm/models/operations/createrefund.js +8 -10
  139. package/dist/esm/models/operations/createrefund.js.map +1 -1
  140. package/dist/esm/models/operations/createsubscription.d.ts +44 -44
  141. package/dist/esm/models/operations/createsubscription.d.ts.map +1 -1
  142. package/dist/esm/models/operations/createsubscription.js +44 -53
  143. package/dist/esm/models/operations/createsubscription.js.map +1 -1
  144. package/dist/esm/models/operations/getcustomer.d.ts +28 -28
  145. package/dist/esm/models/operations/getcustomer.d.ts.map +1 -1
  146. package/dist/esm/models/operations/getcustomer.js +28 -30
  147. package/dist/esm/models/operations/getcustomer.js.map +1 -1
  148. package/dist/esm/models/operations/getmandate.d.ts +26 -26
  149. package/dist/esm/models/operations/getmandate.d.ts.map +1 -1
  150. package/dist/esm/models/operations/getmandate.js +26 -27
  151. package/dist/esm/models/operations/getmandate.js.map +1 -1
  152. package/dist/esm/models/operations/getrefund.d.ts +28 -19
  153. package/dist/esm/models/operations/getrefund.d.ts.map +1 -1
  154. package/dist/esm/models/operations/getrefund.js +24 -21
  155. package/dist/esm/models/operations/getrefund.js.map +1 -1
  156. package/dist/esm/models/operations/getsubscription.d.ts +40 -40
  157. package/dist/esm/models/operations/getsubscription.d.ts.map +1 -1
  158. package/dist/esm/models/operations/getsubscription.js +40 -48
  159. package/dist/esm/models/operations/getsubscription.js.map +1 -1
  160. package/dist/esm/models/operations/listallrefunds.d.ts +9 -15
  161. package/dist/esm/models/operations/listallrefunds.d.ts.map +1 -1
  162. package/dist/esm/models/operations/listallrefunds.js +8 -10
  163. package/dist/esm/models/operations/listallrefunds.js.map +1 -1
  164. package/dist/esm/models/operations/listallsubscriptions.d.ts +532 -2849
  165. package/dist/esm/models/operations/listallsubscriptions.d.ts.map +1 -1
  166. package/dist/esm/models/operations/listallsubscriptions.js +325 -1533
  167. package/dist/esm/models/operations/listallsubscriptions.js.map +1 -1
  168. package/dist/esm/models/operations/listcustomers.d.ts +22 -22
  169. package/dist/esm/models/operations/listcustomers.d.ts.map +1 -1
  170. package/dist/esm/models/operations/listcustomers.js +22 -22
  171. package/dist/esm/models/operations/listcustomers.js.map +1 -1
  172. package/dist/esm/models/operations/listmandates.d.ts +26 -26
  173. package/dist/esm/models/operations/listmandates.d.ts.map +1 -1
  174. package/dist/esm/models/operations/listmandates.js +26 -26
  175. package/dist/esm/models/operations/listmandates.js.map +1 -1
  176. package/dist/esm/models/operations/listrefunds.d.ts +28 -19
  177. package/dist/esm/models/operations/listrefunds.d.ts.map +1 -1
  178. package/dist/esm/models/operations/listrefunds.js +24 -23
  179. package/dist/esm/models/operations/listrefunds.js.map +1 -1
  180. package/dist/esm/models/operations/listsettlementrefunds.d.ts +28 -19
  181. package/dist/esm/models/operations/listsettlementrefunds.d.ts.map +1 -1
  182. package/dist/esm/models/operations/listsettlementrefunds.js +24 -21
  183. package/dist/esm/models/operations/listsettlementrefunds.js.map +1 -1
  184. package/dist/esm/models/operations/listsubscriptions.d.ts +81 -81
  185. package/dist/esm/models/operations/listsubscriptions.d.ts.map +1 -1
  186. package/dist/esm/models/operations/listsubscriptions.js +83 -89
  187. package/dist/esm/models/operations/listsubscriptions.js.map +1 -1
  188. package/dist/esm/models/operations/paymentcreateroute.d.ts +11 -0
  189. package/dist/esm/models/operations/paymentcreateroute.d.ts.map +1 -1
  190. package/dist/esm/models/operations/paymentcreateroute.js +2 -0
  191. package/dist/esm/models/operations/paymentcreateroute.js.map +1 -1
  192. package/dist/esm/models/operations/paymentlistroutes.d.ts +11 -0
  193. package/dist/esm/models/operations/paymentlistroutes.d.ts.map +1 -1
  194. package/dist/esm/models/operations/paymentlistroutes.js +2 -0
  195. package/dist/esm/models/operations/paymentlistroutes.js.map +1 -1
  196. package/dist/esm/models/operations/updatecustomer.d.ts +22 -22
  197. package/dist/esm/models/operations/updatecustomer.d.ts.map +1 -1
  198. package/dist/esm/models/operations/updatecustomer.js +22 -24
  199. package/dist/esm/models/operations/updatecustomer.js.map +1 -1
  200. package/dist/esm/models/operations/updatesubscription.d.ts +40 -40
  201. package/dist/esm/models/operations/updatesubscription.d.ts.map +1 -1
  202. package/dist/esm/models/operations/updatesubscription.js +40 -50
  203. package/dist/esm/models/operations/updatesubscription.js.map +1 -1
  204. package/docs/sdks/delayedrouting/README.md +4 -0
  205. package/docs/sdks/refunds/README.md +4 -4
  206. package/docs/sdks/settlements/README.md +2 -2
  207. package/docs/sdks/subscriptions/README.md +5 -4
  208. package/examples/package-lock.json +2 -2
  209. package/jsr.json +1 -1
  210. package/package.json +2 -2
  211. package/src/funcs/delayedRoutingList.ts +6 -1
  212. package/src/funcs/refundsGet.ts +1 -1
  213. package/src/funcs/refundsList.ts +1 -1
  214. package/src/funcs/settlementsListRefunds.ts +1 -1
  215. package/src/funcs/subscriptionsAll.ts +17 -8
  216. package/src/lib/config.ts +3 -3
  217. package/src/mcp-server/mcp-server.ts +1 -1
  218. package/src/mcp-server/server.ts +1 -1
  219. package/src/models/errors/listallsubscriptions.ts +173 -23
  220. package/src/models/operations/cancelsubscription.ts +80 -98
  221. package/src/models/operations/createcustomer.ts +45 -53
  222. package/src/models/operations/createmandate.ts +52 -54
  223. package/src/models/operations/createrefund.ts +15 -17
  224. package/src/models/operations/createsubscription.ts +89 -104
  225. package/src/models/operations/getcustomer.ts +56 -63
  226. package/src/models/operations/getmandate.ts +52 -53
  227. package/src/models/operations/getrefund.ts +44 -35
  228. package/src/models/operations/getsubscription.ts +80 -98
  229. package/src/models/operations/listallrefunds.ts +17 -25
  230. package/src/models/operations/listallsubscriptions.ts +894 -4395
  231. package/src/models/operations/listcustomers.ts +44 -49
  232. package/src/models/operations/listmandates.ts +52 -52
  233. package/src/models/operations/listrefunds.ts +44 -37
  234. package/src/models/operations/listsettlementrefunds.ts +45 -36
  235. package/src/models/operations/listsubscriptions.ts +181 -176
  236. package/src/models/operations/paymentcreateroute.ts +13 -0
  237. package/src/models/operations/paymentlistroutes.ts +13 -0
  238. package/src/models/operations/updatecustomer.ts +45 -53
  239. package/src/models/operations/updatesubscription.ts +81 -97
@@ -160,8 +160,8 @@ export type GetSubscriptionApplicationFee = {
160
160
  /**
161
161
  * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
162
162
  */
163
- amount?: GetSubscriptionApplicationFeeAmount | undefined;
164
- description?: string | undefined;
163
+ amount: GetSubscriptionApplicationFeeAmount;
164
+ description: string;
165
165
  };
166
166
 
167
167
  export type GetSubscriptionMetadata = {};
@@ -274,11 +274,11 @@ export type GetSubscriptionLinks = {
274
274
  /**
275
275
  * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
276
276
  */
277
- self?: GetSubscriptionSelf | undefined;
277
+ self: GetSubscriptionSelf;
278
278
  /**
279
279
  * The API resource URL of the [customer](get-customer) this subscription was created for.
280
280
  */
281
- customer?: GetSubscriptionCustomer | null | undefined;
281
+ customer: GetSubscriptionCustomer | null;
282
282
  /**
283
283
  * The API resource URL of the [mandate](get-mandate) this subscription was created for.
284
284
  */
@@ -286,7 +286,7 @@ export type GetSubscriptionLinks = {
286
286
  /**
287
287
  * The API resource URL of the [profile](get-profile) this subscription was created for.
288
288
  */
289
- profile?: GetSubscriptionProfile | null | undefined;
289
+ profile: GetSubscriptionProfile | null;
290
290
  /**
291
291
  * The API resource URL of the [payments](list-payments) created for this subscription. Omitted if no such
292
292
  *
@@ -297,7 +297,7 @@ export type GetSubscriptionLinks = {
297
297
  /**
298
298
  * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
299
299
  */
300
- documentation?: GetSubscriptionDocumentation | undefined;
300
+ documentation: GetSubscriptionDocumentation;
301
301
  };
302
302
 
303
303
  /**
@@ -314,25 +314,25 @@ export type GetSubscriptionResponse = {
314
314
  /**
315
315
  * The identifier uniquely referring to this subscription. Example: `sub_rVKGtNd6s3`.
316
316
  */
317
- id?: string | undefined;
317
+ id: string;
318
318
  /**
319
319
  * Whether this entity was created in live mode or in test mode.
320
320
  */
321
- mode?: GetSubscriptionMode | undefined;
321
+ mode: GetSubscriptionMode;
322
322
  /**
323
323
  * The subscription's current status is directly related to the status of the underlying customer or mandate that is
324
324
  *
325
325
  * @remarks
326
326
  * enabling the subscription.
327
327
  */
328
- status?: GetSubscriptionStatus | undefined;
328
+ status: GetSubscriptionStatus;
329
329
  /**
330
330
  * The amount for each individual payment that is charged with this subscription. For example, for a monthly
331
331
  *
332
332
  * @remarks
333
333
  * subscription of €10, the subscription amount should be set to €10.
334
334
  */
335
- amount?: GetSubscriptionAmount | undefined;
335
+ amount: GetSubscriptionAmount;
336
336
  /**
337
337
  * Total number of payments for the subscription. Once this number of payments is reached, the subscription is
338
338
  *
@@ -341,11 +341,11 @@ export type GetSubscriptionResponse = {
341
341
  *
342
342
  * Test mode subscriptions will get canceled automatically after 10 payments.
343
343
  */
344
- times?: number | null | undefined;
344
+ times: number | null;
345
345
  /**
346
346
  * Number of payments left for the subscription.
347
347
  */
348
- timesRemaining?: number | undefined;
348
+ timesRemaining: number;
349
349
  /**
350
350
  * Interval to wait between payments, for example `1 month` or `14 days`.
351
351
  *
@@ -353,11 +353,11 @@ export type GetSubscriptionResponse = {
353
353
  *
354
354
  * The maximum interval is one year (`12 months`, `52 weeks`, or `365 days`).
355
355
  */
356
- interval?: GetSubscriptionInterval | undefined;
356
+ interval: GetSubscriptionInterval;
357
357
  /**
358
358
  * The start date of the subscription in `YYYY-MM-DD` format.
359
359
  */
360
- startDate?: string | undefined;
360
+ startDate: string;
361
361
  /**
362
362
  * The date of the next scheduled payment in `YYYY-MM-DD` format. If the subscription has been completed or canceled,
363
363
  *
@@ -373,11 +373,11 @@ export type GetSubscriptionResponse = {
373
373
  *
374
374
  * **Please note:** the description needs to be unique for the Customer in case it has multiple active subscriptions.
375
375
  */
376
- description?: string | undefined;
376
+ description: string;
377
377
  /**
378
378
  * The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used.
379
379
  */
380
- method?: GetSubscriptionMethod | null | undefined;
380
+ method: GetSubscriptionMethod | null;
381
381
  /**
382
382
  * With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
383
383
  *
@@ -399,12 +399,7 @@ export type GetSubscriptionResponse = {
399
399
  *
400
400
  * Any metadata added to the subscription will be automatically forwarded to the payments generated for it.
401
401
  */
402
- metadata?:
403
- | GetSubscriptionMetadata
404
- | string
405
- | Array<string>
406
- | null
407
- | undefined;
402
+ metadata: GetSubscriptionMetadata | string | Array<string> | null;
408
403
  /**
409
404
  * We will call this URL for any payment status changes of payments resulting from this subscription.
410
405
  *
@@ -413,11 +408,11 @@ export type GetSubscriptionResponse = {
413
408
  * This webhook will receive **all** events for the subscription's payments. This may include payment failures as
414
409
  * well. Be sure to verify the payment's subscription ID and its status.
415
410
  */
416
- webhookUrl?: string | undefined;
411
+ webhookUrl: string;
417
412
  /**
418
413
  * The customer this subscription belongs to.
419
414
  */
420
- customerId?: string | undefined;
415
+ customerId: string;
421
416
  /**
422
417
  * The mandate used for this subscription, if any.
423
418
  */
@@ -425,7 +420,7 @@ export type GetSubscriptionResponse = {
425
420
  /**
426
421
  * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
427
422
  */
428
- createdAt?: string | undefined;
423
+ createdAt: string;
429
424
  /**
430
425
  * The subscription's date and time of cancellation, in ISO 8601 format. This parameter is omitted if the
431
426
  *
@@ -830,15 +825,14 @@ export const GetSubscriptionApplicationFee$inboundSchema: z.ZodType<
830
825
  z.ZodTypeDef,
831
826
  unknown
832
827
  > = z.object({
833
- amount: z.lazy(() => GetSubscriptionApplicationFeeAmount$inboundSchema)
834
- .optional(),
835
- description: z.string().optional(),
828
+ amount: z.lazy(() => GetSubscriptionApplicationFeeAmount$inboundSchema),
829
+ description: z.string(),
836
830
  });
837
831
 
838
832
  /** @internal */
839
833
  export type GetSubscriptionApplicationFee$Outbound = {
840
- amount?: GetSubscriptionApplicationFeeAmount$Outbound | undefined;
841
- description?: string | undefined;
834
+ amount: GetSubscriptionApplicationFeeAmount$Outbound;
835
+ description: string;
842
836
  };
843
837
 
844
838
  /** @internal */
@@ -847,9 +841,8 @@ export const GetSubscriptionApplicationFee$outboundSchema: z.ZodType<
847
841
  z.ZodTypeDef,
848
842
  GetSubscriptionApplicationFee
849
843
  > = z.object({
850
- amount: z.lazy(() => GetSubscriptionApplicationFeeAmount$outboundSchema)
851
- .optional(),
852
- description: z.string().optional(),
844
+ amount: z.lazy(() => GetSubscriptionApplicationFeeAmount$outboundSchema),
845
+ description: z.string(),
853
846
  });
854
847
 
855
848
  /**
@@ -1344,27 +1337,24 @@ export const GetSubscriptionLinks$inboundSchema: z.ZodType<
1344
1337
  z.ZodTypeDef,
1345
1338
  unknown
1346
1339
  > = z.object({
1347
- self: z.lazy(() => GetSubscriptionSelf$inboundSchema).optional(),
1348
- customer: z.nullable(z.lazy(() => GetSubscriptionCustomer$inboundSchema))
1349
- .optional(),
1340
+ self: z.lazy(() => GetSubscriptionSelf$inboundSchema),
1341
+ customer: z.nullable(z.lazy(() => GetSubscriptionCustomer$inboundSchema)),
1350
1342
  mandate: z.nullable(z.lazy(() => GetSubscriptionMandate$inboundSchema))
1351
1343
  .optional(),
1352
- profile: z.nullable(z.lazy(() => GetSubscriptionProfile$inboundSchema))
1353
- .optional(),
1344
+ profile: z.nullable(z.lazy(() => GetSubscriptionProfile$inboundSchema)),
1354
1345
  payments: z.nullable(z.lazy(() => GetSubscriptionPayments$inboundSchema))
1355
1346
  .optional(),
1356
- documentation: z.lazy(() => GetSubscriptionDocumentation$inboundSchema)
1357
- .optional(),
1347
+ documentation: z.lazy(() => GetSubscriptionDocumentation$inboundSchema),
1358
1348
  });
1359
1349
 
1360
1350
  /** @internal */
1361
1351
  export type GetSubscriptionLinks$Outbound = {
1362
- self?: GetSubscriptionSelf$Outbound | undefined;
1363
- customer?: GetSubscriptionCustomer$Outbound | null | undefined;
1352
+ self: GetSubscriptionSelf$Outbound;
1353
+ customer: GetSubscriptionCustomer$Outbound | null;
1364
1354
  mandate?: GetSubscriptionMandate$Outbound | null | undefined;
1365
- profile?: GetSubscriptionProfile$Outbound | null | undefined;
1355
+ profile: GetSubscriptionProfile$Outbound | null;
1366
1356
  payments?: GetSubscriptionPayments$Outbound | null | undefined;
1367
- documentation?: GetSubscriptionDocumentation$Outbound | undefined;
1357
+ documentation: GetSubscriptionDocumentation$Outbound;
1368
1358
  };
1369
1359
 
1370
1360
  /** @internal */
@@ -1373,17 +1363,14 @@ export const GetSubscriptionLinks$outboundSchema: z.ZodType<
1373
1363
  z.ZodTypeDef,
1374
1364
  GetSubscriptionLinks
1375
1365
  > = z.object({
1376
- self: z.lazy(() => GetSubscriptionSelf$outboundSchema).optional(),
1377
- customer: z.nullable(z.lazy(() => GetSubscriptionCustomer$outboundSchema))
1378
- .optional(),
1366
+ self: z.lazy(() => GetSubscriptionSelf$outboundSchema),
1367
+ customer: z.nullable(z.lazy(() => GetSubscriptionCustomer$outboundSchema)),
1379
1368
  mandate: z.nullable(z.lazy(() => GetSubscriptionMandate$outboundSchema))
1380
1369
  .optional(),
1381
- profile: z.nullable(z.lazy(() => GetSubscriptionProfile$outboundSchema))
1382
- .optional(),
1370
+ profile: z.nullable(z.lazy(() => GetSubscriptionProfile$outboundSchema)),
1383
1371
  payments: z.nullable(z.lazy(() => GetSubscriptionPayments$outboundSchema))
1384
1372
  .optional(),
1385
- documentation: z.lazy(() => GetSubscriptionDocumentation$outboundSchema)
1386
- .optional(),
1373
+ documentation: z.lazy(() => GetSubscriptionDocumentation$outboundSchema),
1387
1374
  });
1388
1375
 
1389
1376
  /**
@@ -1424,17 +1411,17 @@ export const GetSubscriptionResponse$inboundSchema: z.ZodType<
1424
1411
  unknown
1425
1412
  > = z.object({
1426
1413
  resource: z.string().default("subscription"),
1427
- id: z.string().optional(),
1428
- mode: GetSubscriptionMode$inboundSchema.optional(),
1429
- status: GetSubscriptionStatus$inboundSchema.optional(),
1430
- amount: z.lazy(() => GetSubscriptionAmount$inboundSchema).optional(),
1431
- times: z.nullable(z.number().int()).optional(),
1432
- timesRemaining: z.number().int().optional(),
1433
- interval: GetSubscriptionInterval$inboundSchema.optional(),
1434
- startDate: z.string().optional(),
1414
+ id: z.string(),
1415
+ mode: GetSubscriptionMode$inboundSchema,
1416
+ status: GetSubscriptionStatus$inboundSchema,
1417
+ amount: z.lazy(() => GetSubscriptionAmount$inboundSchema),
1418
+ times: z.nullable(z.number().int()),
1419
+ timesRemaining: z.number().int(),
1420
+ interval: GetSubscriptionInterval$inboundSchema,
1421
+ startDate: z.string(),
1435
1422
  nextPaymentDate: z.nullable(z.string()).optional(),
1436
- description: z.string().optional(),
1437
- method: z.nullable(GetSubscriptionMethod$inboundSchema).optional(),
1423
+ description: z.string(),
1424
+ method: z.nullable(GetSubscriptionMethod$inboundSchema),
1438
1425
  applicationFee: z.lazy(() => GetSubscriptionApplicationFee$inboundSchema)
1439
1426
  .optional(),
1440
1427
  metadata: z.nullable(
@@ -1443,11 +1430,11 @@ export const GetSubscriptionResponse$inboundSchema: z.ZodType<
1443
1430
  z.string(),
1444
1431
  z.array(z.string()),
1445
1432
  ]),
1446
- ).optional(),
1447
- webhookUrl: z.string().optional(),
1448
- customerId: z.string().optional(),
1433
+ ),
1434
+ webhookUrl: z.string(),
1435
+ customerId: z.string(),
1449
1436
  mandateId: z.nullable(z.string()).optional(),
1450
- createdAt: z.string().optional(),
1437
+ createdAt: z.string(),
1451
1438
  canceledAt: z.nullable(z.string()).optional(),
1452
1439
  _links: z.lazy(() => GetSubscriptionLinks$inboundSchema).optional(),
1453
1440
  }).transform((v) => {
@@ -1459,28 +1446,23 @@ export const GetSubscriptionResponse$inboundSchema: z.ZodType<
1459
1446
  /** @internal */
1460
1447
  export type GetSubscriptionResponse$Outbound = {
1461
1448
  resource: string;
1462
- id?: string | undefined;
1463
- mode?: string | undefined;
1464
- status?: string | undefined;
1465
- amount?: GetSubscriptionAmount$Outbound | undefined;
1466
- times?: number | null | undefined;
1467
- timesRemaining?: number | undefined;
1468
- interval?: string | undefined;
1469
- startDate?: string | undefined;
1449
+ id: string;
1450
+ mode: string;
1451
+ status: string;
1452
+ amount: GetSubscriptionAmount$Outbound;
1453
+ times: number | null;
1454
+ timesRemaining: number;
1455
+ interval: string;
1456
+ startDate: string;
1470
1457
  nextPaymentDate?: string | null | undefined;
1471
- description?: string | undefined;
1472
- method?: string | null | undefined;
1458
+ description: string;
1459
+ method: string | null;
1473
1460
  applicationFee?: GetSubscriptionApplicationFee$Outbound | undefined;
1474
- metadata?:
1475
- | GetSubscriptionMetadata$Outbound
1476
- | string
1477
- | Array<string>
1478
- | null
1479
- | undefined;
1480
- webhookUrl?: string | undefined;
1481
- customerId?: string | undefined;
1461
+ metadata: GetSubscriptionMetadata$Outbound | string | Array<string> | null;
1462
+ webhookUrl: string;
1463
+ customerId: string;
1482
1464
  mandateId?: string | null | undefined;
1483
- createdAt?: string | undefined;
1465
+ createdAt: string;
1484
1466
  canceledAt?: string | null | undefined;
1485
1467
  _links?: GetSubscriptionLinks$Outbound | undefined;
1486
1468
  };
@@ -1492,17 +1474,17 @@ export const GetSubscriptionResponse$outboundSchema: z.ZodType<
1492
1474
  GetSubscriptionResponse
1493
1475
  > = z.object({
1494
1476
  resource: z.string().default("subscription"),
1495
- id: z.string().optional(),
1496
- mode: GetSubscriptionMode$outboundSchema.optional(),
1497
- status: GetSubscriptionStatus$outboundSchema.optional(),
1498
- amount: z.lazy(() => GetSubscriptionAmount$outboundSchema).optional(),
1499
- times: z.nullable(z.number().int()).optional(),
1500
- timesRemaining: z.number().int().optional(),
1501
- interval: GetSubscriptionInterval$outboundSchema.optional(),
1502
- startDate: z.string().optional(),
1477
+ id: z.string(),
1478
+ mode: GetSubscriptionMode$outboundSchema,
1479
+ status: GetSubscriptionStatus$outboundSchema,
1480
+ amount: z.lazy(() => GetSubscriptionAmount$outboundSchema),
1481
+ times: z.nullable(z.number().int()),
1482
+ timesRemaining: z.number().int(),
1483
+ interval: GetSubscriptionInterval$outboundSchema,
1484
+ startDate: z.string(),
1503
1485
  nextPaymentDate: z.nullable(z.string()).optional(),
1504
- description: z.string().optional(),
1505
- method: z.nullable(GetSubscriptionMethod$outboundSchema).optional(),
1486
+ description: z.string(),
1487
+ method: z.nullable(GetSubscriptionMethod$outboundSchema),
1506
1488
  applicationFee: z.lazy(() => GetSubscriptionApplicationFee$outboundSchema)
1507
1489
  .optional(),
1508
1490
  metadata: z.nullable(
@@ -1511,11 +1493,11 @@ export const GetSubscriptionResponse$outboundSchema: z.ZodType<
1511
1493
  z.string(),
1512
1494
  z.array(z.string()),
1513
1495
  ]),
1514
- ).optional(),
1515
- webhookUrl: z.string().optional(),
1516
- customerId: z.string().optional(),
1496
+ ),
1497
+ webhookUrl: z.string(),
1498
+ customerId: z.string(),
1517
1499
  mandateId: z.nullable(z.string()).optional(),
1518
- createdAt: z.string().optional(),
1500
+ createdAt: z.string(),
1519
1501
  canceledAt: z.nullable(z.string()).optional(),
1520
1502
  links: z.lazy(() => GetSubscriptionLinks$outboundSchema).optional(),
1521
1503
  }).transform((v) => {
@@ -319,11 +319,11 @@ export type ListAllRefundsRefundLinks = {
319
319
  /**
320
320
  * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
321
321
  */
322
- self?: ListAllRefundsRefundSelf | undefined;
322
+ self: ListAllRefundsRefundSelf;
323
323
  /**
324
324
  * The API resource URL of the [payment](get-payment) that this refund belongs to.
325
325
  */
326
- payment?: ListAllRefundsPayment | undefined;
326
+ payment: ListAllRefundsPayment;
327
327
  /**
328
328
  * The API resource URL of the [settlement](get-settlement) this refund has been settled with. Not present if not
329
329
  *
@@ -334,7 +334,7 @@ export type ListAllRefundsRefundLinks = {
334
334
  /**
335
335
  * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
336
336
  */
337
- documentation?: ListAllRefundsRefundDocumentation | undefined;
337
+ documentation: ListAllRefundsRefundDocumentation;
338
338
  };
339
339
 
340
340
  export type ListAllRefundsRefund = {
@@ -430,10 +430,7 @@ export type ListAllRefundsRefund = {
430
430
 
431
431
  export type ListAllRefundsEmbedded = {
432
432
  /**
433
- * An array of refund objects. For a complete reference of the refund object, refer to the
434
- *
435
- * @remarks
436
- * [Get refund endpoint](get-refund) documentation.
433
+ * An array of refund objects.
437
434
  */
438
435
  refunds?: Array<ListAllRefundsRefund> | undefined;
439
436
  };
@@ -517,10 +514,7 @@ export type ListAllRefundsLinks = {
517
514
  };
518
515
 
519
516
  /**
520
- * A list of refund objects. For a complete reference of the refund object, refer to the
521
- *
522
- * @remarks
523
- * [Get refund endpoint](get-refund) documentation.
517
+ * A list of refund objects
524
518
  */
525
519
  export type ListAllRefundsResponse = {
526
520
  /**
@@ -1534,20 +1528,19 @@ export const ListAllRefundsRefundLinks$inboundSchema: z.ZodType<
1534
1528
  z.ZodTypeDef,
1535
1529
  unknown
1536
1530
  > = z.object({
1537
- self: z.lazy(() => ListAllRefundsRefundSelf$inboundSchema).optional(),
1538
- payment: z.lazy(() => ListAllRefundsPayment$inboundSchema).optional(),
1531
+ self: z.lazy(() => ListAllRefundsRefundSelf$inboundSchema),
1532
+ payment: z.lazy(() => ListAllRefundsPayment$inboundSchema),
1539
1533
  settlement: z.nullable(z.lazy(() => ListAllRefundsSettlement$inboundSchema))
1540
1534
  .optional(),
1541
- documentation: z.lazy(() => ListAllRefundsRefundDocumentation$inboundSchema)
1542
- .optional(),
1535
+ documentation: z.lazy(() => ListAllRefundsRefundDocumentation$inboundSchema),
1543
1536
  });
1544
1537
 
1545
1538
  /** @internal */
1546
1539
  export type ListAllRefundsRefundLinks$Outbound = {
1547
- self?: ListAllRefundsRefundSelf$Outbound | undefined;
1548
- payment?: ListAllRefundsPayment$Outbound | undefined;
1540
+ self: ListAllRefundsRefundSelf$Outbound;
1541
+ payment: ListAllRefundsPayment$Outbound;
1549
1542
  settlement?: ListAllRefundsSettlement$Outbound | null | undefined;
1550
- documentation?: ListAllRefundsRefundDocumentation$Outbound | undefined;
1543
+ documentation: ListAllRefundsRefundDocumentation$Outbound;
1551
1544
  };
1552
1545
 
1553
1546
  /** @internal */
@@ -1556,12 +1549,11 @@ export const ListAllRefundsRefundLinks$outboundSchema: z.ZodType<
1556
1549
  z.ZodTypeDef,
1557
1550
  ListAllRefundsRefundLinks
1558
1551
  > = z.object({
1559
- self: z.lazy(() => ListAllRefundsRefundSelf$outboundSchema).optional(),
1560
- payment: z.lazy(() => ListAllRefundsPayment$outboundSchema).optional(),
1552
+ self: z.lazy(() => ListAllRefundsRefundSelf$outboundSchema),
1553
+ payment: z.lazy(() => ListAllRefundsPayment$outboundSchema),
1561
1554
  settlement: z.nullable(z.lazy(() => ListAllRefundsSettlement$outboundSchema))
1562
1555
  .optional(),
1563
- documentation: z.lazy(() => ListAllRefundsRefundDocumentation$outboundSchema)
1564
- .optional(),
1556
+ documentation: z.lazy(() => ListAllRefundsRefundDocumentation$outboundSchema),
1565
1557
  });
1566
1558
 
1567
1559
  /**
@@ -1601,7 +1593,7 @@ export const ListAllRefundsRefund$inboundSchema: z.ZodType<
1601
1593
  z.ZodTypeDef,
1602
1594
  unknown
1603
1595
  > = z.object({
1604
- resource: z.string().default("refund"),
1596
+ resource: z.string().optional(),
1605
1597
  id: z.string().optional(),
1606
1598
  mode: ListAllRefundsMode$inboundSchema.optional(),
1607
1599
  description: z.string().optional(),
@@ -1634,7 +1626,7 @@ export const ListAllRefundsRefund$inboundSchema: z.ZodType<
1634
1626
 
1635
1627
  /** @internal */
1636
1628
  export type ListAllRefundsRefund$Outbound = {
1637
- resource: string;
1629
+ resource?: string | undefined;
1638
1630
  id?: string | undefined;
1639
1631
  mode?: string | undefined;
1640
1632
  description?: string | undefined;
@@ -1664,7 +1656,7 @@ export const ListAllRefundsRefund$outboundSchema: z.ZodType<
1664
1656
  z.ZodTypeDef,
1665
1657
  ListAllRefundsRefund
1666
1658
  > = z.object({
1667
- resource: z.string().default("refund"),
1659
+ resource: z.string().optional(),
1668
1660
  id: z.string().optional(),
1669
1661
  mode: ListAllRefundsMode$outboundSchema.optional(),
1670
1662
  description: z.string().optional(),