@flintpay/node 0.2.0-beta.1 → 0.2.0-beta.2

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 (1001) hide show
  1. package/README.md +114 -35
  2. package/REFERENCE.md +1 -1
  3. package/RUNTIME.md +69 -0
  4. package/contract.d.ts +1 -0
  5. package/examples/api-addOrderCharge.mjs +22 -14
  6. package/examples/api-addOrderCharge.ts +22 -14
  7. package/examples/api-addOrderLineItems.mjs +19 -11
  8. package/examples/api-addOrderLineItems.ts +19 -11
  9. package/examples/api-addReturnLineItem.mjs +19 -11
  10. package/examples/api-addReturnLineItem.ts +19 -11
  11. package/examples/api-addRiskListItems.mjs +12 -8
  12. package/examples/api-addRiskListItems.ts +12 -8
  13. package/examples/api-advanceOnboarding.mjs +12 -4
  14. package/examples/api-advanceOnboarding.ts +12 -4
  15. package/examples/api-applyInventoryCount.mjs +14 -6
  16. package/examples/api-applyInventoryCount.ts +14 -6
  17. package/examples/api-applyOrderDiscount.mjs +17 -9
  18. package/examples/api-applyOrderDiscount.ts +17 -9
  19. package/examples/api-approveReview.mjs +12 -4
  20. package/examples/api-approveReview.ts +12 -4
  21. package/examples/api-assignToUnconfiguredDeliveryProfile.mjs +12 -5
  22. package/examples/api-assignToUnconfiguredDeliveryProfile.ts +12 -5
  23. package/examples/api-authorizePartnerInstall.mjs +14 -8
  24. package/examples/api-authorizePartnerInstall.ts +14 -8
  25. package/examples/api-cancelInventoryCount.mjs +14 -6
  26. package/examples/api-cancelInventoryCount.ts +14 -6
  27. package/examples/api-cancelInvoicePaymentAttempt.mjs +13 -5
  28. package/examples/api-cancelInvoicePaymentAttempt.ts +13 -5
  29. package/examples/api-cancelMeReturn.mjs +15 -7
  30. package/examples/api-cancelMeReturn.ts +15 -7
  31. package/examples/api-cancelMeSubscription.mjs +13 -5
  32. package/examples/api-cancelMeSubscription.ts +13 -5
  33. package/examples/api-cancelOrderPayment.mjs +13 -5
  34. package/examples/api-cancelOrderPayment.ts +13 -5
  35. package/examples/api-cancelOrderPaymentAttempt.mjs +13 -5
  36. package/examples/api-cancelOrderPaymentAttempt.ts +13 -5
  37. package/examples/api-cancelPaymentIntent.mjs +13 -5
  38. package/examples/api-cancelPaymentIntent.ts +13 -5
  39. package/examples/api-cancelPayout.mjs +13 -5
  40. package/examples/api-cancelPayout.ts +13 -5
  41. package/examples/api-cancelReturn.mjs +15 -7
  42. package/examples/api-cancelReturn.ts +15 -7
  43. package/examples/api-cancelReturnDisposition.mjs +15 -7
  44. package/examples/api-cancelReturnDisposition.ts +15 -7
  45. package/examples/api-cancelReturnLineItem.mjs +18 -10
  46. package/examples/api-cancelReturnLineItem.ts +18 -10
  47. package/examples/api-cancelReturnResolution.mjs +15 -7
  48. package/examples/api-cancelReturnResolution.ts +15 -7
  49. package/examples/api-cancelSubscription.mjs +13 -5
  50. package/examples/api-cancelSubscription.ts +13 -5
  51. package/examples/api-captureOrderPayment.mjs +13 -5
  52. package/examples/api-captureOrderPayment.ts +13 -5
  53. package/examples/api-capturePaymentIntent.mjs +13 -5
  54. package/examples/api-capturePaymentIntent.ts +13 -5
  55. package/examples/api-changeMeSubscriptionPaymentMethod.mjs +15 -7
  56. package/examples/api-changeMeSubscriptionPaymentMethod.ts +15 -7
  57. package/examples/api-changeSubscriptionPaymentMethod.mjs +15 -7
  58. package/examples/api-changeSubscriptionPaymentMethod.ts +15 -7
  59. package/examples/api-checkDeliveryRateCallbackConnection.mjs +12 -4
  60. package/examples/api-checkDeliveryRateCallbackConnection.ts +12 -4
  61. package/examples/api-closeCheckoutSession.mjs +13 -5
  62. package/examples/api-closeCheckoutSession.ts +13 -5
  63. package/examples/api-closeOrder.mjs +13 -5
  64. package/examples/api-closeOrder.ts +13 -5
  65. package/examples/api-collectInvoice.mjs +14 -6
  66. package/examples/api-collectInvoice.ts +14 -6
  67. package/examples/api-commitInventoryReservation.mjs +16 -8
  68. package/examples/api-commitInventoryReservation.ts +16 -8
  69. package/examples/api-completeReturn.mjs +13 -5
  70. package/examples/api-completeReturn.ts +13 -5
  71. package/examples/api-confirmMeEmailChangeRequest.mjs +15 -7
  72. package/examples/api-confirmMeEmailChangeRequest.ts +15 -7
  73. package/examples/api-confirmPaymentIntent.mjs +13 -5
  74. package/examples/api-confirmPaymentIntent.ts +13 -5
  75. package/examples/api-confirmReturnResolution.mjs +13 -5
  76. package/examples/api-confirmReturnResolution.ts +13 -5
  77. package/examples/api-consumeInventoryReservation.mjs +17 -9
  78. package/examples/api-consumeInventoryReservation.ts +17 -9
  79. package/examples/api-createAPIKey.mjs +15 -7
  80. package/examples/api-createAPIKey.ts +15 -7
  81. package/examples/api-createBundle.mjs +18 -10
  82. package/examples/api-createBundle.ts +18 -10
  83. package/examples/api-createCategory.mjs +14 -6
  84. package/examples/api-createCategory.ts +14 -6
  85. package/examples/api-createCheckoutSession.mjs +14 -6
  86. package/examples/api-createCheckoutSession.ts +14 -6
  87. package/examples/api-createCheckoutSessionDeliveryQuote.mjs +13 -7
  88. package/examples/api-createCheckoutSessionDeliveryQuote.ts +13 -7
  89. package/examples/api-createCheckoutSessionDeliverySelection.mjs +15 -9
  90. package/examples/api-createCheckoutSessionDeliverySelection.ts +15 -9
  91. package/examples/api-createCreditNote.mjs +15 -7
  92. package/examples/api-createCreditNote.ts +15 -7
  93. package/examples/api-createCreditNoteAllocation.mjs +19 -11
  94. package/examples/api-createCreditNoteAllocation.ts +19 -11
  95. package/examples/api-createCustomer.mjs +13 -6
  96. package/examples/api-createCustomer.ts +13 -6
  97. package/examples/api-createCustomerAddress.mjs +21 -13
  98. package/examples/api-createCustomerAddress.ts +21 -13
  99. package/examples/api-createCustomerDeletionRequest.mjs +12 -4
  100. package/examples/api-createCustomerDeletionRequest.ts +12 -4
  101. package/examples/api-createCustomerSession.mjs +14 -6
  102. package/examples/api-createCustomerSession.ts +14 -6
  103. package/examples/api-createDeliveryLocationSet.mjs +17 -9
  104. package/examples/api-createDeliveryLocationSet.ts +17 -9
  105. package/examples/api-createDeliveryMethod.mjs +24 -16
  106. package/examples/api-createDeliveryMethod.ts +24 -16
  107. package/examples/api-createDeliveryPreview.mjs +18 -12
  108. package/examples/api-createDeliveryPreview.ts +18 -12
  109. package/examples/api-createDeliveryProfile.mjs +17 -9
  110. package/examples/api-createDeliveryProfile.ts +17 -9
  111. package/examples/api-createDeliveryRateCallback.mjs +17 -9
  112. package/examples/api-createDeliveryRateCallback.ts +17 -9
  113. package/examples/api-createDeliveryRateCallbackTestDelivery.mjs +12 -4
  114. package/examples/api-createDeliveryRateCallbackTestDelivery.ts +12 -4
  115. package/examples/api-createDeliveryZone.mjs +18 -12
  116. package/examples/api-createDeliveryZone.ts +18 -12
  117. package/examples/api-createDemoSession.mjs +11 -4
  118. package/examples/api-createDemoSession.ts +11 -4
  119. package/examples/api-createDeveloperPartnerApp.mjs +16 -8
  120. package/examples/api-createDeveloperPartnerApp.ts +16 -8
  121. package/examples/api-createDeveloperSandbox.mjs +14 -6
  122. package/examples/api-createDeveloperSandbox.ts +14 -6
  123. package/examples/api-createDevice.mjs +14 -6
  124. package/examples/api-createDevice.ts +14 -6
  125. package/examples/api-createFeedbackReport.mjs +15 -8
  126. package/examples/api-createFeedbackReport.ts +15 -8
  127. package/examples/api-createFulfillment.mjs +21 -13
  128. package/examples/api-createFulfillment.ts +21 -13
  129. package/examples/api-createFulfillmentEvent.mjs +15 -7
  130. package/examples/api-createFulfillmentEvent.ts +15 -7
  131. package/examples/api-createInventoryAdjustment.mjs +15 -8
  132. package/examples/api-createInventoryAdjustment.ts +15 -8
  133. package/examples/api-createInventoryAllocationPolicy.mjs +23 -15
  134. package/examples/api-createInventoryAllocationPolicy.ts +23 -15
  135. package/examples/api-createInventoryCount.mjs +16 -10
  136. package/examples/api-createInventoryCount.ts +16 -10
  137. package/examples/api-createInventoryItem.mjs +14 -6
  138. package/examples/api-createInventoryItem.ts +14 -6
  139. package/examples/api-createInventoryReceipt.mjs +14 -7
  140. package/examples/api-createInventoryReceipt.ts +14 -7
  141. package/examples/api-createInventoryReservation.mjs +22 -14
  142. package/examples/api-createInventoryReservation.ts +22 -14
  143. package/examples/api-createInventoryTransfer.mjs +22 -14
  144. package/examples/api-createInventoryTransfer.ts +22 -14
  145. package/examples/api-createInvoice.mjs +14 -6
  146. package/examples/api-createInvoice.ts +14 -6
  147. package/examples/api-createInvoicePaymentTerm.mjs +17 -9
  148. package/examples/api-createInvoicePaymentTerm.ts +17 -9
  149. package/examples/api-createLocation.mjs +16 -8
  150. package/examples/api-createLocation.ts +16 -8
  151. package/examples/api-createMeAddress.mjs +20 -12
  152. package/examples/api-createMeAddress.ts +20 -12
  153. package/examples/api-createMeDeletionRequest.mjs +10 -2
  154. package/examples/api-createMeDeletionRequest.ts +10 -2
  155. package/examples/api-createMeEmailChangeRequest.mjs +14 -6
  156. package/examples/api-createMeEmailChangeRequest.ts +14 -6
  157. package/examples/api-createMeInvoiceCheckoutSession.mjs +12 -4
  158. package/examples/api-createMeInvoiceCheckoutSession.ts +12 -4
  159. package/examples/api-createMeReturn.mjs +21 -13
  160. package/examples/api-createMeReturn.ts +21 -13
  161. package/examples/api-createMeReturnPreview.mjs +18 -12
  162. package/examples/api-createMeReturnPreview.ts +18 -12
  163. package/examples/api-createMeReturnResolutionCheckoutSession.mjs +12 -4
  164. package/examples/api-createMeReturnResolutionCheckoutSession.ts +12 -4
  165. package/examples/api-createMerchantAccountSession.mjs +12 -8
  166. package/examples/api-createMerchantAccountSession.ts +12 -8
  167. package/examples/api-createModifierGroup.mjs +14 -6
  168. package/examples/api-createModifierGroup.ts +14 -6
  169. package/examples/api-createModifierSet.mjs +14 -6
  170. package/examples/api-createModifierSet.ts +14 -6
  171. package/examples/api-createOnboardingAPIKey.mjs +14 -6
  172. package/examples/api-createOnboardingAPIKey.ts +14 -6
  173. package/examples/api-createOrder.mjs +18 -10
  174. package/examples/api-createOrder.ts +18 -10
  175. package/examples/api-createOrderPaymentIntent.mjs +13 -5
  176. package/examples/api-createOrderPaymentIntent.ts +13 -5
  177. package/examples/api-createOrganization.mjs +14 -6
  178. package/examples/api-createOrganization.ts +14 -6
  179. package/examples/api-createPackage.mjs +13 -5
  180. package/examples/api-createPackage.ts +13 -5
  181. package/examples/api-createPackageItem.mjs +16 -8
  182. package/examples/api-createPackageItem.ts +16 -8
  183. package/examples/api-createPaymentIntent.mjs +17 -11
  184. package/examples/api-createPaymentIntent.ts +17 -11
  185. package/examples/api-createPaymentLink.mjs +14 -6
  186. package/examples/api-createPaymentLink.ts +14 -6
  187. package/examples/api-createPaymentMethodDomain.mjs +14 -6
  188. package/examples/api-createPaymentMethodDomain.ts +14 -6
  189. package/examples/api-createPayout.mjs +17 -9
  190. package/examples/api-createPayout.ts +17 -9
  191. package/examples/api-createProduct.mjs +21 -13
  192. package/examples/api-createProduct.ts +21 -13
  193. package/examples/api-createProductVariant.mjs +20 -12
  194. package/examples/api-createProductVariant.ts +20 -12
  195. package/examples/api-createPromotion.mjs +16 -8
  196. package/examples/api-createPromotion.ts +16 -8
  197. package/examples/api-createPromotionCode.mjs +15 -7
  198. package/examples/api-createPromotionCode.ts +15 -7
  199. package/examples/api-createRefund.mjs +14 -6
  200. package/examples/api-createRefund.ts +14 -6
  201. package/examples/api-createReport.mjs +17 -9
  202. package/examples/api-createReport.ts +17 -9
  203. package/examples/api-createReturn.mjs +21 -13
  204. package/examples/api-createReturn.ts +21 -13
  205. package/examples/api-createReturnDisposition.mjs +19 -11
  206. package/examples/api-createReturnDisposition.ts +19 -11
  207. package/examples/api-createReturnInspection.mjs +25 -17
  208. package/examples/api-createReturnInspection.ts +25 -17
  209. package/examples/api-createReturnPolicy.mjs +21 -13
  210. package/examples/api-createReturnPolicy.ts +21 -13
  211. package/examples/api-createReturnPreview.mjs +18 -12
  212. package/examples/api-createReturnPreview.ts +18 -12
  213. package/examples/api-createReturnReason.mjs +15 -7
  214. package/examples/api-createReturnReason.ts +15 -7
  215. package/examples/api-createReturnReceipt.mjs +22 -14
  216. package/examples/api-createReturnReceipt.ts +22 -14
  217. package/examples/api-createReturnResolution.mjs +20 -12
  218. package/examples/api-createReturnResolution.ts +20 -12
  219. package/examples/api-createRiskList.mjs +15 -8
  220. package/examples/api-createRiskList.ts +15 -8
  221. package/examples/api-createRiskPreview.mjs +12 -6
  222. package/examples/api-createRiskPreview.ts +12 -6
  223. package/examples/api-createRiskRule.mjs +19 -12
  224. package/examples/api-createRiskRule.ts +19 -12
  225. package/examples/api-createShipment.mjs +13 -5
  226. package/examples/api-createShipment.ts +13 -5
  227. package/examples/api-createSubscription.mjs +20 -12
  228. package/examples/api-createSubscription.ts +20 -12
  229. package/examples/api-createSubscriptionPaymentRetry.mjs +13 -5
  230. package/examples/api-createSubscriptionPaymentRetry.ts +13 -5
  231. package/examples/api-createSubscriptionPlan.mjs +17 -9
  232. package/examples/api-createSubscriptionPlan.ts +17 -9
  233. package/examples/api-createWebhookEndpoint.mjs +13 -6
  234. package/examples/api-createWebhookEndpoint.ts +13 -6
  235. package/examples/api-createWebhookTestEvent.mjs +15 -7
  236. package/examples/api-createWebhookTestEvent.ts +15 -7
  237. package/examples/api-decideReturn.mjs +21 -13
  238. package/examples/api-decideReturn.ts +21 -13
  239. package/examples/api-decideReturnInspectionLineItem.mjs +17 -9
  240. package/examples/api-decideReturnInspectionLineItem.ts +17 -9
  241. package/examples/api-declineReview.mjs +12 -4
  242. package/examples/api-declineReview.ts +12 -4
  243. package/examples/api-deleteBundle.mjs +12 -4
  244. package/examples/api-deleteBundle.ts +12 -4
  245. package/examples/api-deleteCategory.mjs +12 -4
  246. package/examples/api-deleteCategory.ts +12 -4
  247. package/examples/api-deleteCheckoutSessionCurrentDeliverySelection.mjs +11 -5
  248. package/examples/api-deleteCheckoutSessionCurrentDeliverySelection.ts +11 -5
  249. package/examples/api-deleteCustomerAddress.mjs +11 -5
  250. package/examples/api-deleteCustomerAddress.ts +11 -5
  251. package/examples/api-deleteDeliveryLocationSet.mjs +12 -4
  252. package/examples/api-deleteDeliveryLocationSet.ts +12 -4
  253. package/examples/api-deleteDeliveryMethod.mjs +12 -4
  254. package/examples/api-deleteDeliveryMethod.ts +12 -4
  255. package/examples/api-deleteDeliveryProfile.mjs +12 -4
  256. package/examples/api-deleteDeliveryProfile.ts +12 -4
  257. package/examples/api-deleteDeliveryRateCallback.mjs +12 -4
  258. package/examples/api-deleteDeliveryRateCallback.ts +12 -4
  259. package/examples/api-deleteDeliveryZone.mjs +12 -4
  260. package/examples/api-deleteDeliveryZone.ts +12 -4
  261. package/examples/api-deleteDeveloperSandbox.mjs +12 -4
  262. package/examples/api-deleteDeveloperSandbox.ts +12 -4
  263. package/examples/api-deleteDevice.mjs +12 -4
  264. package/examples/api-deleteDevice.ts +12 -4
  265. package/examples/api-deleteInventoryAllocationPolicy.mjs +12 -4
  266. package/examples/api-deleteInventoryAllocationPolicy.ts +12 -4
  267. package/examples/api-deleteInventoryItem.mjs +12 -4
  268. package/examples/api-deleteInventoryItem.ts +12 -4
  269. package/examples/api-deleteInvoicePaymentTerm.mjs +12 -4
  270. package/examples/api-deleteInvoicePaymentTerm.ts +12 -4
  271. package/examples/api-deleteLocation.mjs +12 -4
  272. package/examples/api-deleteLocation.ts +12 -4
  273. package/examples/api-deleteMeAddress.mjs +10 -4
  274. package/examples/api-deleteMeAddress.ts +10 -4
  275. package/examples/api-deleteModifierGroup.mjs +12 -4
  276. package/examples/api-deleteModifierGroup.ts +12 -4
  277. package/examples/api-deleteModifierSet.mjs +12 -4
  278. package/examples/api-deleteModifierSet.ts +12 -4
  279. package/examples/api-deleteOrderCharge.mjs +13 -5
  280. package/examples/api-deleteOrderCharge.ts +13 -5
  281. package/examples/api-deleteOrderLineItem.mjs +13 -5
  282. package/examples/api-deleteOrderLineItem.ts +13 -5
  283. package/examples/api-deleteOrganization.mjs +12 -4
  284. package/examples/api-deleteOrganization.ts +12 -4
  285. package/examples/api-deletePackageItem.mjs +13 -5
  286. package/examples/api-deletePackageItem.ts +13 -5
  287. package/examples/api-deletePayoutDestination.mjs +13 -5
  288. package/examples/api-deletePayoutDestination.ts +13 -5
  289. package/examples/api-deleteProduct.mjs +12 -4
  290. package/examples/api-deleteProduct.ts +12 -4
  291. package/examples/api-deleteProductVariant.mjs +13 -5
  292. package/examples/api-deleteProductVariant.ts +13 -5
  293. package/examples/api-deletePromotion.mjs +12 -4
  294. package/examples/api-deletePromotion.ts +12 -4
  295. package/examples/api-deletePromotionCode.mjs +13 -5
  296. package/examples/api-deletePromotionCode.ts +13 -5
  297. package/examples/api-deleteReturnLineItem.mjs +13 -5
  298. package/examples/api-deleteReturnLineItem.ts +13 -5
  299. package/examples/api-deleteReturnPolicy.mjs +12 -4
  300. package/examples/api-deleteReturnPolicy.ts +12 -4
  301. package/examples/api-deleteReturnReason.mjs +12 -4
  302. package/examples/api-deleteReturnReason.ts +12 -4
  303. package/examples/api-deleteRiskList.mjs +11 -4
  304. package/examples/api-deleteRiskList.ts +11 -4
  305. package/examples/api-deleteRiskListItem.mjs +13 -5
  306. package/examples/api-deleteRiskListItem.ts +13 -5
  307. package/examples/api-deleteRiskRule.mjs +11 -4
  308. package/examples/api-deleteRiskRule.ts +11 -4
  309. package/examples/api-deleteSubscriptionPlan.mjs +12 -4
  310. package/examples/api-deleteSubscriptionPlan.ts +12 -4
  311. package/examples/api-deleteWebhookEndpoint.mjs +10 -4
  312. package/examples/api-deleteWebhookEndpoint.ts +10 -4
  313. package/examples/api-exchangePartnerInstallToken.mjs +15 -8
  314. package/examples/api-exchangePartnerInstallToken.ts +15 -8
  315. package/examples/api-getAPIKey.mjs +12 -4
  316. package/examples/api-getAPIKey.ts +12 -4
  317. package/examples/api-getAnalyticsOverview.mjs +10 -4
  318. package/examples/api-getAnalyticsOverview.ts +10 -4
  319. package/examples/api-getBalanceTransaction.mjs +12 -4
  320. package/examples/api-getBalanceTransaction.ts +12 -4
  321. package/examples/api-getBundle.mjs +12 -4
  322. package/examples/api-getBundle.ts +12 -4
  323. package/examples/api-getCategory.mjs +12 -4
  324. package/examples/api-getCategory.ts +12 -4
  325. package/examples/api-getCheckoutSession.mjs +12 -4
  326. package/examples/api-getCheckoutSession.ts +12 -4
  327. package/examples/api-getCheckoutSessionCurrentDeliverySelection.mjs +10 -4
  328. package/examples/api-getCheckoutSessionCurrentDeliverySelection.ts +10 -4
  329. package/examples/api-getCheckoutSessionDeliveryQuote.mjs +11 -5
  330. package/examples/api-getCheckoutSessionDeliveryQuote.ts +11 -5
  331. package/examples/api-getCheckoutSessionDeliverySelectionHistory.mjs +13 -5
  332. package/examples/api-getCheckoutSessionDeliverySelectionHistory.ts +13 -5
  333. package/examples/api-getCreditNote.mjs +12 -4
  334. package/examples/api-getCreditNote.ts +12 -4
  335. package/examples/api-getCreditNoteAllocation.mjs +13 -5
  336. package/examples/api-getCreditNoteAllocation.ts +13 -5
  337. package/examples/api-getCreditNotePDF.mjs +10 -4
  338. package/examples/api-getCreditNotePDF.ts +10 -4
  339. package/examples/api-getCurrentAPIKeyRequestLog.mjs +12 -4
  340. package/examples/api-getCurrentAPIKeyRequestLog.ts +12 -4
  341. package/examples/api-getCustomer.mjs +11 -4
  342. package/examples/api-getCustomer.ts +11 -4
  343. package/examples/api-getCustomerAddress.mjs +13 -5
  344. package/examples/api-getCustomerAddress.ts +13 -5
  345. package/examples/api-getCustomerDeletionRequest.mjs +13 -5
  346. package/examples/api-getCustomerDeletionRequest.ts +13 -5
  347. package/examples/api-getDeliveryLocationSet.mjs +12 -4
  348. package/examples/api-getDeliveryLocationSet.ts +12 -4
  349. package/examples/api-getDeliveryMethod.mjs +12 -4
  350. package/examples/api-getDeliveryMethod.ts +12 -4
  351. package/examples/api-getDeliveryProfile.mjs +12 -4
  352. package/examples/api-getDeliveryProfile.ts +12 -4
  353. package/examples/api-getDeliveryRateCallback.mjs +12 -4
  354. package/examples/api-getDeliveryRateCallback.ts +12 -4
  355. package/examples/api-getDeliveryRevocation.mjs +11 -4
  356. package/examples/api-getDeliveryRevocation.ts +11 -4
  357. package/examples/api-getDeliveryZone.mjs +12 -4
  358. package/examples/api-getDeliveryZone.ts +12 -4
  359. package/examples/api-getDeveloperAuthContext.mjs +10 -2
  360. package/examples/api-getDeveloperAuthContext.ts +10 -2
  361. package/examples/api-getDeveloperPartnerApp.mjs +12 -4
  362. package/examples/api-getDeveloperPartnerApp.ts +12 -4
  363. package/examples/api-getDeveloperPartnerAppInstall.mjs +13 -5
  364. package/examples/api-getDeveloperPartnerAppInstall.ts +13 -5
  365. package/examples/api-getDeveloperSandbox.mjs +12 -4
  366. package/examples/api-getDeveloperSandbox.ts +12 -4
  367. package/examples/api-getDevice.mjs +12 -4
  368. package/examples/api-getDevice.ts +12 -4
  369. package/examples/api-getDispute.mjs +12 -4
  370. package/examples/api-getDispute.ts +12 -4
  371. package/examples/api-getEffectiveSettings.mjs +9 -2
  372. package/examples/api-getEffectiveSettings.ts +9 -2
  373. package/examples/api-getFeedbackReport.mjs +11 -4
  374. package/examples/api-getFeedbackReport.ts +11 -4
  375. package/examples/api-getFraudWarning.mjs +12 -4
  376. package/examples/api-getFraudWarning.ts +12 -4
  377. package/examples/api-getFulfillment.mjs +12 -4
  378. package/examples/api-getFulfillment.ts +12 -4
  379. package/examples/api-getFulfillmentEvent.mjs +12 -4
  380. package/examples/api-getFulfillmentEvent.ts +12 -4
  381. package/examples/api-getFulfillmentNotification.mjs +12 -4
  382. package/examples/api-getFulfillmentNotification.ts +12 -4
  383. package/examples/api-getInvoice.mjs +12 -4
  384. package/examples/api-getInvoice.ts +12 -4
  385. package/examples/api-getInvoicePDF.mjs +10 -4
  386. package/examples/api-getInvoicePDF.ts +10 -4
  387. package/examples/api-getInvoicePaymentAttempt.mjs +13 -5
  388. package/examples/api-getInvoicePaymentAttempt.ts +13 -5
  389. package/examples/api-getInvoicePaymentTerm.mjs +12 -4
  390. package/examples/api-getInvoicePaymentTerm.ts +12 -4
  391. package/examples/api-getLocation.mjs +12 -4
  392. package/examples/api-getLocation.ts +12 -4
  393. package/examples/api-getMe.mjs +9 -2
  394. package/examples/api-getMe.ts +9 -2
  395. package/examples/api-getMeAddress.mjs +12 -4
  396. package/examples/api-getMeAddress.ts +12 -4
  397. package/examples/api-getMeCreditNote.mjs +13 -5
  398. package/examples/api-getMeCreditNote.ts +13 -5
  399. package/examples/api-getMeCreditNotePDF.mjs +11 -5
  400. package/examples/api-getMeCreditNotePDF.ts +11 -5
  401. package/examples/api-getMeDeletionRequest.mjs +12 -4
  402. package/examples/api-getMeDeletionRequest.ts +12 -4
  403. package/examples/api-getMeInvoice.mjs +12 -4
  404. package/examples/api-getMeInvoice.ts +12 -4
  405. package/examples/api-getMeInvoicePDF.mjs +10 -4
  406. package/examples/api-getMeInvoicePDF.ts +10 -4
  407. package/examples/api-getMeOrder.mjs +12 -4
  408. package/examples/api-getMeOrder.ts +12 -4
  409. package/examples/api-getMeReturn.mjs +12 -4
  410. package/examples/api-getMeReturn.ts +12 -4
  411. package/examples/api-getMeSubscription.mjs +12 -4
  412. package/examples/api-getMeSubscription.ts +12 -4
  413. package/examples/api-getMerchant.mjs +12 -4
  414. package/examples/api-getMerchant.ts +12 -4
  415. package/examples/api-getMerchantBillingBalance.mjs +11 -4
  416. package/examples/api-getMerchantBillingBalance.ts +11 -4
  417. package/examples/api-getMerchantSubscriptionInvoice.mjs +12 -4
  418. package/examples/api-getMerchantSubscriptionInvoice.ts +12 -4
  419. package/examples/api-getModifierGroup.mjs +12 -4
  420. package/examples/api-getModifierGroup.ts +12 -4
  421. package/examples/api-getModifierSet.mjs +12 -4
  422. package/examples/api-getModifierSet.ts +12 -4
  423. package/examples/api-getOnboardingState.mjs +10 -2
  424. package/examples/api-getOnboardingState.ts +10 -2
  425. package/examples/api-getOpenAPISpec.mjs +7 -2
  426. package/examples/api-getOpenAPISpec.ts +7 -2
  427. package/examples/api-getOrCreateInvoiceCheckoutSession.mjs +12 -4
  428. package/examples/api-getOrCreateInvoiceCheckoutSession.ts +12 -4
  429. package/examples/api-getOrCreateReturnResolutionCheckoutSession.mjs +12 -4
  430. package/examples/api-getOrCreateReturnResolutionCheckoutSession.ts +12 -4
  431. package/examples/api-getOrder.mjs +12 -4
  432. package/examples/api-getOrder.ts +12 -4
  433. package/examples/api-getOrderCurrentDeliverySelection.mjs +12 -4
  434. package/examples/api-getOrderCurrentDeliverySelection.ts +12 -4
  435. package/examples/api-getOrderPaymentAttempt.mjs +13 -5
  436. package/examples/api-getOrderPaymentAttempt.ts +13 -5
  437. package/examples/api-getOrganization.mjs +12 -4
  438. package/examples/api-getOrganization.ts +12 -4
  439. package/examples/api-getPackage.mjs +12 -4
  440. package/examples/api-getPackage.ts +12 -4
  441. package/examples/api-getPackageItem.mjs +13 -5
  442. package/examples/api-getPackageItem.ts +13 -5
  443. package/examples/api-getPaymentIntent.mjs +12 -4
  444. package/examples/api-getPaymentIntent.ts +12 -4
  445. package/examples/api-getPaymentLink.mjs +12 -4
  446. package/examples/api-getPaymentLink.ts +12 -4
  447. package/examples/api-getPaymentLinkPublic.mjs +11 -4
  448. package/examples/api-getPaymentLinkPublic.ts +11 -4
  449. package/examples/api-getPaymentMethod.mjs +12 -4
  450. package/examples/api-getPaymentMethod.ts +12 -4
  451. package/examples/api-getPaymentMethodDomain.mjs +12 -4
  452. package/examples/api-getPaymentMethodDomain.ts +12 -4
  453. package/examples/api-getPaymentVolumeTimeseries.mjs +10 -4
  454. package/examples/api-getPaymentVolumeTimeseries.ts +10 -4
  455. package/examples/api-getPayout.mjs +12 -4
  456. package/examples/api-getPayout.ts +12 -4
  457. package/examples/api-getPayoutDestination.mjs +12 -4
  458. package/examples/api-getPayoutDestination.ts +12 -4
  459. package/examples/api-getPayoutSettings.mjs +10 -2
  460. package/examples/api-getPayoutSettings.ts +10 -2
  461. package/examples/api-getProduct.mjs +12 -4
  462. package/examples/api-getProduct.ts +12 -4
  463. package/examples/api-getProductOption.mjs +13 -5
  464. package/examples/api-getProductOption.ts +13 -5
  465. package/examples/api-getProductVariant.mjs +13 -5
  466. package/examples/api-getProductVariant.ts +13 -5
  467. package/examples/api-getPromotion.mjs +12 -4
  468. package/examples/api-getPromotion.ts +12 -4
  469. package/examples/api-getRefund.mjs +12 -4
  470. package/examples/api-getRefund.ts +12 -4
  471. package/examples/api-getReport.mjs +12 -4
  472. package/examples/api-getReport.ts +12 -4
  473. package/examples/api-getReportDownload.mjs +10 -4
  474. package/examples/api-getReportDownload.ts +10 -4
  475. package/examples/api-getResourceTimeline.mjs +11 -4
  476. package/examples/api-getResourceTimeline.ts +11 -4
  477. package/examples/api-getReturn.mjs +12 -4
  478. package/examples/api-getReturn.ts +12 -4
  479. package/examples/api-getReturnDisposition.mjs +12 -4
  480. package/examples/api-getReturnDisposition.ts +12 -4
  481. package/examples/api-getReturnInspection.mjs +12 -4
  482. package/examples/api-getReturnInspection.ts +12 -4
  483. package/examples/api-getReturnLineItem.mjs +13 -5
  484. package/examples/api-getReturnLineItem.ts +13 -5
  485. package/examples/api-getReturnPolicy.mjs +12 -4
  486. package/examples/api-getReturnPolicy.ts +12 -4
  487. package/examples/api-getReturnPolicyRevision.mjs +13 -5
  488. package/examples/api-getReturnPolicyRevision.ts +13 -5
  489. package/examples/api-getReturnReason.mjs +12 -4
  490. package/examples/api-getReturnReason.ts +12 -4
  491. package/examples/api-getReturnReceipt.mjs +12 -4
  492. package/examples/api-getReturnReceipt.ts +12 -4
  493. package/examples/api-getReturnResolution.mjs +12 -4
  494. package/examples/api-getReturnResolution.ts +12 -4
  495. package/examples/api-getReview.mjs +12 -4
  496. package/examples/api-getReview.ts +12 -4
  497. package/examples/api-getRiskList.mjs +11 -4
  498. package/examples/api-getRiskList.ts +11 -4
  499. package/examples/api-getRiskListItem.mjs +13 -5
  500. package/examples/api-getRiskListItem.ts +13 -5
  501. package/examples/api-getRiskRule.mjs +11 -4
  502. package/examples/api-getRiskRule.ts +11 -4
  503. package/examples/api-getRiskRuleAttributeRegistry.mjs +8 -2
  504. package/examples/api-getRiskRuleAttributeRegistry.ts +8 -2
  505. package/examples/api-getSettings.mjs +9 -2
  506. package/examples/api-getSettings.ts +9 -2
  507. package/examples/api-getShipment.mjs +12 -4
  508. package/examples/api-getShipment.ts +12 -4
  509. package/examples/api-getSubscription.mjs +12 -4
  510. package/examples/api-getSubscription.ts +12 -4
  511. package/examples/api-getSubscriptionAnalytics.mjs +10 -4
  512. package/examples/api-getSubscriptionAnalytics.ts +10 -4
  513. package/examples/api-getSubscriptionPaymentRetry.mjs +13 -5
  514. package/examples/api-getSubscriptionPaymentRetry.ts +13 -5
  515. package/examples/api-getSubscriptionPlan.mjs +12 -4
  516. package/examples/api-getSubscriptionPlan.ts +12 -4
  517. package/examples/api-getWebhookDelivery.mjs +12 -4
  518. package/examples/api-getWebhookDelivery.ts +12 -4
  519. package/examples/api-getWebhookEndpoint.mjs +11 -4
  520. package/examples/api-getWebhookEndpoint.ts +11 -4
  521. package/examples/api-getWebhookEvent.mjs +11 -4
  522. package/examples/api-getWebhookEvent.ts +11 -4
  523. package/examples/api-grantOrganizationMembership.mjs +16 -8
  524. package/examples/api-grantOrganizationMembership.ts +16 -8
  525. package/examples/api-issueCreditNote.mjs +12 -4
  526. package/examples/api-issueCreditNote.ts +12 -4
  527. package/examples/api-issueDeveloperSandboxTestKey.mjs +15 -7
  528. package/examples/api-issueDeveloperSandboxTestKey.ts +15 -7
  529. package/examples/api-issueInvoice.mjs +13 -5
  530. package/examples/api-issueInvoice.ts +13 -5
  531. package/examples/api-listAPIKeys.mjs +8 -2
  532. package/examples/api-listAPIKeys.ts +8 -2
  533. package/examples/api-listBalanceTransactions.mjs +8 -2
  534. package/examples/api-listBalanceTransactions.ts +8 -2
  535. package/examples/api-listBalances.mjs +8 -2
  536. package/examples/api-listBalances.ts +8 -2
  537. package/examples/api-listBundleComponents.mjs +10 -4
  538. package/examples/api-listBundleComponents.ts +10 -4
  539. package/examples/api-listBundles.mjs +8 -2
  540. package/examples/api-listBundles.ts +8 -2
  541. package/examples/api-listCapabilities.mjs +8 -2
  542. package/examples/api-listCapabilities.ts +8 -2
  543. package/examples/api-listCategories.mjs +8 -2
  544. package/examples/api-listCategories.ts +8 -2
  545. package/examples/api-listCheckoutSessions.mjs +8 -2
  546. package/examples/api-listCheckoutSessions.ts +8 -2
  547. package/examples/api-listCreditNoteAllocations.mjs +10 -4
  548. package/examples/api-listCreditNoteAllocations.ts +10 -4
  549. package/examples/api-listCreditNotes.mjs +8 -2
  550. package/examples/api-listCreditNotes.ts +8 -2
  551. package/examples/api-listCurrentAPIKeyRequestLogs.mjs +8 -2
  552. package/examples/api-listCurrentAPIKeyRequestLogs.ts +8 -2
  553. package/examples/api-listCustomerAddresses.mjs +10 -4
  554. package/examples/api-listCustomerAddresses.ts +10 -4
  555. package/examples/api-listCustomerDeletionRequests.mjs +8 -2
  556. package/examples/api-listCustomerDeletionRequests.ts +8 -2
  557. package/examples/api-listCustomers.mjs +8 -2
  558. package/examples/api-listCustomers.ts +8 -2
  559. package/examples/api-listDeliveryLocationSets.mjs +8 -2
  560. package/examples/api-listDeliveryLocationSets.ts +8 -2
  561. package/examples/api-listDeliveryMethods.mjs +8 -2
  562. package/examples/api-listDeliveryMethods.ts +8 -2
  563. package/examples/api-listDeliveryProfiles.mjs +8 -2
  564. package/examples/api-listDeliveryProfiles.ts +8 -2
  565. package/examples/api-listDeliveryQuotes.mjs +8 -2
  566. package/examples/api-listDeliveryQuotes.ts +8 -2
  567. package/examples/api-listDeliveryRateCallbacks.mjs +8 -2
  568. package/examples/api-listDeliveryRateCallbacks.ts +8 -2
  569. package/examples/api-listDeliveryZones.mjs +8 -2
  570. package/examples/api-listDeliveryZones.ts +8 -2
  571. package/examples/api-listDeveloperPartnerAppInstalls.mjs +10 -4
  572. package/examples/api-listDeveloperPartnerAppInstalls.ts +10 -4
  573. package/examples/api-listDeveloperPartnerApps.mjs +8 -2
  574. package/examples/api-listDeveloperPartnerApps.ts +8 -2
  575. package/examples/api-listDeveloperSandboxes.mjs +8 -2
  576. package/examples/api-listDeveloperSandboxes.ts +8 -2
  577. package/examples/api-listDevices.mjs +8 -2
  578. package/examples/api-listDevices.ts +8 -2
  579. package/examples/api-listDisputes.mjs +8 -2
  580. package/examples/api-listDisputes.ts +8 -2
  581. package/examples/api-listFeedbackReports.mjs +8 -2
  582. package/examples/api-listFeedbackReports.ts +8 -2
  583. package/examples/api-listFraudWarnings.mjs +8 -2
  584. package/examples/api-listFraudWarnings.ts +8 -2
  585. package/examples/api-listFulfillmentEvents.mjs +8 -2
  586. package/examples/api-listFulfillmentEvents.ts +8 -2
  587. package/examples/api-listFulfillmentNotifications.mjs +8 -2
  588. package/examples/api-listFulfillmentNotifications.ts +8 -2
  589. package/examples/api-listFulfillments.mjs +8 -2
  590. package/examples/api-listFulfillments.ts +8 -2
  591. package/examples/api-listInventoryAdjustments.mjs +8 -2
  592. package/examples/api-listInventoryAdjustments.ts +8 -2
  593. package/examples/api-listInventoryAllocationPolicies.mjs +8 -2
  594. package/examples/api-listInventoryAllocationPolicies.ts +8 -2
  595. package/examples/api-listInventoryCounts.mjs +8 -2
  596. package/examples/api-listInventoryCounts.ts +8 -2
  597. package/examples/api-listInventoryItems.mjs +8 -2
  598. package/examples/api-listInventoryItems.ts +8 -2
  599. package/examples/api-listInventoryLevels.mjs +8 -2
  600. package/examples/api-listInventoryLevels.ts +8 -2
  601. package/examples/api-listInventoryMovements.mjs +8 -2
  602. package/examples/api-listInventoryMovements.ts +8 -2
  603. package/examples/api-listInventoryReceipts.mjs +8 -2
  604. package/examples/api-listInventoryReceipts.ts +8 -2
  605. package/examples/api-listInventoryReservations.mjs +8 -2
  606. package/examples/api-listInventoryReservations.ts +8 -2
  607. package/examples/api-listInventoryTransfers.mjs +8 -2
  608. package/examples/api-listInventoryTransfers.ts +8 -2
  609. package/examples/api-listInvoiceDeliveryAttempts.mjs +10 -4
  610. package/examples/api-listInvoiceDeliveryAttempts.ts +10 -4
  611. package/examples/api-listInvoiceEvents.mjs +10 -4
  612. package/examples/api-listInvoiceEvents.ts +10 -4
  613. package/examples/api-listInvoicePaymentAttempts.mjs +10 -4
  614. package/examples/api-listInvoicePaymentAttempts.ts +10 -4
  615. package/examples/api-listInvoicePaymentTerms.mjs +8 -2
  616. package/examples/api-listInvoicePaymentTerms.ts +8 -2
  617. package/examples/api-listInvoices.mjs +8 -2
  618. package/examples/api-listInvoices.ts +8 -2
  619. package/examples/api-listLocations.mjs +8 -2
  620. package/examples/api-listLocations.ts +8 -2
  621. package/examples/api-listMeAddresses.mjs +8 -2
  622. package/examples/api-listMeAddresses.ts +8 -2
  623. package/examples/api-listMeCreditNotes.mjs +10 -4
  624. package/examples/api-listMeCreditNotes.ts +10 -4
  625. package/examples/api-listMeFulfillments.mjs +8 -2
  626. package/examples/api-listMeFulfillments.ts +8 -2
  627. package/examples/api-listMeInvoices.mjs +8 -2
  628. package/examples/api-listMeInvoices.ts +8 -2
  629. package/examples/api-listMeOrderActivities.mjs +10 -4
  630. package/examples/api-listMeOrderActivities.ts +10 -4
  631. package/examples/api-listMeOrders.mjs +8 -2
  632. package/examples/api-listMeOrders.ts +8 -2
  633. package/examples/api-listMePackages.mjs +8 -2
  634. package/examples/api-listMePackages.ts +8 -2
  635. package/examples/api-listMePaymentMethods.mjs +8 -2
  636. package/examples/api-listMePaymentMethods.ts +8 -2
  637. package/examples/api-listMePayments.mjs +8 -2
  638. package/examples/api-listMePayments.ts +8 -2
  639. package/examples/api-listMeRefunds.mjs +8 -2
  640. package/examples/api-listMeRefunds.ts +8 -2
  641. package/examples/api-listMeReturns.mjs +8 -2
  642. package/examples/api-listMeReturns.ts +8 -2
  643. package/examples/api-listMeShipments.mjs +8 -2
  644. package/examples/api-listMeShipments.ts +8 -2
  645. package/examples/api-listMeSubscriptions.mjs +8 -2
  646. package/examples/api-listMeSubscriptions.ts +8 -2
  647. package/examples/api-listMerchantBillingBalances.mjs +8 -2
  648. package/examples/api-listMerchantBillingBalances.ts +8 -2
  649. package/examples/api-listMerchantSubscriptionInvoices.mjs +8 -2
  650. package/examples/api-listMerchantSubscriptionInvoices.ts +8 -2
  651. package/examples/api-listModifierGroups.mjs +8 -2
  652. package/examples/api-listModifierGroups.ts +8 -2
  653. package/examples/api-listModifierSets.mjs +8 -2
  654. package/examples/api-listModifierSets.ts +8 -2
  655. package/examples/api-listOrderActivities.mjs +10 -4
  656. package/examples/api-listOrderActivities.ts +10 -4
  657. package/examples/api-listOrderPaymentAttempts.mjs +10 -4
  658. package/examples/api-listOrderPaymentAttempts.ts +10 -4
  659. package/examples/api-listOrders.mjs +8 -2
  660. package/examples/api-listOrders.ts +8 -2
  661. package/examples/api-listOrganizationMemberships.mjs +10 -4
  662. package/examples/api-listOrganizationMemberships.ts +10 -4
  663. package/examples/api-listOrganizations.mjs +8 -2
  664. package/examples/api-listOrganizations.ts +8 -2
  665. package/examples/api-listPackageItems.mjs +10 -4
  666. package/examples/api-listPackageItems.ts +10 -4
  667. package/examples/api-listPackages.mjs +8 -2
  668. package/examples/api-listPackages.ts +8 -2
  669. package/examples/api-listPaymentIntents.mjs +8 -2
  670. package/examples/api-listPaymentIntents.ts +8 -2
  671. package/examples/api-listPaymentLinks.mjs +8 -2
  672. package/examples/api-listPaymentLinks.ts +8 -2
  673. package/examples/api-listPaymentMethodDomains.mjs +8 -2
  674. package/examples/api-listPaymentMethodDomains.ts +8 -2
  675. package/examples/api-listPaymentMethods.mjs +8 -2
  676. package/examples/api-listPaymentMethods.ts +8 -2
  677. package/examples/api-listPayoutDestinations.mjs +8 -2
  678. package/examples/api-listPayoutDestinations.ts +8 -2
  679. package/examples/api-listPayoutEntries.mjs +10 -4
  680. package/examples/api-listPayoutEntries.ts +10 -4
  681. package/examples/api-listPayouts.mjs +8 -2
  682. package/examples/api-listPayouts.ts +8 -2
  683. package/examples/api-listProductOptions.mjs +10 -4
  684. package/examples/api-listProductOptions.ts +10 -4
  685. package/examples/api-listProductVariants.mjs +10 -4
  686. package/examples/api-listProductVariants.ts +10 -4
  687. package/examples/api-listProducts.mjs +8 -2
  688. package/examples/api-listProducts.ts +8 -2
  689. package/examples/api-listPromotionCodes.mjs +10 -4
  690. package/examples/api-listPromotionCodes.ts +10 -4
  691. package/examples/api-listPromotions.mjs +8 -2
  692. package/examples/api-listPromotions.ts +8 -2
  693. package/examples/api-listRefunds.mjs +8 -2
  694. package/examples/api-listRefunds.ts +8 -2
  695. package/examples/api-listReports.mjs +8 -2
  696. package/examples/api-listReports.ts +8 -2
  697. package/examples/api-listReturnDispositions.mjs +8 -2
  698. package/examples/api-listReturnDispositions.ts +8 -2
  699. package/examples/api-listReturnInspections.mjs +8 -2
  700. package/examples/api-listReturnInspections.ts +8 -2
  701. package/examples/api-listReturnLineItems.mjs +10 -4
  702. package/examples/api-listReturnLineItems.ts +10 -4
  703. package/examples/api-listReturnPolicies.mjs +8 -2
  704. package/examples/api-listReturnPolicies.ts +8 -2
  705. package/examples/api-listReturnPolicyRevisions.mjs +10 -4
  706. package/examples/api-listReturnPolicyRevisions.ts +10 -4
  707. package/examples/api-listReturnReasons.mjs +8 -2
  708. package/examples/api-listReturnReasons.ts +8 -2
  709. package/examples/api-listReturnReceipts.mjs +8 -2
  710. package/examples/api-listReturnReceipts.ts +8 -2
  711. package/examples/api-listReturnResolutions.mjs +8 -2
  712. package/examples/api-listReturnResolutions.ts +8 -2
  713. package/examples/api-listReturns.mjs +8 -2
  714. package/examples/api-listReturns.ts +8 -2
  715. package/examples/api-listReviews.mjs +8 -2
  716. package/examples/api-listReviews.ts +8 -2
  717. package/examples/api-listRiskListItems.mjs +10 -4
  718. package/examples/api-listRiskListItems.ts +10 -4
  719. package/examples/api-listRiskLists.mjs +8 -2
  720. package/examples/api-listRiskLists.ts +8 -2
  721. package/examples/api-listRiskRules.mjs +8 -2
  722. package/examples/api-listRiskRules.ts +8 -2
  723. package/examples/api-listShipments.mjs +8 -2
  724. package/examples/api-listShipments.ts +8 -2
  725. package/examples/api-listSubscriptionPaymentRetries.mjs +10 -4
  726. package/examples/api-listSubscriptionPaymentRetries.ts +10 -4
  727. package/examples/api-listSubscriptionPlans.mjs +8 -2
  728. package/examples/api-listSubscriptionPlans.ts +8 -2
  729. package/examples/api-listSubscriptions.mjs +8 -2
  730. package/examples/api-listSubscriptions.ts +8 -2
  731. package/examples/api-listWebhookDeliveries.mjs +10 -4
  732. package/examples/api-listWebhookDeliveries.ts +10 -4
  733. package/examples/api-listWebhookDeliveryAttempts.mjs +10 -4
  734. package/examples/api-listWebhookDeliveryAttempts.ts +10 -4
  735. package/examples/api-listWebhookEndpoints.mjs +8 -2
  736. package/examples/api-listWebhookEndpoints.ts +8 -2
  737. package/examples/api-listWebhookEventTypes.mjs +8 -2
  738. package/examples/api-listWebhookEventTypes.ts +8 -2
  739. package/examples/api-listWebhookEvents.mjs +8 -2
  740. package/examples/api-listWebhookEvents.ts +8 -2
  741. package/examples/api-markInvoiceUncollectible.mjs +12 -4
  742. package/examples/api-markInvoiceUncollectible.ts +12 -4
  743. package/examples/api-pauseInvoiceReminders.mjs +12 -4
  744. package/examples/api-pauseInvoiceReminders.ts +12 -4
  745. package/examples/api-pauseMeSubscription.mjs +13 -5
  746. package/examples/api-pauseMeSubscription.ts +13 -5
  747. package/examples/api-pauseSubscription.mjs +13 -5
  748. package/examples/api-pauseSubscription.ts +13 -5
  749. package/examples/api-payOrder.mjs +15 -7
  750. package/examples/api-payOrder.ts +15 -7
  751. package/examples/api-previewOrderDiscounts.mjs +10 -4
  752. package/examples/api-previewOrderDiscounts.ts +10 -4
  753. package/examples/api-previewPartnerInstallAuthorization.mjs +13 -6
  754. package/examples/api-previewPartnerInstallAuthorization.ts +13 -6
  755. package/examples/api-processExistingReturn.mjs +20 -12
  756. package/examples/api-processExistingReturn.ts +20 -12
  757. package/examples/api-publishLocationGeography.mjs +17 -9
  758. package/examples/api-publishLocationGeography.ts +17 -9
  759. package/examples/api-publishReturnPolicyRevision.mjs +22 -14
  760. package/examples/api-publishReturnPolicyRevision.ts +22 -14
  761. package/examples/api-queryCheckoutSessionPickupAvailability.mjs +11 -5
  762. package/examples/api-queryCheckoutSessionPickupAvailability.ts +11 -5
  763. package/examples/api-reactivateMeSubscription.mjs +12 -4
  764. package/examples/api-reactivateMeSubscription.ts +12 -4
  765. package/examples/api-reactivateSubscription.mjs +12 -4
  766. package/examples/api-reactivateSubscription.ts +12 -4
  767. package/examples/api-recordManualInvoicePayment.mjs +18 -10
  768. package/examples/api-recordManualInvoicePayment.ts +18 -10
  769. package/examples/api-refreshCustomerSession.mjs +14 -7
  770. package/examples/api-refreshCustomerSession.ts +14 -7
  771. package/examples/api-refreshMerchantAccountSession.mjs +12 -6
  772. package/examples/api-refreshMerchantAccountSession.ts +12 -6
  773. package/examples/api-regenerateInvoicePublicLink.mjs +12 -4
  774. package/examples/api-regenerateInvoicePublicLink.ts +12 -4
  775. package/examples/api-releaseInventoryReservation.mjs +16 -8
  776. package/examples/api-releaseInventoryReservation.ts +16 -8
  777. package/examples/api-releaseReturnResolution.mjs +15 -7
  778. package/examples/api-releaseReturnResolution.ts +15 -7
  779. package/examples/api-removeMePaymentMethod.mjs +10 -4
  780. package/examples/api-removeMePaymentMethod.ts +10 -4
  781. package/examples/api-removeOrderDiscounts.mjs +15 -7
  782. package/examples/api-removeOrderDiscounts.ts +15 -7
  783. package/examples/api-removePaymentMethod.mjs +10 -4
  784. package/examples/api-removePaymentMethod.ts +10 -4
  785. package/examples/api-reopenReturn.mjs +15 -7
  786. package/examples/api-reopenReturn.ts +15 -7
  787. package/examples/api-repriceOrderDiscounts.mjs +12 -4
  788. package/examples/api-repriceOrderDiscounts.ts +12 -4
  789. package/examples/api-resendMeOrderReceipt.mjs +10 -4
  790. package/examples/api-resendMeOrderReceipt.ts +10 -4
  791. package/examples/api-resendOrderReceipt.mjs +10 -4
  792. package/examples/api-resendOrderReceipt.ts +10 -4
  793. package/examples/api-resendWebhookDelivery.mjs +12 -4
  794. package/examples/api-resendWebhookDelivery.ts +12 -4
  795. package/examples/api-resetDemoSession.mjs +11 -4
  796. package/examples/api-resetDemoSession.ts +11 -4
  797. package/examples/api-resetDeveloperSandbox.mjs +12 -4
  798. package/examples/api-resetDeveloperSandbox.ts +12 -4
  799. package/examples/api-resolveCustomerDeletionRequest.mjs +15 -7
  800. package/examples/api-resolveCustomerDeletionRequest.ts +15 -7
  801. package/examples/api-resolveOrderInventoryException.mjs +12 -4
  802. package/examples/api-resolveOrderInventoryException.ts +12 -4
  803. package/examples/api-resolvePaymentLink.mjs +15 -8
  804. package/examples/api-resolvePaymentLink.ts +15 -8
  805. package/examples/api-resolvePromotionCode.mjs +12 -4
  806. package/examples/api-resolvePromotionCode.ts +12 -4
  807. package/examples/api-resumeInvoiceReminders.mjs +12 -4
  808. package/examples/api-resumeInvoiceReminders.ts +12 -4
  809. package/examples/api-resumeMeSubscription.mjs +12 -4
  810. package/examples/api-resumeMeSubscription.ts +12 -4
  811. package/examples/api-resumeSubscription.mjs +12 -4
  812. package/examples/api-resumeSubscription.ts +12 -4
  813. package/examples/api-retryReturnDisposition.mjs +15 -7
  814. package/examples/api-retryReturnDisposition.ts +15 -7
  815. package/examples/api-retryReturnResolution.mjs +15 -7
  816. package/examples/api-retryReturnResolution.ts +15 -7
  817. package/examples/api-reverseCreditNoteAllocation.mjs +13 -5
  818. package/examples/api-reverseCreditNoteAllocation.ts +13 -5
  819. package/examples/api-reverseManualInvoicePayment.mjs +18 -10
  820. package/examples/api-reverseManualInvoicePayment.ts +18 -10
  821. package/examples/api-revokeAPIKey.mjs +12 -4
  822. package/examples/api-revokeAPIKey.ts +12 -4
  823. package/examples/api-revokeCustomerSession.mjs +11 -4
  824. package/examples/api-revokeCustomerSession.ts +11 -4
  825. package/examples/api-revokeCustomerSessions.mjs +11 -4
  826. package/examples/api-revokeCustomerSessions.ts +11 -4
  827. package/examples/api-revokeDeliveryDependency.mjs +18 -11
  828. package/examples/api-revokeDeliveryDependency.ts +18 -11
  829. package/examples/api-revokeDeveloperPartnerAppInstall.mjs +13 -5
  830. package/examples/api-revokeDeveloperPartnerAppInstall.ts +13 -5
  831. package/examples/api-revokeDeveloperPartnerEnvironmentGrant.mjs +14 -6
  832. package/examples/api-revokeDeveloperPartnerEnvironmentGrant.ts +14 -6
  833. package/examples/api-revokeOrganizationMembership.mjs +13 -5
  834. package/examples/api-revokeOrganizationMembership.ts +13 -5
  835. package/examples/api-rotateDeliveryRateCallbackSigningKey.mjs +12 -4
  836. package/examples/api-rotateDeliveryRateCallbackSigningKey.ts +12 -4
  837. package/examples/api-rotateDeveloperPartnerAppSecret.mjs +12 -4
  838. package/examples/api-rotateDeveloperPartnerAppSecret.ts +12 -4
  839. package/examples/api-rotateWebhookSecret.mjs +10 -4
  840. package/examples/api-rotateWebhookSecret.ts +10 -4
  841. package/examples/api-saveMePaymentMethod.mjs +12 -4
  842. package/examples/api-saveMePaymentMethod.ts +12 -4
  843. package/examples/api-savePaymentMethod.mjs +14 -6
  844. package/examples/api-savePaymentMethod.ts +14 -6
  845. package/examples/api-sendInvoiceReminder.mjs +12 -4
  846. package/examples/api-sendInvoiceReminder.ts +12 -4
  847. package/examples/api-setDefaultCustomerAddress.mjs +16 -8
  848. package/examples/api-setDefaultCustomerAddress.ts +16 -8
  849. package/examples/api-setDefaultMeAddress.mjs +15 -7
  850. package/examples/api-setDefaultMeAddress.ts +15 -7
  851. package/examples/api-setDefaultMePaymentMethod.mjs +12 -4
  852. package/examples/api-setDefaultMePaymentMethod.ts +12 -4
  853. package/examples/api-setDefaultPaymentMethod.mjs +12 -4
  854. package/examples/api-setDefaultPaymentMethod.ts +12 -4
  855. package/examples/api-skipSubscriptionCycle.mjs +13 -5
  856. package/examples/api-skipSubscriptionCycle.ts +13 -5
  857. package/examples/api-startOnboarding.mjs +13 -8
  858. package/examples/api-startOnboarding.ts +13 -8
  859. package/examples/api-streamWebhookEvents.mjs +8 -2
  860. package/examples/api-streamWebhookEvents.ts +8 -2
  861. package/examples/api-transferOrganizationOwnership.mjs +15 -7
  862. package/examples/api-transferOrganizationOwnership.ts +15 -7
  863. package/examples/api-transitionFulfillment.mjs +15 -7
  864. package/examples/api-transitionFulfillment.ts +15 -7
  865. package/examples/api-transitionInventoryTransfer.mjs +23 -15
  866. package/examples/api-transitionInventoryTransfer.ts +23 -15
  867. package/examples/api-transitionPackage.mjs +15 -7
  868. package/examples/api-transitionPackage.ts +15 -7
  869. package/examples/api-updateAPIKey.mjs +13 -5
  870. package/examples/api-updateAPIKey.ts +13 -5
  871. package/examples/api-updateBundle.mjs +13 -5
  872. package/examples/api-updateBundle.ts +13 -5
  873. package/examples/api-updateCategory.mjs +13 -5
  874. package/examples/api-updateCategory.ts +13 -5
  875. package/examples/api-updateCheckoutSession.mjs +13 -5
  876. package/examples/api-updateCheckoutSession.ts +13 -5
  877. package/examples/api-updateCreditNote.mjs +13 -5
  878. package/examples/api-updateCreditNote.ts +13 -5
  879. package/examples/api-updateCustomer.mjs +12 -5
  880. package/examples/api-updateCustomer.ts +12 -5
  881. package/examples/api-updateCustomerAddress.mjs +14 -6
  882. package/examples/api-updateCustomerAddress.ts +14 -6
  883. package/examples/api-updateDeliveryLocationSet.mjs +15 -7
  884. package/examples/api-updateDeliveryLocationSet.ts +15 -7
  885. package/examples/api-updateDeliveryMethod.mjs +14 -6
  886. package/examples/api-updateDeliveryMethod.ts +14 -6
  887. package/examples/api-updateDeliveryProfile.mjs +15 -7
  888. package/examples/api-updateDeliveryProfile.ts +15 -7
  889. package/examples/api-updateDeliveryRateCallback.mjs +15 -7
  890. package/examples/api-updateDeliveryRateCallback.ts +15 -7
  891. package/examples/api-updateDeliveryZone.mjs +15 -7
  892. package/examples/api-updateDeliveryZone.ts +15 -7
  893. package/examples/api-updateDeveloperPartnerApp.mjs +13 -5
  894. package/examples/api-updateDeveloperPartnerApp.ts +13 -5
  895. package/examples/api-updateDevice.mjs +13 -5
  896. package/examples/api-updateDevice.ts +13 -5
  897. package/examples/api-updateFulfillment.mjs +13 -5
  898. package/examples/api-updateFulfillment.ts +13 -5
  899. package/examples/api-updateInventoryAllocationPolicy.mjs +13 -5
  900. package/examples/api-updateInventoryAllocationPolicy.ts +13 -5
  901. package/examples/api-updateInventoryCount.mjs +27 -19
  902. package/examples/api-updateInventoryCount.ts +27 -19
  903. package/examples/api-updateInventoryItem.mjs +13 -5
  904. package/examples/api-updateInventoryItem.ts +13 -5
  905. package/examples/api-updateInventoryLevel.mjs +16 -8
  906. package/examples/api-updateInventoryLevel.ts +16 -8
  907. package/examples/api-updateInventoryTransfer.mjs +13 -5
  908. package/examples/api-updateInventoryTransfer.ts +13 -5
  909. package/examples/api-updateInvoice.mjs +13 -5
  910. package/examples/api-updateInvoice.ts +13 -5
  911. package/examples/api-updateInvoicePaymentTerm.mjs +17 -9
  912. package/examples/api-updateInvoicePaymentTerm.ts +17 -9
  913. package/examples/api-updateLocation.mjs +13 -5
  914. package/examples/api-updateLocation.ts +13 -5
  915. package/examples/api-updateLocationInventory.mjs +13 -7
  916. package/examples/api-updateLocationInventory.ts +13 -7
  917. package/examples/api-updateMe.mjs +11 -4
  918. package/examples/api-updateMe.ts +11 -4
  919. package/examples/api-updateMeAddress.mjs +13 -5
  920. package/examples/api-updateMeAddress.ts +13 -5
  921. package/examples/api-updateMerchant.mjs +13 -5
  922. package/examples/api-updateMerchant.ts +13 -5
  923. package/examples/api-updateModifierGroup.mjs +13 -5
  924. package/examples/api-updateModifierGroup.ts +13 -5
  925. package/examples/api-updateModifierSet.mjs +13 -5
  926. package/examples/api-updateModifierSet.ts +13 -5
  927. package/examples/api-updateOrder.mjs +15 -7
  928. package/examples/api-updateOrder.ts +15 -7
  929. package/examples/api-updateOrderCharge.mjs +14 -6
  930. package/examples/api-updateOrderCharge.ts +14 -6
  931. package/examples/api-updateOrderLineItem.mjs +12 -6
  932. package/examples/api-updateOrderLineItem.ts +12 -6
  933. package/examples/api-updateOrganization.mjs +13 -5
  934. package/examples/api-updateOrganization.ts +13 -5
  935. package/examples/api-updatePackage.mjs +13 -5
  936. package/examples/api-updatePackage.ts +13 -5
  937. package/examples/api-updatePackageItem.mjs +14 -6
  938. package/examples/api-updatePackageItem.ts +14 -6
  939. package/examples/api-updatePaymentIntent.mjs +13 -5
  940. package/examples/api-updatePaymentIntent.ts +13 -5
  941. package/examples/api-updatePaymentLink.mjs +13 -5
  942. package/examples/api-updatePaymentLink.ts +13 -5
  943. package/examples/api-updatePaymentMethodDomain.mjs +15 -7
  944. package/examples/api-updatePaymentMethodDomain.ts +15 -7
  945. package/examples/api-updatePayoutDestination.mjs +13 -5
  946. package/examples/api-updatePayoutDestination.ts +13 -5
  947. package/examples/api-updatePayoutSettings.mjs +12 -4
  948. package/examples/api-updatePayoutSettings.ts +12 -4
  949. package/examples/api-updateProduct.mjs +13 -5
  950. package/examples/api-updateProduct.ts +13 -5
  951. package/examples/api-updateProductVariant.mjs +14 -6
  952. package/examples/api-updateProductVariant.ts +14 -6
  953. package/examples/api-updatePromotion.mjs +13 -5
  954. package/examples/api-updatePromotion.ts +13 -5
  955. package/examples/api-updatePromotionCode.mjs +14 -6
  956. package/examples/api-updatePromotionCode.ts +14 -6
  957. package/examples/api-updateRefund.mjs +13 -5
  958. package/examples/api-updateRefund.ts +13 -5
  959. package/examples/api-updateReturn.mjs +13 -5
  960. package/examples/api-updateReturn.ts +13 -5
  961. package/examples/api-updateReturnLineItem.mjs +14 -6
  962. package/examples/api-updateReturnLineItem.ts +14 -6
  963. package/examples/api-updateReturnPolicy.mjs +13 -5
  964. package/examples/api-updateReturnPolicy.ts +13 -5
  965. package/examples/api-updateReturnReason.mjs +13 -5
  966. package/examples/api-updateReturnReason.ts +13 -5
  967. package/examples/api-updateReturnResolution.mjs +13 -5
  968. package/examples/api-updateReturnResolution.ts +13 -5
  969. package/examples/api-updateRiskList.mjs +14 -7
  970. package/examples/api-updateRiskList.ts +14 -7
  971. package/examples/api-updateRiskRule.mjs +14 -7
  972. package/examples/api-updateRiskRule.ts +14 -7
  973. package/examples/api-updateSettings.mjs +11 -4
  974. package/examples/api-updateSettings.ts +11 -4
  975. package/examples/api-updateShipment.mjs +13 -5
  976. package/examples/api-updateShipment.ts +13 -5
  977. package/examples/api-updateSubscription.mjs +13 -5
  978. package/examples/api-updateSubscription.ts +13 -5
  979. package/examples/api-updateSubscriptionBillingSchedule.mjs +17 -9
  980. package/examples/api-updateSubscriptionBillingSchedule.ts +17 -9
  981. package/examples/api-updateSubscriptionPlan.mjs +13 -5
  982. package/examples/api-updateSubscriptionPlan.ts +13 -5
  983. package/examples/api-updateWebhookEndpoint.mjs +12 -5
  984. package/examples/api-updateWebhookEndpoint.ts +12 -5
  985. package/examples/api-verifyOnboardingEmail.mjs +14 -7
  986. package/examples/api-verifyOnboardingEmail.ts +14 -7
  987. package/examples/api-verifyReturnReceiptLineItem.mjs +17 -9
  988. package/examples/api-verifyReturnReceiptLineItem.ts +17 -9
  989. package/examples/api-voidCreditNote.mjs +12 -4
  990. package/examples/api-voidCreditNote.ts +12 -4
  991. package/examples/api-voidInvoice.mjs +12 -4
  992. package/examples/api-voidInvoice.ts +12 -4
  993. package/examples/api-voidPackage.mjs +12 -4
  994. package/examples/api-voidPackage.ts +12 -4
  995. package/examples/api-voidShipment.mjs +12 -4
  996. package/examples/api-voidShipment.ts +12 -4
  997. package/examples/api-waiveReturnLineInspection.mjs +16 -8
  998. package/examples/api-waiveReturnLineInspection.ts +16 -8
  999. package/index.d.ts +405 -405
  1000. package/index.js +1 -1
  1001. package/package.json +2 -1
package/index.d.ts CHANGED
@@ -6385,445 +6385,445 @@ export declare class Client {
6385
6385
  /**
6386
6386
  * Adds a service charge, fee, or surcharge to an order.
6387
6387
  * POST /v1/orders/{order_id}/charges
6388
- * @example client.api.addOrderCharge({"order_id":"example","body":{"charge":{"name":"example","type":"service_fee","amount_money":{"amount":"0","currency":"USD"}}}})
6388
+ * @example client.api.addOrderCharge({order_id: "example", body: {charge: {name: "example", type: "service_fee", amount_money: {amount: "0", currency: "USD"}}}})
6389
6389
  */
6390
6390
  addOrderCharge(input: ApiAddOrderChargeInput, options?: RequestOptions): Promise<Result<ApiAddOrderChargeResponse>>;
6391
6391
  /**
6392
6392
  * Adds one or more line items to an order.
6393
6393
  * POST /v1/orders/{order_id}/line-items
6394
- * @example client.api.addOrderLineItems({"order_id":"example","body":{"line_items":[{"variant_id":"example"}]}})
6394
+ * @example client.api.addOrderLineItems({order_id: "example", body: {line_items: [{variant_id: "example"}]}})
6395
6395
  */
6396
6396
  addOrderLineItems(input: ApiAddOrderLineItemsInput, options?: RequestOptions): Promise<Result<ApiAddOrderLineItemsResponse>>;
6397
6397
  /**
6398
6398
  * Add a line item to a requested Return. The response is the updated Return, not the new line.
6399
6399
  * POST /v1/returns/{return_id}/line-items
6400
- * @example client.api.addReturnLineItem({"return_id":"example","body":{"line_item":{"order_line_item_id":"example","requested_quantity":"100","return_reason_id":"example"}}})
6400
+ * @example client.api.addReturnLineItem({return_id: "example", body: {line_item: {order_line_item_id: "example", requested_quantity: "100", return_reason_id: "example"}}})
6401
6401
  */
6402
6402
  addReturnLineItem(input: ApiAddReturnLineItemInput, options?: RequestOptions): Promise<Result<ApiAddReturnLineItemResponse>>;
6403
6403
  /**
6404
6404
  * Add risk list items for the authenticated merchant environment.
6405
6405
  * POST /v1/risk-lists/{risk_list_id}/items
6406
- * @example client.api.addRiskListItems({"body":{"values":["sdk-example"]},"risk_list_id":"example"})
6406
+ * @example client.api.addRiskListItems({body: {values: ["sdk-example"]}, risk_list_id: "example"})
6407
6407
  */
6408
6408
  addRiskListItems(input: ApiAddRiskListItemsInput, options?: RequestOptions): Promise<Result<ApiAddRiskListItemsResponse>>;
6409
6409
  /**
6410
6410
  * Submits whatever the caller currently knows, re-evaluates onboarding, reconciles onboarding requirements, and returns the next step in the consolidated onboarding state machine. Send an empty JSON object when the current next_step only asks to refresh onboarding requirements.
6411
6411
  * POST /v1/onboarding/advance
6412
- * @example client.api.advanceOnboarding({"body":{}})
6412
+ * @example client.api.advanceOnboarding({body: {}})
6413
6413
  */
6414
6414
  advanceOnboarding(input: ApiAdvanceOnboardingInput, options?: RequestOptions): Promise<Result<ApiAdvanceOnboardingResponse>>;
6415
6415
  /**
6416
6416
  * Apply a completed physical count to inventory levels.
6417
6417
  * POST /v1/inventory-counts/{inventory_count_id}/apply
6418
- * @example client.api.applyInventoryCount({"Idempotency-Key":"example","inventory_count_id":"example","body":{}})
6418
+ * @example client.api.applyInventoryCount({"Idempotency-Key": "example", inventory_count_id: "example", body: {}})
6419
6419
  */
6420
6420
  applyInventoryCount(input: ApiApplyInventoryCountInput, options?: RequestOptions): Promise<Result<ApiApplyInventoryCountResponse>>;
6421
6421
  /**
6422
6422
  * Applies a promotion-backed or manual discount to an order. Checkout-authenticated buyers must provide a promotion code; resource IDs and manual discounts require merchant authentication.
6423
6423
  * POST /v1/orders/{order_id}/discounts
6424
- * @example client.api.applyOrderDiscount({"order_id":"example","body":{"promotion":{"promotion_id":"example"}}})
6424
+ * @example client.api.applyOrderDiscount({order_id: "example", body: {promotion: {promotion_id: "example"}}})
6425
6425
  */
6426
6426
  applyOrderDiscount(input: ApiApplyOrderDiscountInput, options?: RequestOptions): Promise<Result<ApiApplyOrderDiscountResponse>>;
6427
6427
  /**
6428
6428
  * Approve a payment review for the authenticated merchant environment.
6429
6429
  * POST /v1/reviews/{review_id}/approve
6430
- * @example client.api.approveReview({"review_id":"example"})
6430
+ * @example client.api.approveReview({review_id: "example"})
6431
6431
  */
6432
6432
  approveReview(input: ApiApproveReviewInput, options?: RequestOptions): Promise<Result<ApiApproveReviewResponse>>;
6433
6433
  /**
6434
6434
  * Assigns this active delivery profile to physical product variants and bundle components that do not have a delivery profile.
6435
6435
  * POST /v1/delivery-profiles/{delivery_profile_id}/assign-to-unconfigured
6436
- * @example client.api.assignToUnconfiguredDeliveryProfile({"delivery_profile_id":"example","body":{}})
6436
+ * @example client.api.assignToUnconfiguredDeliveryProfile({delivery_profile_id: "example", body: {}})
6437
6437
  */
6438
6438
  assignToUnconfiguredDeliveryProfile(input: ApiAssignToUnconfiguredDeliveryProfileInput, options?: RequestOptions): Promise<Result<ApiAssignToUnconfiguredDeliveryProfileResponse>>;
6439
6439
  /**
6440
6440
  * Authenticates the merchant in Flint, validates the requested partner app install, and redirects back to the partner's redirect_uri with an authorization code.
6441
6441
  * GET /v1/oauth/authorize
6442
- * @example client.api.authorizePartnerInstall({"response_type":"code","client_id":"example","redirect_uri":"example","mode":"test","state":"example"})
6442
+ * @example client.api.authorizePartnerInstall({response_type: "code", client_id: "example", redirect_uri: "example", mode: "test", state: "example"})
6443
6443
  */
6444
6444
  authorizePartnerInstall(input: ApiAuthorizePartnerInstallInput, options?: RequestOptions): Promise<Result<ApiAuthorizePartnerInstallResponse>>;
6445
6445
  /**
6446
6446
  * Cancel an open physical count without changing inventory levels.
6447
6447
  * POST /v1/inventory-counts/{inventory_count_id}/cancel
6448
- * @example client.api.cancelInventoryCount({"Idempotency-Key":"example","inventory_count_id":"example","body":{}})
6448
+ * @example client.api.cancelInventoryCount({"Idempotency-Key": "example", inventory_count_id: "example", body: {}})
6449
6449
  */
6450
6450
  cancelInventoryCount(input: ApiCancelInventoryCountInput, options?: RequestOptions): Promise<Result<ApiCancelInventoryCountResponse>>;
6451
6451
  /**
6452
6452
  * Cancels an active invoice payment attempt and its payment intent. Safe to retry with the same Idempotency-Key.
6453
6453
  * POST /v1/invoices/{invoice_id}/payment-attempts/{invoice_payment_attempt_id}/cancel
6454
- * @example client.api.cancelInvoicePaymentAttempt({"invoice_id":"example","invoice_payment_attempt_id":"example"})
6454
+ * @example client.api.cancelInvoicePaymentAttempt({invoice_id: "example", invoice_payment_attempt_id: "example"})
6455
6455
  */
6456
6456
  cancelInvoicePaymentAttempt(input: ApiCancelInvoicePaymentAttemptInput, options?: RequestOptions): Promise<Result<ApiCancelInvoicePaymentAttemptResponse>>;
6457
6457
  /**
6458
6458
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Cancel a Return before any merchandise or value work commits. Cancellation is refused once a receipt, inspection, disposition, or resolution exists.
6459
6459
  * POST /v1/me/returns/{return_id}/cancel
6460
- * @example client.api.cancelMeReturn({"return_id":"example","body":{"reason":"buyer_request"}})
6460
+ * @example client.api.cancelMeReturn({return_id: "example", body: {reason: "buyer_request"}})
6461
6461
  */
6462
6462
  cancelMeReturn(input: ApiCancelMeReturnInput, options?: RequestOptions): Promise<Result<ApiCancelMeReturnResponse>>;
6463
6463
  /**
6464
6464
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Cancels a subscription immediately or at period end. Response may include advisory contract information.
6465
6465
  * POST /v1/me/subscriptions/{subscription_id}/cancel
6466
- * @example client.api.cancelMeSubscription({"subscription_id":"example","body":{}})
6466
+ * @example client.api.cancelMeSubscription({subscription_id: "example", body: {}})
6467
6467
  */
6468
6468
  cancelMeSubscription(input: ApiCancelMeSubscriptionInput, options?: RequestOptions): Promise<Result<ApiCancelMeSubscriptionResponse>>;
6469
6469
  /**
6470
6470
  * Cancels an unsettled order-owned payment leg. A leg in an active payment attempt requires the matching payment_attempt_id. Canceling an authorization releases the payment lock and attempt-owned holds; a staged or declined leg with no active attempt can be canceled without an attempt ID.
6471
6471
  * POST /v1/orders/{order_id}/payment-intents/{payment_intent_id}/cancel
6472
- * @example client.api.cancelOrderPayment({"order_id":"example","payment_intent_id":"example"})
6472
+ * @example client.api.cancelOrderPayment({order_id: "example", payment_intent_id: "example"})
6473
6473
  */
6474
6474
  cancelOrderPayment(input: ApiCancelOrderPaymentInput, options?: RequestOptions): Promise<Result<ApiCancelOrderPaymentResponse>>;
6475
6475
  /**
6476
6476
  * Cancels an active order payment attempt, its unsettled payment legs, and its attempt-owned holds.
6477
6477
  * POST /v1/orders/{order_id}/payment-attempts/{payment_attempt_id}/cancel
6478
- * @example client.api.cancelOrderPaymentAttempt({"order_id":"example","payment_attempt_id":"example"})
6478
+ * @example client.api.cancelOrderPaymentAttempt({order_id: "example", payment_attempt_id: "example"})
6479
6479
  */
6480
6480
  cancelOrderPaymentAttempt(input: ApiCancelOrderPaymentAttemptInput, options?: RequestOptions): Promise<Result<ApiCancelOrderPaymentAttemptResponse>>;
6481
6481
  /**
6482
6482
  * Cancels a standalone payment intent before it reaches a terminal settled state. Order-owned payment intents use the attempt-aware order cancellation route.
6483
6483
  * POST /v1/payment-intents/{payment_intent_id}/cancel
6484
- * @example client.api.cancelPaymentIntent({"payment_intent_id":"example","body":{}})
6484
+ * @example client.api.cancelPaymentIntent({payment_intent_id: "example", body: {}})
6485
6485
  */
6486
6486
  cancelPaymentIntent(input: ApiCancelPaymentIntentInput, options?: RequestOptions): Promise<Result<ApiCancelPaymentIntentResponse>>;
6487
6487
  /**
6488
6488
  * Cancels an eligible payout before it leaves Flint-controlled processing and returns the resulting payout.
6489
6489
  * POST /v1/payouts/{payout_id}/cancel
6490
- * @example client.api.cancelPayout({"payout_id":"example","body":{}})
6490
+ * @example client.api.cancelPayout({payout_id: "example", body: {}})
6491
6491
  */
6492
6492
  cancelPayout(input: ApiCancelPayoutInput, options?: RequestOptions): Promise<Result<ApiCancelPayoutResponse>>;
6493
6493
  /**
6494
6494
  * Cancel a Return before any merchandise or value work commits. Cancellation is refused once a receipt, inspection, disposition, or resolution exists.
6495
6495
  * POST /v1/returns/{return_id}/cancel
6496
- * @example client.api.cancelReturn({"return_id":"example","body":{"reason":"buyer_request"}})
6496
+ * @example client.api.cancelReturn({return_id: "example", body: {reason: "buyer_request"}})
6497
6497
  */
6498
6498
  cancelReturn(input: ApiCancelReturnInput, options?: RequestOptions): Promise<Result<ApiCancelReturnResponse>>;
6499
6499
  /**
6500
6500
  * Cancel a disposition that has not started its inventory effect. Cancellation is refused once the effect is processing.
6501
6501
  * POST /v1/return-dispositions/{return_disposition_id}/cancel
6502
- * @example client.api.cancelReturnDisposition({"return_disposition_id":"example","body":{"reason":"created_in_error"}})
6502
+ * @example client.api.cancelReturnDisposition({return_disposition_id: "example", body: {reason: "created_in_error"}})
6503
6503
  */
6504
6504
  cancelReturnDisposition(input: ApiCancelReturnDispositionInput, options?: RequestOptions): Promise<Result<ApiCancelReturnDispositionResponse>>;
6505
6505
  /**
6506
6506
  * Cancel approved quantity on a Return line item. Quantity already received, inspected, dispositioned, or reserved by a resolution cannot be canceled, and the conflict response names what is blocking it.
6507
6507
  * POST /v1/returns/{return_id}/line-items/{return_line_item_id}/cancel
6508
- * @example client.api.cancelReturnLineItem({"return_id":"example","return_line_item_id":"example","body":{"handback_quantity":"100","quantity":"100","reason":"buyer_request"}})
6508
+ * @example client.api.cancelReturnLineItem({return_id: "example", return_line_item_id: "example", body: {handback_quantity: "100", quantity: "100", reason: "buyer_request"}})
6509
6509
  */
6510
6510
  cancelReturnLineItem(input: ApiCancelReturnLineItemInput, options?: RequestOptions): Promise<Result<ApiCancelReturnLineItemResponse>>;
6511
6511
  /**
6512
6512
  * Cancel a resolution and release the line value it reserved. Effects that already succeeded are undone with a compensating correction instead.
6513
6513
  * POST /v1/return-resolutions/{return_resolution_id}/cancel
6514
- * @example client.api.cancelReturnResolution({"return_resolution_id":"example","body":{"reason":"buyer_request"}})
6514
+ * @example client.api.cancelReturnResolution({return_resolution_id: "example", body: {reason: "buyer_request"}})
6515
6515
  */
6516
6516
  cancelReturnResolution(input: ApiCancelReturnResolutionInput, options?: RequestOptions): Promise<Result<ApiCancelReturnResolutionResponse>>;
6517
6517
  /**
6518
6518
  * Cancels a subscription immediately or at period end. Response may include advisory contract information.
6519
6519
  * POST /v1/subscriptions/{subscription_id}/cancel
6520
- * @example client.api.cancelSubscription({"subscription_id":"example","body":{}})
6520
+ * @example client.api.cancelSubscription({subscription_id: "example", body: {}})
6521
6521
  */
6522
6522
  cancelSubscription(input: ApiCancelSubscriptionInput, options?: RequestOptions): Promise<Result<ApiCancelSubscriptionResponse>>;
6523
6523
  /**
6524
6524
  * Captures an active payment authorization for an order and updates the order payment lifecycle.
6525
6525
  * POST /v1/orders/{order_id}/payment-intents/{payment_intent_id}/capture
6526
- * @example client.api.captureOrderPayment({"order_id":"example","payment_intent_id":"example"})
6526
+ * @example client.api.captureOrderPayment({order_id: "example", payment_intent_id: "example"})
6527
6527
  */
6528
6528
  captureOrderPayment(input: ApiCaptureOrderPaymentInput, options?: RequestOptions): Promise<Result<ApiCaptureOrderPaymentResponse>>;
6529
6529
  /**
6530
6530
  * Captures an authorized standalone payment intent, including partial captures when supported. Order-owned payment intents use the attempt-aware order capture route.
6531
6531
  * POST /v1/payment-intents/{payment_intent_id}/capture
6532
- * @example client.api.capturePaymentIntent({"payment_intent_id":"example","body":{}})
6532
+ * @example client.api.capturePaymentIntent({payment_intent_id: "example", body: {}})
6533
6533
  */
6534
6534
  capturePaymentIntent(input: ApiCapturePaymentIntentInput, options?: RequestOptions): Promise<Result<ApiCapturePaymentIntentResponse>>;
6535
6535
  /**
6536
6536
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Changes the subscription to an active payment method owned by the same customer.
6537
6537
  * POST /v1/me/subscriptions/{subscription_id}/payment-method
6538
- * @example client.api.changeMeSubscriptionPaymentMethod({"subscription_id":"example","body":{"payment_method_id":"example"}})
6538
+ * @example client.api.changeMeSubscriptionPaymentMethod({subscription_id: "example", body: {payment_method_id: "example"}})
6539
6539
  */
6540
6540
  changeMeSubscriptionPaymentMethod(input: ApiChangeMeSubscriptionPaymentMethodInput, options?: RequestOptions): Promise<Result<ApiChangeMeSubscriptionPaymentMethodResponse>>;
6541
6541
  /**
6542
6542
  * Changes the subscription to an active payment method owned by the same customer.
6543
6543
  * POST /v1/subscriptions/{subscription_id}/payment-method
6544
- * @example client.api.changeSubscriptionPaymentMethod({"subscription_id":"example","body":{"payment_method_id":"example"}})
6544
+ * @example client.api.changeSubscriptionPaymentMethod({subscription_id: "example", body: {payment_method_id: "example"}})
6545
6545
  */
6546
6546
  changeSubscriptionPaymentMethod(input: ApiChangeSubscriptionPaymentMethodInput, options?: RequestOptions): Promise<Result<ApiChangeSubscriptionPaymentMethodResponse>>;
6547
6547
  /**
6548
6548
  * Sends a minimal signed probe to verify endpoint reachability and callback credentials without running a synthetic rate evaluation.
6549
6549
  * POST /v1/delivery-rate-callbacks/{delivery_rate_callback_id}/check-connection
6550
- * @example client.api.checkDeliveryRateCallbackConnection({"delivery_rate_callback_id":"example"})
6550
+ * @example client.api.checkDeliveryRateCallbackConnection({delivery_rate_callback_id: "example"})
6551
6551
  */
6552
6552
  checkDeliveryRateCallbackConnection(input: ApiCheckDeliveryRateCallbackConnectionInput, options?: RequestOptions): Promise<Result<ApiCheckDeliveryRateCallbackConnectionResponse>>;
6553
6553
  /**
6554
6554
  * Closes an open checkout session before it naturally expires.
6555
6555
  * POST /v1/checkout-sessions/{checkout_session_id}/close
6556
- * @example client.api.closeCheckoutSession({"checkout_session_id":"example","body":{}})
6556
+ * @example client.api.closeCheckoutSession({checkout_session_id: "example", body: {}})
6557
6557
  */
6558
6558
  closeCheckoutSession(input: ApiCloseCheckoutSessionInput, options?: RequestOptions): Promise<Result<ApiCloseCheckoutSessionResponse>>;
6559
6559
  /**
6560
6560
  * Closes an eligible open, paid, or partially refunded order. Closing cancels pending discounts, releases pending promotion reservations, and recalculates totals from the current surviving pricing economics; canceled discounts remain visible with status: "canceled" but no longer reduce the total. Closing is blocked while payment collection is in progress.
6561
6561
  * POST /v1/orders/{order_id}/close
6562
- * @example client.api.closeOrder({"order_id":"example","body":{}})
6562
+ * @example client.api.closeOrder({order_id: "example", body: {}})
6563
6563
  */
6564
6564
  closeOrder(input: ApiCloseOrderInput, options?: RequestOptions): Promise<Result<ApiCloseOrderResponse>>;
6565
6565
  /**
6566
6566
  * Charges the invoice's saved payment method or the supplied saved payment method. This command requires a caller-chosen Idempotency-Key that is reused for retries of the same collection request.
6567
6567
  * POST /v1/invoices/{invoice_id}/collect
6568
- * @example client.api.collectInvoice({"invoice_id":"example","Idempotency-Key":"example","body":{}})
6568
+ * @example client.api.collectInvoice({invoice_id: "example", "Idempotency-Key": "example", body: {}})
6569
6569
  */
6570
6570
  collectInvoice(input: ApiCollectInvoiceInput, options?: RequestOptions): Promise<Result<ApiCollectInvoiceResponse>>;
6571
6571
  /**
6572
6572
  * Move held quantity to committed. Lines carry cumulative targets, so resending an applied target is a successful no-op.
6573
6573
  * POST /v1/inventory-reservations/{inventory_reservation_id}/commit
6574
- * @example client.api.commitInventoryReservation({"Idempotency-Key":"example","inventory_reservation_id":"example","body":{"lines":[]}})
6574
+ * @example client.api.commitInventoryReservation({"Idempotency-Key": "example", inventory_reservation_id: "example", body: {lines: []}})
6575
6575
  */
6576
6576
  commitInventoryReservation(input: ApiCommitInventoryReservationInput, options?: RequestOptions): Promise<Result<ApiCommitInventoryReservationResponse>>;
6577
6577
  /**
6578
6578
  * Complete a Return whose completion_mode is manual. The call fails while completion_blockers is non-empty. Automatic Returns complete themselves when the final blocker clears.
6579
6579
  * POST /v1/returns/{return_id}/complete
6580
- * @example client.api.completeReturn({"return_id":"example","body":{}})
6580
+ * @example client.api.completeReturn({return_id: "example", body: {}})
6581
6581
  */
6582
6582
  completeReturn(input: ApiCompleteReturnInput, options?: RequestOptions): Promise<Result<ApiCompleteReturnResponse>>;
6583
6583
  /**
6584
6584
  * Confirms possession of the current and new email addresses, then atomically updates the customer account in the selected merchant environment. Omit current_email_code only when current_email_confirmation_required is false.
6585
6585
  * POST /v1/me/email-change-requests/{email_change_request_id}/confirm
6586
- * @example client.api.confirmMeEmailChangeRequest({"email_change_request_id":"example","body":{"new_email_code":"example"}})
6586
+ * @example client.api.confirmMeEmailChangeRequest({email_change_request_id: "example", body: {new_email_code: "example"}})
6587
6587
  */
6588
6588
  confirmMeEmailChangeRequest(input: ApiConfirmMeEmailChangeRequestInput, options?: RequestOptions): Promise<Result<ApiConfirmMeEmailChangeRequestResponse>>;
6589
6589
  /**
6590
6590
  * Confirms a standalone payment intent. Order-owned payment intents reject this route and must be confirmed through POST /v1/orders/{order_id}/pay.
6591
6591
  * POST /v1/payment-intents/{payment_intent_id}/confirm
6592
- * @example client.api.confirmPaymentIntent({"payment_intent_id":"example","body":{}})
6592
+ * @example client.api.confirmPaymentIntent({payment_intent_id: "example", body: {}})
6593
6593
  */
6594
6594
  confirmPaymentIntent(input: ApiConfirmPaymentIntentInput, options?: RequestOptions): Promise<Result<ApiConfirmPaymentIntentResponse>>;
6595
6595
  /**
6596
6596
  * Confirm a proposed resolution and freeze its economic facts. Execution can remain pending behind line-qualified execution blockers.
6597
6597
  * POST /v1/return-resolutions/{return_resolution_id}/confirm
6598
- * @example client.api.confirmReturnResolution({"return_resolution_id":"example","body":{}})
6598
+ * @example client.api.confirmReturnResolution({return_resolution_id: "example", body: {}})
6599
6599
  */
6600
6600
  confirmReturnResolution(input: ApiConfirmReturnResolutionInput, options?: RequestOptions): Promise<Result<ApiConfirmReturnResolutionResponse>>;
6601
6601
  /**
6602
6602
  * Consume committed quantity, permanently removing it from stock. Cumulative targets; consumed quantity is terminal.
6603
6603
  * POST /v1/inventory-reservations/{inventory_reservation_id}/consume
6604
- * @example client.api.consumeInventoryReservation({"Idempotency-Key":"example","inventory_reservation_id":"example","body":{"lines":[],"provenance":{}}})
6604
+ * @example client.api.consumeInventoryReservation({"Idempotency-Key": "example", inventory_reservation_id: "example", body: {lines: [], provenance: {}}})
6605
6605
  */
6606
6606
  consumeInventoryReservation(input: ApiConsumeInventoryReservationInput, options?: RequestOptions): Promise<Result<ApiConsumeInventoryReservationResponse>>;
6607
6607
  /**
6608
6608
  * Creates a merchant-bound external API key. secret_key is returned only in the initial successful response and accepted idempotent replays of the same create request.
6609
6609
  * POST /v1/api-keys
6610
- * @example client.api.createAPIKey({"body":{"name":"example","scopes":[]}})
6610
+ * @example client.api.createAPIKey({body: {name: "example", scopes: []}})
6611
6611
  */
6612
6612
  createAPIKey(input: ApiCreateAPIKeyInput, options?: RequestOptions): Promise<Result<ApiCreateAPIKeyResponse>>;
6613
6613
  /**
6614
6614
  * Create bundle.
6615
6615
  * POST /v1/bundles
6616
- * @example client.api.createBundle({"body":{"name":"example","unit_price_money":{"amount":"0","currency":"USD"}}})
6616
+ * @example client.api.createBundle({body: {name: "example", unit_price_money: {amount: "0", currency: "USD"}}})
6617
6617
  */
6618
6618
  createBundle(input: ApiCreateBundleInput, options?: RequestOptions): Promise<Result<ApiCreateBundleResponse>>;
6619
6619
  /**
6620
6620
  * Creates a reusable category. If handle is omitted, Flint derives it from the name and never changes it on rename.
6621
6621
  * POST /v1/categories
6622
- * @example client.api.createCategory({"body":{"name":"example"}})
6622
+ * @example client.api.createCategory({body: {name: "example"}})
6623
6623
  */
6624
6624
  createCategory(input: ApiCreateCategoryInput, options?: RequestOptions): Promise<Result<ApiCreateCategoryResponse>>;
6625
6625
  /**
6626
6626
  * Creates a hosted or embedded checkout session for an order, quick-pay charge, or subscription plan signup. Creation never implicitly replaces an open order session. To replace one, send order_id with replace_checkout_session_id set to the expected current session; the compare-and-swap replacement and collection-lock transfer commit atomically.
6627
6627
  * POST /v1/checkout-sessions
6628
- * @example client.api.createCheckoutSession({"body":{"order_id":"example"}})
6628
+ * @example client.api.createCheckoutSession({body: {order_id: "example"}})
6629
6629
  */
6630
6630
  createCheckoutSession(input: ApiCreateCheckoutSessionInput, options?: RequestOptions): Promise<Result<ApiCreateCheckoutSessionResponse>>;
6631
6631
  /**
6632
6632
  * Creates an exact checkout-bound delivery quote without holding inventory.
6633
6633
  * POST /v1/checkout-sessions/{checkout_session_id}/delivery-quotes
6634
- * @example client.api.createCheckoutSessionDeliveryQuote({"checkout_session_id":"example","body":{"expected_delivery_selection_id":"example"}})
6634
+ * @example client.api.createCheckoutSessionDeliveryQuote({checkout_session_id: "example", body: {expected_delivery_selection_id: "example"}})
6635
6635
  */
6636
6636
  createCheckoutSessionDeliveryQuote(input: ApiCreateCheckoutSessionDeliveryQuoteInput, options?: RequestOptions): Promise<Result<ApiCreateCheckoutSessionDeliveryQuoteResponse>>;
6637
6637
  /**
6638
6638
  * Atomically selects one option per choice group, replaces inventory holds, and recalculates checkout economics.
6639
6639
  * POST /v1/checkout-sessions/{checkout_session_id}/delivery-selections
6640
- * @example client.api.createCheckoutSessionDeliverySelection({"checkout_session_id":"example","body":{"choices":[],"delivery_quote_id":"example","expected_delivery_selection_id":"example"}})
6640
+ * @example client.api.createCheckoutSessionDeliverySelection({checkout_session_id: "example", body: {choices: [], delivery_quote_id: "example", expected_delivery_selection_id: "example"}})
6641
6641
  */
6642
6642
  createCheckoutSessionDeliverySelection(input: ApiCreateCheckoutSessionDeliverySelectionInput, options?: RequestOptions): Promise<Result<ApiCreateCheckoutSessionDeliverySelectionResponse>>;
6643
6643
  /**
6644
6644
  * Creates a draft credit note against an invoice that has been issued and not voided. Include credit_note_lines for initial corrections or omit them for an empty draft. The draft uses the invoice currency and receives a credit note number when issued.
6645
6645
  * POST /v1/credit-notes
6646
- * @example client.api.createCreditNote({"body":{"invoice_id":"example","reason":"returned_goods"}})
6646
+ * @example client.api.createCreditNote({body: {invoice_id: "example", reason: "returned_goods"}})
6647
6647
  */
6648
6648
  createCreditNote(input: ApiCreateCreditNoteInput, options?: RequestOptions): Promise<Result<ApiCreateCreditNoteResponse>>;
6649
6649
  /**
6650
6650
  * Applies credit from an issued credit note to its invoice, reducing outstanding_money. The amount cannot exceed the credit note's unallocated_money or the invoice's outstanding balance. Closing the balance with credit sets the invoice to credited. Returns the allocation, the credit note, and the recomputed invoice together. An Idempotency-Key is required and becomes the allocation's identity.
6651
6651
  * POST /v1/credit-notes/{credit_note_id}/allocations
6652
- * @example client.api.createCreditNoteAllocation({"credit_note_id":"example","Idempotency-Key":"example","body":{"amount_money":{"amount":"0","currency":"USD"}}})
6652
+ * @example client.api.createCreditNoteAllocation({credit_note_id: "example", "Idempotency-Key": "example", body: {amount_money: {amount: "0", currency: "USD"}}})
6653
6653
  */
6654
6654
  createCreditNoteAllocation(input: ApiCreateCreditNoteAllocationInput, options?: RequestOptions): Promise<Result<ApiCreateCreditNoteAllocationResponse>>;
6655
6655
  /**
6656
6656
  * Creates a customer for the authenticated merchant.
6657
6657
  * POST /v1/customers
6658
- * @example client.api.createCustomer({"body":{"email":"example"}})
6658
+ * @example client.api.createCustomer({body: {email: "example"}})
6659
6659
  */
6660
6660
  createCustomer(input: ApiCreateCustomerInput, options?: RequestOptions): Promise<Result<ApiCreateCustomerResponse>>;
6661
6661
  /**
6662
6662
  * Creates a stable saved address. The first address becomes both the billing and shipping default. A saved default becomes the customer's effective address for the corresponding role.
6663
6663
  * POST /v1/customers/{customer_id}/addresses
6664
- * @example client.api.createCustomerAddress({"customer_id":"example","body":{"address":{"city":"example","country":"US","line1":"example","postal_code":"example","state":"example"},"recipient_name":"example"}})
6664
+ * @example client.api.createCustomerAddress({customer_id: "example", body: {address: {city: "example", country: "US", line1: "example", postal_code: "example", state: "example"}, recipient_name: "example"}})
6665
6665
  */
6666
6666
  createCustomerAddress(input: ApiCreateCustomerAddressInput, options?: RequestOptions): Promise<Result<ApiCreateCustomerAddressResponse>>;
6667
6667
  /**
6668
6668
  * Creates or returns the pending tracked deletion request. Required commerce records are retained until the deletion workflow resolves their legal retention requirements.
6669
6669
  * POST /v1/customers/{customer_id}/deletion-requests
6670
- * @example client.api.createCustomerDeletionRequest({"customer_id":"example"})
6670
+ * @example client.api.createCustomerDeletionRequest({customer_id: "example"})
6671
6671
  */
6672
6672
  createCustomerDeletionRequest(input: ApiCreateCustomerDeletionRequestInput, options?: RequestOptions): Promise<Result<ApiCreateCustomerDeletionRequestResponse>>;
6673
6673
  /**
6674
6674
  * Mints a server-side, customer-scoped credential after the merchant has authenticated the buyer. Secret and refresh_token are returned only in this response. Flint-hosted merchants also receive a separately expiring one-time account_url.
6675
6675
  * POST /v1/customer-sessions
6676
- * @example client.api.createCustomerSession({"body":{"customer_id":"example"}})
6676
+ * @example client.api.createCustomerSession({body: {customer_id: "example"}})
6677
6677
  */
6678
6678
  createCustomerSession(input: ApiCreateCustomerSessionInput, options?: RequestOptions): Promise<Result<ApiCreateCustomerSessionResponse>>;
6679
6679
  /**
6680
6680
  * Delivery location sets pin reusable sets of Locations for allocation or buyer pickup. Creation publishes immutable revision 1. It starts active.
6681
6681
  * POST /v1/delivery-location-sets
6682
- * @example client.api.createDeliveryLocationSet({"body":{"name":"example","configuration":{"location_ids":[]}}})
6682
+ * @example client.api.createDeliveryLocationSet({body: {name: "example", configuration: {location_ids: []}}})
6683
6683
  */
6684
6684
  createDeliveryLocationSet(input: ApiCreateDeliveryLocationSetInput, options?: RequestOptions): Promise<Result<ApiCreateDeliveryLocationSetResponse>>;
6685
6685
  /**
6686
6686
  * Delivery methods combine eligibility, pricing, schedules, estimates, tax treatment, and execution behavior. Creation publishes immutable revision 1. Omit status to start inactive.
6687
6687
  * POST /v1/delivery-methods
6688
- * @example client.api.createDeliveryMethod({"body":{"configuration":{"minimum_option_lifetime_seconds":"120","origin":{"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX","type":"fixed_location"},"pricing":{"calculated":{},"type":"calculated"}},"name":"Standard shipping","type":"shipment"}})
6688
+ * @example client.api.createDeliveryMethod({body: {configuration: {minimum_option_lifetime_seconds: "120", origin: {location_id: "loc_01K1P6G4M7H2N8Q9R3S5T6V7WX", type: "fixed_location"}, pricing: {calculated: {}, type: "calculated"}}, name: "Standard shipping", type: "shipment"}})
6689
6689
  */
6690
6690
  createDeliveryMethod(input: ApiCreateDeliveryMethodInput, options?: RequestOptions): Promise<Result<ApiCreateDeliveryMethodResponse>>;
6691
6691
  /**
6692
6692
  * Computes exact display-only delivery outcomes without persisting a resource, holding inventory, or granting selection authority.
6693
6693
  * POST /v1/delivery-previews
6694
- * @example client.api.createDeliveryPreview({"body":{"currency":"USD","delivery_method_ids":[],"line_items":[{"variant_id":"example"}]}})
6694
+ * @example client.api.createDeliveryPreview({body: {currency: "USD", delivery_method_ids: [], line_items: [{variant_id: "example"}]}})
6695
6695
  */
6696
6696
  createDeliveryPreview(input: ApiCreateDeliveryPreviewInput, options?: RequestOptions): Promise<Result<ApiCreateDeliveryPreviewResponse>>;
6697
6697
  /**
6698
6698
  * Delivery profiles define reusable delivery rules assigned to catalog obligations. Creation publishes immutable revision 1. It starts active.
6699
6699
  * POST /v1/delivery-profiles
6700
- * @example client.api.createDeliveryProfile({"body":{"name":"example","configuration":{"requirement":"none"}}})
6700
+ * @example client.api.createDeliveryProfile({body: {name: "example", configuration: {requirement: "none"}}})
6701
6701
  */
6702
6702
  createDeliveryProfile(input: ApiCreateDeliveryProfileInput, options?: RequestOptions): Promise<Result<ApiCreateDeliveryProfileResponse>>;
6703
6703
  /**
6704
6704
  * Delivery callback endpoints pin shared outbound callback transport configuration. Creation publishes immutable revision 1. It starts inactive.
6705
6705
  * POST /v1/delivery-rate-callbacks
6706
- * @example client.api.createDeliveryRateCallback({"body":{"name":"example","configuration":{"url":"example"}}})
6706
+ * @example client.api.createDeliveryRateCallback({body: {name: "example", configuration: {url: "example"}}})
6707
6707
  */
6708
6708
  createDeliveryRateCallback(input: ApiCreateDeliveryRateCallbackInput, options?: RequestOptions): Promise<Result<ApiCreateDeliveryRateCallbackResponse>>;
6709
6709
  /**
6710
6710
  * Sends a signed delivery rate callback with synthetic non-PII data and returns a safe result.
6711
6711
  * POST /v1/delivery-rate-callbacks/{delivery_rate_callback_id}/test-deliveries
6712
- * @example client.api.createDeliveryRateCallbackTestDelivery({"delivery_rate_callback_id":"example"})
6712
+ * @example client.api.createDeliveryRateCallbackTestDelivery({delivery_rate_callback_id: "example"})
6713
6713
  */
6714
6714
  createDeliveryRateCallbackTestDelivery(input: ApiCreateDeliveryRateCallbackTestDeliveryInput, options?: RequestOptions): Promise<Result<ApiCreateDeliveryRateCallbackTestDeliveryResponse>>;
6715
6715
  /**
6716
6716
  * Delivery zones define versioned geographic eligibility. Creation publishes immutable revision 1. It starts active.
6717
6717
  * POST /v1/delivery-zones
6718
- * @example client.api.createDeliveryZone({"body":{"configuration":{"country":{"values":["example"]}},"name":"Standard delivery"}})
6718
+ * @example client.api.createDeliveryZone({body: {configuration: {country: {values: ["example"]}}, name: "Standard delivery"}})
6719
6719
  */
6720
6720
  createDeliveryZone(input: ApiCreateDeliveryZoneInput, options?: RequestOptions): Promise<Result<ApiCreateDeliveryZoneResponse>>;
6721
6721
  /**
6722
6722
  * Creates a temporary demo sandbox and returns a short-lived test API key. The secret key is displayed only at creation time and for a short idempotent retry window.
6723
6723
  * POST /v1/demo-sessions
6724
- * @example client.api.createDemoSession({"body":{}})
6724
+ * @example client.api.createDemoSession({body: {}})
6725
6725
  */
6726
6726
  createDemoSession(input: ApiCreateDemoSessionInput, options?: RequestOptions): Promise<Result<ApiCreateDemoSessionResponse>>;
6727
6727
  /**
6728
6728
  * Creates a partner app owned by the authenticated merchant. Use a developer setup session during setup or a normal external API key afterward.
6729
6729
  * POST /v1/developer/partner/apps
6730
- * @example client.api.createDeveloperPartnerApp({"body":{"name":"example","permission_manifest":[],"redirect_uris":[]}})
6730
+ * @example client.api.createDeveloperPartnerApp({body: {name: "example", permission_manifest: [], redirect_uris: []}})
6731
6731
  */
6732
6732
  createDeveloperPartnerApp(input: ApiCreateDeveloperPartnerAppInput, options?: RequestOptions): Promise<Result<ApiCreateDeveloperPartnerAppResponse>>;
6733
6733
  /**
6734
6734
  * Creates a new test sandbox for the current merchant. Optionally seeds the new empty sandbox with the merchant's live defaults and issues a sandbox-bound test key as part of creation.
6735
6735
  * POST /v1/developer/sandboxes
6736
- * @example client.api.createDeveloperSandbox({"body":{"name":"example"}})
6736
+ * @example client.api.createDeveloperSandbox({body: {name: "example"}})
6737
6737
  */
6738
6738
  createDeveloperSandbox(input: ApiCreateDeveloperSandboxInput, options?: RequestOptions): Promise<Result<ApiCreateDeveloperSandboxResponse>>;
6739
6739
  /**
6740
6740
  * Creates a device for the authenticated merchant. If hardware_fingerprint matches an existing device, the existing device is returned with 200 OK and data.already_existed=true.
6741
6741
  * POST /v1/devices
6742
- * @example client.api.createDevice({"body":{"name":"example"}})
6742
+ * @example client.api.createDevice({body: {name: "example"}})
6743
6743
  */
6744
6744
  createDevice(input: ApiCreateDeviceInput, options?: RequestOptions): Promise<Result<ApiCreateDeviceResponse>>;
6745
6745
  /**
6746
6746
  * Stores one immutable occurrence of Flint feedback. Use one report per root cause and include only the evidence needed to describe Flint's behavior.
6747
6747
  * POST /v1/feedback-reports
6748
- * @example client.api.createFeedbackReport({"body":{"kind":"rating","surface":"api","sentiment":"positive"}})
6748
+ * @example client.api.createFeedbackReport({body: {kind: "rating", surface: "api", sentiment: "positive"}})
6749
6749
  */
6750
6750
  createFeedbackReport(input: ApiCreateFeedbackReportInput, options?: RequestOptions): Promise<Result<ApiCreateFeedbackReportResponse>>;
6751
6751
  /**
6752
6752
  * Creates an explicit fulfillment for an order.
6753
6753
  * POST /v1/orders/{order_id}/fulfillments
6754
- * @example client.api.createFulfillment({"order_id":"example","body":{"line_items":[{"order_line_item_id":"example","quantity":"100"}],"type":"shipment"}})
6754
+ * @example client.api.createFulfillment({order_id: "example", body: {line_items: [{order_line_item_id: "example", quantity: "100"}], type: "shipment"}})
6755
6755
  */
6756
6756
  createFulfillment(input: ApiCreateFulfillmentInput, options?: RequestOptions): Promise<Result<ApiCreateFulfillmentResponse>>;
6757
6757
  /**
6758
6758
  * Records an observational event for a fulfillment or one of its shipments or packages.
6759
6759
  * POST /v1/fulfillments/{fulfillment_id}/events
6760
- * @example client.api.createFulfillmentEvent({"fulfillment_id":"example","body":{"event_type":"shipped"}})
6760
+ * @example client.api.createFulfillmentEvent({fulfillment_id: "example", body: {event_type: "shipped"}})
6761
6761
  */
6762
6762
  createFulfillmentEvent(input: ApiCreateFulfillmentEventInput, options?: RequestOptions): Promise<Result<ApiCreateFulfillmentEventResponse>>;
6763
6763
  /**
6764
6764
  * Record a physical stock change as signed deltas. Returns the created adjustment, its movement IDs, and the resulting level for every level touched.
6765
6765
  * POST /v1/inventory-adjustments
6766
- * @example client.api.createInventoryAdjustment({"Idempotency-Key":"example","body":{"lines":[],"reason":"received_stock"}})
6766
+ * @example client.api.createInventoryAdjustment({"Idempotency-Key": "example", body: {lines: [], reason: "received_stock"}})
6767
6767
  */
6768
6768
  createInventoryAdjustment(input: ApiCreateInventoryAdjustmentInput, options?: RequestOptions): Promise<Result<ApiCreateInventoryAdjustmentResponse>>;
6769
6769
  /**
6770
6770
  * Create an allocation policy with its routing configuration.
6771
6771
  * POST /v1/inventory-allocation-policies
6772
- * @example client.api.createInventoryAllocationPolicy({"body":{"configuration":{"location_groups":[{"group_priority":1,"location_id":"example"}],"maximum_locations_per_assignment":1,"splitting_behavior":"single_location"},"name":"example"}})
6772
+ * @example client.api.createInventoryAllocationPolicy({body: {configuration: {location_groups: [{group_priority: 1, location_id: "example"}], maximum_locations_per_assignment: 1, splitting_behavior: "single_location"}, name: "example"}})
6773
6773
  */
6774
6774
  createInventoryAllocationPolicy(input: ApiCreateInventoryAllocationPolicyInput, options?: RequestOptions): Promise<Result<ApiCreateInventoryAllocationPolicyResponse>>;
6775
6775
  /**
6776
6776
  * Open a physical count for selected inventory items at one Location.
6777
6777
  * POST /v1/inventory-counts
6778
- * @example client.api.createInventoryCount({"Idempotency-Key":"example","body":{"inventory_item_ids":["example"],"location_id":"example"}})
6778
+ * @example client.api.createInventoryCount({"Idempotency-Key": "example", body: {inventory_item_ids: ["example"], location_id: "example"}})
6779
6779
  */
6780
6780
  createInventoryCount(input: ApiCreateInventoryCountInput, options?: RequestOptions): Promise<Result<ApiCreateInventoryCountResponse>>;
6781
6781
  /**
6782
6782
  * Create an inventory item. SKU and barcode are searchable attributes, not identity: they are not required to be unique.
6783
6783
  * POST /v1/inventory-items
6784
- * @example client.api.createInventoryItem({"body":{"name":"example"}})
6784
+ * @example client.api.createInventoryItem({body: {name: "example"}})
6785
6785
  */
6786
6786
  createInventoryItem(input: ApiCreateInventoryItemInput, options?: RequestOptions): Promise<Result<ApiCreateInventoryItemResponse>>;
6787
6787
  /**
6788
6788
  * Record a completed inventory receipt and disposition. This is a downstream stock effect, not the customer Return lifecycle.
6789
6789
  * POST /v1/inventory-receipts
6790
- * @example client.api.createInventoryReceipt({"Idempotency-Key":"example","body":{"lines":[]}})
6790
+ * @example client.api.createInventoryReceipt({"Idempotency-Key": "example", body: {lines: []}})
6791
6791
  */
6792
6792
  createInventoryReceipt(input: ApiCreateInventoryReceiptInput, options?: RequestOptions): Promise<Result<ApiCreateInventoryReceiptResponse>>;
6793
6793
  /**
6794
6794
  * Route standalone merchant demand and hold stock in one atomic command. A provisional hold lasts at most 15 minutes.
6795
6795
  * POST /v1/inventory-reservations
6796
- * @example client.api.createInventoryReservation({"Idempotency-Key":"example","body":{"demands":[],"inventory_routing_source":{"type":"fixed_location","location_id":"example"},"owner":{"expires_at":"2026-01-01T00:00:00Z","key":"example"}}})
6796
+ * @example client.api.createInventoryReservation({"Idempotency-Key": "example", body: {demands: [], inventory_routing_source: {type: "fixed_location", location_id: "example"}, owner: {expires_at: "2026-01-01T00:00:00Z", key: "example"}}})
6797
6797
  */
6798
6798
  createInventoryReservation(input: ApiCreateInventoryReservationInput, options?: RequestOptions): Promise<Result<ApiCreateInventoryReservationResponse>>;
6799
6799
  /**
6800
6800
  * Create a planned stock transfer between two Locations.
6801
6801
  * POST /v1/inventory-transfers
6802
- * @example client.api.createInventoryTransfer({"Idempotency-Key":"example","body":{"destination_location_id":"example","lines":[{"inventory_item_id":"example","requested_quantity":"1"}],"origin_location_id":"example"}})
6802
+ * @example client.api.createInventoryTransfer({"Idempotency-Key": "example", body: {destination_location_id: "example", lines: [{inventory_item_id: "example", requested_quantity: "1"}], origin_location_id: "example"}})
6803
6803
  */
6804
6804
  createInventoryTransfer(input: ApiCreateInventoryTransferInput, options?: RequestOptions): Promise<Result<ApiCreateInventoryTransferResponse>>;
6805
6805
  /**
6806
6806
  * Creates an invoice draft. Provide exactly one source: order_id for an order-backed draft, or quick_pay for a hidden backing-order draft.
6807
6807
  * POST /v1/invoices
6808
- * @example client.api.createInvoice({"body":{"order_id":"example"}})
6808
+ * @example client.api.createInvoice({body: {order_id: "example"}})
6809
6809
  */
6810
6810
  createInvoice(input: ApiCreateInvoiceInput, options?: RequestOptions): Promise<Result<ApiCreateInvoiceResponse>>;
6811
6811
  /**
6812
6812
  * Create invoice payment term for the authenticated merchant.
6813
6813
  * POST /v1/invoice-payment-terms
6814
- * @example client.api.createInvoicePaymentTerm({"body":{"name":"example","calculation":{"type":"on_receipt"}}})
6814
+ * @example client.api.createInvoicePaymentTerm({body: {name: "example", calculation: {type: "on_receipt"}}})
6815
6815
  */
6816
6816
  createInvoicePaymentTerm(input: ApiCreateInvoicePaymentTermInput, options?: RequestOptions): Promise<Result<ApiCreateInvoicePaymentTermResponse>>;
6817
6817
  /**
6818
6818
  * Create a Location. Including the inventory block also requires commerce.inventory_locations.write.
6819
6819
  * POST /v1/locations
6820
- * @example client.api.createLocation({"body":{"address":{},"name":"example","timezone":"example"}})
6820
+ * @example client.api.createLocation({body: {address: {}, name: "example", timezone: "example"}})
6821
6821
  */
6822
6822
  createLocation(input: ApiCreateLocationInput, options?: RequestOptions): Promise<Result<ApiCreateLocationResponse>>;
6823
6823
  /**
6824
6824
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Creates a stable saved address. The first address becomes both the billing and shipping default. A saved default becomes the customer's effective address for the corresponding role.
6825
6825
  * POST /v1/me/addresses
6826
- * @example client.api.createMeAddress({"body":{"address":{"city":"example","country":"US","line1":"example","postal_code":"example","state":"example"},"recipient_name":"example"}})
6826
+ * @example client.api.createMeAddress({body: {address: {city: "example", country: "US", line1: "example", postal_code: "example", state: "example"}, recipient_name: "example"}})
6827
6827
  */
6828
6828
  createMeAddress(input: ApiCreateMeAddressInput, options?: RequestOptions): Promise<Result<ApiCreateMeAddressResponse>>;
6829
6829
  /**
@@ -6835,613 +6835,613 @@ export declare class Client {
6835
6835
  /**
6836
6836
  * Sends short-lived confirmation codes to the current and new email addresses. If the account has no current email, only the new address must be confirmed. The customer email does not change until confirmation succeeds.
6837
6837
  * POST /v1/me/email-change-requests
6838
- * @example client.api.createMeEmailChangeRequest({"body":{"new_email":"example"}})
6838
+ * @example client.api.createMeEmailChangeRequest({body: {new_email: "example"}})
6839
6839
  */
6840
6840
  createMeEmailChangeRequest(input: ApiCreateMeEmailChangeRequestInput, options?: RequestOptions): Promise<Result<ApiCreateMeEmailChangeRequestResponse>>;
6841
6841
  /**
6842
6842
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns the current open invoice checkout session and aligned card attempt when they still match the invoice balance and collection run. A newly created session and attempt share the fixed expiration of the active invoice public-link generation. Unexpired sessions are reused regardless of remaining lifetime; active payment work returns a resolving conflict instead of creating competing collection.
6843
6843
  * POST /v1/me/invoices/{invoice_id}/checkout-session
6844
- * @example client.api.createMeInvoiceCheckoutSession({"invoice_id":"example"})
6844
+ * @example client.api.createMeInvoiceCheckoutSession({invoice_id: "example"})
6845
6845
  */
6846
6846
  createMeInvoiceCheckoutSession(input: ApiCreateMeInvoiceCheckoutSessionInput, options?: RequestOptions): Promise<Result<ApiCreateMeInvoiceCheckoutSessionResponse>>;
6847
6847
  /**
6848
6848
  * Creates an embedded browser handoff for one or more allowlisted account components.
6849
6849
  * POST /v1/merchant-account-sessions
6850
- * @example client.api.createMerchantAccountSession({"body":{"components":["account_onboarding"]}})
6850
+ * @example client.api.createMerchantAccountSession({body: {components: ["account_onboarding"]}})
6851
6851
  */
6852
6852
  createMerchantAccountSession(input: ApiCreateMerchantAccountSessionInput, options?: RequestOptions): Promise<Result<ApiCreateMerchantAccountSessionResponse>>;
6853
6853
  /**
6854
6854
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Create a requested Return. When no policy matches, the Return remains available for merchant review rather than failing creation.
6855
6855
  * POST /v1/me/returns
6856
- * @example client.api.createMeReturn({"body":{"line_items":[{"order_line_item_id":"example","requested_quantity":"100","return_reason_id":"example"}],"order_id":"example"}})
6856
+ * @example client.api.createMeReturn({body: {line_items: [{order_line_item_id: "example", requested_quantity: "100", return_reason_id: "example"}], order_id: "example"}})
6857
6857
  */
6858
6858
  createMeReturn(input: ApiCreateMeReturnInput, options?: RequestOptions): Promise<Result<ApiCreateMeReturnResponse>>;
6859
6859
  /**
6860
6860
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Preview return eligibility or resolution amounts without creating a Return or reserving quantity. Set mode to eligibility or resolution and send the matching input object.
6861
6861
  * POST /v1/me/return-previews
6862
- * @example client.api.createMeReturnPreview({"body":{"mode":"eligibility","eligibility":{"order_id":"example","selection":{"selection_type":"all_remaining_fulfilled"}}}})
6862
+ * @example client.api.createMeReturnPreview({body: {mode: "eligibility", eligibility: {order_id: "example", selection: {selection_type: "all_remaining_fulfilled"}}}})
6863
6863
  */
6864
6864
  createMeReturnPreview(input: ApiCreateMeReturnPreviewInput, options?: RequestOptions): Promise<Result<ApiCreateMeReturnPreviewResponse>>;
6865
6865
  /**
6866
6866
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Create or reuse the standard hosted checkout session for a buyer-owed replacement Order linked to this Return resolution.
6867
6867
  * POST /v1/me/return-resolutions/{resolution_id}/checkout-session
6868
- * @example client.api.createMeReturnResolutionCheckoutSession({"resolution_id":"example"})
6868
+ * @example client.api.createMeReturnResolutionCheckoutSession({resolution_id: "example"})
6869
6869
  */
6870
6870
  createMeReturnResolutionCheckoutSession(input: ApiCreateMeReturnResolutionCheckoutSessionInput, options?: RequestOptions): Promise<Result<ApiCreateMeReturnResolutionCheckoutSessionResponse>>;
6871
6871
  /**
6872
6872
  * Create modifier group.
6873
6873
  * POST /v1/modifier-groups
6874
- * @example client.api.createModifierGroup({"body":{"name":"example"}})
6874
+ * @example client.api.createModifierGroup({body: {name: "example"}})
6875
6875
  */
6876
6876
  createModifierGroup(input: ApiCreateModifierGroupInput, options?: RequestOptions): Promise<Result<ApiCreateModifierGroupResponse>>;
6877
6877
  /**
6878
6878
  * Create modifier set.
6879
6879
  * POST /v1/modifier-sets
6880
- * @example client.api.createModifierSet({"body":{"name":"example"}})
6880
+ * @example client.api.createModifierSet({body: {name: "example"}})
6881
6881
  */
6882
6882
  createModifierSet(input: ApiCreateModifierSetInput, options?: RequestOptions): Promise<Result<ApiCreateModifierSetResponse>>;
6883
6883
  /**
6884
6884
  * Creates the first long-lived external API key and exits onboarding.
6885
6885
  * POST /v1/onboarding/api-key
6886
- * @example client.api.createOnboardingAPIKey({"body":{"name":"example"}})
6886
+ * @example client.api.createOnboardingAPIKey({body: {name: "example"}})
6887
6887
  */
6888
6888
  createOnboardingAPIKey(input: ApiCreateOnboardingAPIKeyInput, options?: RequestOptions): Promise<Result<ApiCreateOnboardingAPIKeyResponse>>;
6889
6889
  /**
6890
6890
  * Creates an order for the authenticated merchant. For USD orders, an effective requested tip may be up to the larger of $1,000 or 100% of the post-discount merchandise subtotal.
6891
6891
  * POST /v1/orders
6892
- * @example client.api.createOrder({"body":{"line_items":[{"variant_id":"example"}]}})
6892
+ * @example client.api.createOrder({body: {line_items: [{variant_id: "example"}]}})
6893
6893
  */
6894
6894
  createOrder(input: ApiCreateOrderInput, options?: RequestOptions): Promise<Result<ApiCreateOrderResponse>>;
6895
6895
  /**
6896
6896
  * Creates an immutable payment leg owned by the order. Collect a payment source using payment_collection, then submit that source through payOrder. This route requires commerce.orders.write; standalone payment-intent routes require payments.payment_intents.write.
6897
6897
  * POST /v1/orders/{order_id}/payment-intents
6898
- * @example client.api.createOrderPaymentIntent({"order_id":"example","body":{}})
6898
+ * @example client.api.createOrderPaymentIntent({order_id: "example", body: {}})
6899
6899
  */
6900
6900
  createOrderPaymentIntent(input: ApiCreateOrderPaymentIntentInput, options?: RequestOptions): Promise<Result<ApiCreateOrderPaymentIntentResponse>>;
6901
6901
  /**
6902
6902
  * Creates a child organization within the caller's accessible organization hierarchy.
6903
6903
  * POST /v1/organizations
6904
- * @example client.api.createOrganization({"body":{"name":"example"}})
6904
+ * @example client.api.createOrganization({body: {name: "example"}})
6905
6905
  */
6906
6906
  createOrganization(input: ApiCreateOrganizationInput, options?: RequestOptions): Promise<Result<ApiCreateOrganizationResponse>>;
6907
6907
  /**
6908
6908
  * Creates a package record under a shipment. Package status transitions use explicit future status APIs; this endpoint records package-level carrier, tracking, label, measurement, and external correlation fields.
6909
6909
  * POST /v1/shipments/{shipment_id}/packages
6910
- * @example client.api.createPackage({"shipment_id":"example","body":{}})
6910
+ * @example client.api.createPackage({shipment_id: "example", body: {}})
6911
6911
  */
6912
6912
  createPackage(input: ApiCreatePackageInput, options?: RequestOptions): Promise<Result<ApiCreatePackageResponse>>;
6913
6913
  /**
6914
6914
  * Adds an order line quantity to a package. Total active package item quantities cannot exceed the parent fulfillment line-item quantity.
6915
6915
  * POST /v1/packages/{package_id}/items
6916
- * @example client.api.createPackageItem({"package_id":"example","body":{"order_line_item_id":"example","quantity":"100"}})
6916
+ * @example client.api.createPackageItem({package_id: "example", body: {order_line_item_id: "example", quantity: "100"}})
6917
6917
  */
6918
6918
  createPackageItem(input: ApiCreatePackageItemInput, options?: RequestOptions): Promise<Result<ApiCreatePackageItemResponse>>;
6919
6919
  /**
6920
6920
  * Creates a standalone payment intent for the authenticated merchant. Create order-owned payment intents with POST /v1/orders/{order_id}/payment-intents.
6921
6921
  * POST /v1/payment-intents
6922
- * @example client.api.createPaymentIntent({"body":{"amount_money":{"amount":"0","currency":"USD"},"payment_options":["card"]}})
6922
+ * @example client.api.createPaymentIntent({body: {amount_money: {amount: "0", currency: "USD"}, payment_options: ["card"]}})
6923
6923
  */
6924
6924
  createPaymentIntent(input: ApiCreatePaymentIntentInput, options?: RequestOptions): Promise<Result<ApiCreatePaymentIntentResponse>>;
6925
6925
  /**
6926
6926
  * Creates a payment link for the authenticated merchant. Line items may use fixed prices, buyer-adjustable amounts, and buyer-adjustable quantities.
6927
6927
  * POST /v1/payment-links
6928
- * @example client.api.createPaymentLink({"body":{"name":"example"}})
6928
+ * @example client.api.createPaymentLink({body: {name: "example"}})
6929
6929
  */
6930
6930
  createPaymentLink(input: ApiCreatePaymentLinkInput, options?: RequestOptions): Promise<Result<ApiCreatePaymentLinkResponse>>;
6931
6931
  /**
6932
6932
  * Registers one exact domain or subdomain for Apple Pay and Google Pay in the selected Flint environment, then validates its wallet readiness.
6933
6933
  * POST /v1/payment-method-domains
6934
- * @example client.api.createPaymentMethodDomain({"body":{"domain_name":"payments.example.invalid"}})
6934
+ * @example client.api.createPaymentMethodDomain({body: {domain_name: "payments.example.invalid"}})
6935
6935
  */
6936
6936
  createPaymentMethodDomain(input: ApiCreatePaymentMethodDomainInput, options?: RequestOptions): Promise<Result<ApiCreatePaymentMethodDomainResponse>>;
6937
6937
  /**
6938
6938
  * Creates a payout from an available balance to an eligible payout destination. Safe to retry with the same Idempotency-Key.
6939
6939
  * POST /v1/payouts
6940
- * @example client.api.createPayout({"body":{"amount_money":{"amount":"0","currency":"USD"}}})
6940
+ * @example client.api.createPayout({body: {amount_money: {amount: "0", currency: "USD"}}})
6941
6941
  */
6942
6942
  createPayout(input: ApiCreatePayoutInput, options?: RequestOptions): Promise<Result<ApiCreatePayoutResponse>>;
6943
6943
  /**
6944
6944
  * Creates a product for the authenticated merchant.
6945
6945
  * POST /v1/products
6946
- * @example client.api.createProduct({"body":{"name":"example","product_type":"physical","default_variant":{"unit_price_money":{"amount":"0","currency":"USD"}}}})
6946
+ * @example client.api.createProduct({body: {name: "example", product_type: "physical", default_variant: {unit_price_money: {amount: "0", currency: "USD"}}}})
6947
6947
  */
6948
6948
  createProduct(input: ApiCreateProductInput, options?: RequestOptions): Promise<Result<ApiCreateProductResponse>>;
6949
6949
  /**
6950
6950
  * Create product variant.
6951
6951
  * POST /v1/products/{product_id}/variants
6952
- * @example client.api.createProductVariant({"product_id":"example","body":{"variant":{"unit_price_money":{"amount":"0","currency":"USD"}}}})
6952
+ * @example client.api.createProductVariant({product_id: "example", body: {variant: {unit_price_money: {amount: "0", currency: "USD"}}}})
6953
6953
  */
6954
6954
  createProductVariant(input: ApiCreateProductVariantInput, options?: RequestOptions): Promise<Result<ApiCreateProductVariantResponse>>;
6955
6955
  /**
6956
6956
  * Creates a promotion for the authenticated merchant.
6957
6957
  * POST /v1/promotions
6958
- * @example client.api.createPromotion({"body":{"application_method":{"percent_off":"1"},"name":"example"}})
6958
+ * @example client.api.createPromotion({body: {application_method: {percent_off: "1"}, name: "example"}})
6959
6959
  */
6960
6960
  createPromotion(input: ApiCreatePromotionInput, options?: RequestOptions): Promise<Result<ApiCreatePromotionResponse>>;
6961
6961
  /**
6962
6962
  * Creates a code for a code-gated promotion.
6963
6963
  * POST /v1/promotions/{promotion_id}/codes
6964
- * @example client.api.createPromotionCode({"promotion_id":"example","body":{"code":"example"}})
6964
+ * @example client.api.createPromotionCode({promotion_id: "example", body: {code: "example"}})
6965
6965
  */
6966
6966
  createPromotionCode(input: ApiCreatePromotionCodeInput, options?: RequestOptions): Promise<Result<ApiCreatePromotionCodeResponse>>;
6967
6967
  /**
6968
6968
  * Creates a refund for an order or payment intent. This is a financial operation.
6969
6969
  * POST /v1/refunds
6970
- * @example client.api.createRefund({"body":{"order_id":"example"}})
6970
+ * @example client.api.createRefund({body: {order_id: "example"}})
6971
6971
  */
6972
6972
  createRefund(input: ApiCreateRefundInput, options?: RequestOptions): Promise<Result<ApiCreateRefundResponse>>;
6973
6973
  /**
6974
6974
  * Creates an idempotent asynchronous CSV report. Poll the returned report until it succeeds or fails.
6975
6975
  * POST /v1/reports
6976
- * @example client.api.createReport({"body":{"currency":"USD","interval_end_at":"2026-01-01T00:00:00Z","interval_start_at":"2026-01-01T00:00:00Z","report_type":"orders_itemized_v1"}})
6976
+ * @example client.api.createReport({body: {currency: "USD", interval_end_at: "2026-01-01T00:00:00Z", interval_start_at: "2026-01-01T00:00:00Z", report_type: "orders_itemized_v1"}})
6977
6977
  */
6978
6978
  createReport(input: ApiCreateReportInput, options?: RequestOptions): Promise<Result<ApiCreateReportResponse>>;
6979
6979
  /**
6980
6980
  * Create a requested Return. When no policy matches, the Return remains available for merchant review rather than failing creation.
6981
6981
  * POST /v1/returns
6982
- * @example client.api.createReturn({"body":{"line_items":[{"order_line_item_id":"example","requested_quantity":"100","return_reason_id":"example"}],"order_id":"example"}})
6982
+ * @example client.api.createReturn({body: {line_items: [{order_line_item_id: "example", requested_quantity: "100", return_reason_id: "example"}], order_id: "example"}})
6983
6983
  */
6984
6984
  createReturn(input: ApiCreateReturnInput, options?: RequestOptions): Promise<Result<ApiCreateReturnResponse>>;
6985
6985
  /**
6986
6986
  * Record an auditable merchandise disposition from either a receipt line or an inspection line.
6987
6987
  * POST /v1/returns/{return_id}/dispositions
6988
- * @example client.api.createReturnDisposition({"return_id":"example","body":{"disposition_type":"sellable","occurred_at":"2026-01-01T00:00:00Z","quantity":"100","reason":"inspection_result","return_receipt_line_item_id":"example"}})
6988
+ * @example client.api.createReturnDisposition({return_id: "example", body: {disposition_type: "sellable", occurred_at: "2026-01-01T00:00:00Z", quantity: "100", reason: "inspection_result", return_receipt_line_item_id: "example"}})
6989
6989
  */
6990
6990
  createReturnDisposition(input: ApiCreateReturnDispositionInput, options?: RequestOptions): Promise<Result<ApiCreateReturnDispositionResponse>>;
6991
6991
  /**
6992
6992
  * Record an immutable inspection observation. Corrections supersede an earlier inspection instead of editing physical history.
6993
6993
  * POST /v1/returns/{return_id}/inspections
6994
- * @example client.api.createReturnInspection({"return_id":"example","body":{"inspected_at":"2026-01-01T00:00:00Z","line_items":[{"acceptance_status":"accepted","condition":"new","quantity":"100","return_receipt_line_item_id":"example"}],"location_id":"example","return_receipt_id":"example"}})
6994
+ * @example client.api.createReturnInspection({return_id: "example", body: {inspected_at: "2026-01-01T00:00:00Z", line_items: [{acceptance_status: "accepted", condition: "new", quantity: "100", return_receipt_line_item_id: "example"}], location_id: "example", return_receipt_id: "example"}})
6995
6995
  */
6996
6996
  createReturnInspection(input: ApiCreateReturnInspectionInput, options?: RequestOptions): Promise<Result<ApiCreateReturnInspectionResponse>>;
6997
6997
  /**
6998
6998
  * Create a Return policy with its first revision. The policy ID is stable across revisions, and each published revision is immutable.
6999
6999
  * POST /v1/return-policies
7000
- * @example client.api.createReturnPolicy({"body":{"name":"example","revision":{"approval_mode":"automatic","eligibility_result":"ineligible","is_merchandise_return_required":true,"priority":1,"scope":{}}}})
7000
+ * @example client.api.createReturnPolicy({body: {name: "example", revision: {approval_mode: "automatic", eligibility_result: "ineligible", is_merchandise_return_required: true, priority: 1, scope: {}}}})
7001
7001
  */
7002
7002
  createReturnPolicy(input: ApiCreateReturnPolicyInput, options?: RequestOptions): Promise<Result<ApiCreateReturnPolicyResponse>>;
7003
7003
  /**
7004
7004
  * Preview return eligibility or resolution amounts without creating a Return or reserving quantity. Set mode to eligibility or resolution and send the matching input object.
7005
7005
  * POST /v1/return-previews
7006
- * @example client.api.createReturnPreview({"body":{"mode":"eligibility","eligibility":{"order_id":"example","selection":{"selection_type":"all_remaining_fulfilled"}}}})
7006
+ * @example client.api.createReturnPreview({body: {mode: "eligibility", eligibility: {order_id: "example", selection: {selection_type: "all_remaining_fulfilled"}}}})
7007
7007
  */
7008
7008
  createReturnPreview(input: ApiCreateReturnPreviewInput, options?: RequestOptions): Promise<Result<ApiCreateReturnPreviewResponse>>;
7009
7009
  /**
7010
7010
  * Create a merchant Return reason buyers can select. Buyer reasons are distinct from inspection findings, decline reasons, and Refund reasons.
7011
7011
  * POST /v1/return-reasons
7012
- * @example client.api.createReturnReason({"body":{"handle":"example","name":"example"}})
7012
+ * @example client.api.createReturnReason({body: {handle: "example", name: "example"}})
7013
7013
  */
7014
7014
  createReturnReason(input: ApiCreateReturnReasonInput, options?: RequestOptions): Promise<Result<ApiCreateReturnReasonResponse>>;
7015
7015
  /**
7016
7016
  * Record an immutable merchandise receipt observation. Corrections supersede an earlier receipt instead of editing physical history.
7017
7017
  * POST /v1/returns/{return_id}/receipts
7018
- * @example client.api.createReturnReceipt({"return_id":"example","body":{"line_items":[{"quantity":"100","return_line_item_id":"example"}],"received_at":"2026-01-01T00:00:00Z","receiving_location_id":"example"}})
7018
+ * @example client.api.createReturnReceipt({return_id: "example", body: {line_items: [{quantity: "100", return_line_item_id: "example"}], received_at: "2026-01-01T00:00:00Z", receiving_location_id: "example"}})
7019
7019
  */
7020
7020
  createReturnReceipt(input: ApiCreateReturnReceiptInput, options?: RequestOptions): Promise<Result<ApiCreateReturnReceiptResponse>>;
7021
7021
  /**
7022
7022
  * Propose a buyer-value outcome for approved quantity. Creating a resolution reserves line value. Confirmation is what freezes it and starts its effects.
7023
7023
  * POST /v1/returns/{return_id}/resolutions
7024
- * @example client.api.createReturnResolution({"body":{"line_items":[{"quantity":"1","return_line_item_id":"rtli_example"}],"resolution_type":"refund"},"return_id":"example"})
7024
+ * @example client.api.createReturnResolution({body: {line_items: [{quantity: "1", return_line_item_id: "rtli_example"}], resolution_type: "refund"}, return_id: "example"})
7025
7025
  */
7026
7026
  createReturnResolution(input: ApiCreateReturnResolutionInput, options?: RequestOptions): Promise<Result<ApiCreateReturnResolutionResponse>>;
7027
7027
  /**
7028
7028
  * Create a risk list for the authenticated merchant environment.
7029
7029
  * POST /v1/risk-lists
7030
- * @example client.api.createRiskList({"body":{"alias":"example","name":"example","item_type":"card_fingerprint"}})
7030
+ * @example client.api.createRiskList({body: {alias: "example", name: "example", item_type: "card_fingerprint"}})
7031
7031
  */
7032
7032
  createRiskList(input: ApiCreateRiskListInput, options?: RequestOptions): Promise<Result<ApiCreateRiskListResponse>>;
7033
7033
  /**
7034
7034
  * Create a risk preview for the authenticated merchant environment.
7035
7035
  * POST /v1/risk-previews
7036
- * @example client.api.createRiskPreview({"body":{"risk_rule_id":"rr_example"}})
7036
+ * @example client.api.createRiskPreview({body: {risk_rule_id: "rr_example"}})
7037
7037
  */
7038
7038
  createRiskPreview(input: ApiCreateRiskPreviewInput, options?: RequestOptions): Promise<Result<ApiCreateRiskPreviewResponse>>;
7039
7039
  /**
7040
7040
  * Create a risk rule for the authenticated merchant environment.
7041
7041
  * POST /v1/risk-rules
7042
- * @example client.api.createRiskRule({"body":{"action":"review","description":"Synthetic SDK example","predicate":{"attribute":"payment_method_type","operator":"eq","value":"card"}}})
7042
+ * @example client.api.createRiskRule({body: {action: "review", description: "Synthetic SDK example", predicate: {attribute: "payment_method_type", operator: "eq", value: "card"}}})
7043
7043
  */
7044
7044
  createRiskRule(input: ApiCreateRiskRuleInput, options?: RequestOptions): Promise<Result<ApiCreateRiskRuleResponse>>;
7045
7045
  /**
7046
7046
  * Creates a shipment execution record under a shipment-type fulfillment. A shipment groups one carrier leg. Create one package under it for each physical parcel, including single-parcel shipments.
7047
7047
  * POST /v1/fulfillments/{fulfillment_id}/shipments
7048
- * @example client.api.createShipment({"fulfillment_id":"example","body":{}})
7048
+ * @example client.api.createShipment({fulfillment_id: "example", body: {}})
7049
7049
  */
7050
7050
  createShipment(input: ApiCreateShipmentInput, options?: RequestOptions): Promise<Result<ApiCreateShipmentResponse>>;
7051
7051
  /**
7052
7052
  * Creates a subscription for the authenticated merchant.
7053
7053
  * POST /v1/subscriptions
7054
- * @example client.api.createSubscription({"body":{"billing_start":{"type":"immediate"},"customer_id":"example","plan_id":"example","billing_schedule":{"owner":"flint"}}})
7054
+ * @example client.api.createSubscription({body: {billing_start: {type: "immediate"}, customer_id: "example", plan_id: "example", billing_schedule: {owner: "flint"}}})
7055
7055
  */
7056
7056
  createSubscription(input: ApiCreateSubscriptionInput, options?: RequestOptions): Promise<Result<ApiCreateSubscriptionResponse>>;
7057
7057
  /**
7058
7058
  * Starts one manual collection attempt on a past-due subscription. Send no body, or an empty object. Poll the returned retry for the outcome.
7059
7059
  * POST /v1/subscriptions/{subscription_id}/payment-retries
7060
- * @example client.api.createSubscriptionPaymentRetry({"subscription_id":"example","Idempotency-Key":"example"})
7060
+ * @example client.api.createSubscriptionPaymentRetry({subscription_id: "example", "Idempotency-Key": "example"})
7061
7061
  */
7062
7062
  createSubscriptionPaymentRetry(input: ApiCreateSubscriptionPaymentRetryInput, options?: RequestOptions): Promise<Result<ApiCreateSubscriptionPaymentRetryResponse>>;
7063
7063
  /**
7064
7064
  * Creates a subscription plan for the authenticated merchant.
7065
7065
  * POST /v1/subscription-plans
7066
- * @example client.api.createSubscriptionPlan({"body":{"billing_interval":"daily","billing_interval_count":1,"currency":"USD","name":"example"}})
7066
+ * @example client.api.createSubscriptionPlan({body: {billing_interval: "daily", billing_interval_count: 1, currency: "USD", name: "example"}})
7067
7067
  */
7068
7068
  createSubscriptionPlan(input: ApiCreateSubscriptionPlanInput, options?: RequestOptions): Promise<Result<ApiCreateSubscriptionPlanResponse>>;
7069
7069
  /**
7070
7070
  * Creates a webhook endpoint and returns the signing secret once.
7071
7071
  * POST /v1/webhook-endpoints
7072
- * @example client.api.createWebhookEndpoint({"body":{"url":"example"}})
7072
+ * @example client.api.createWebhookEndpoint({body: {url: "example"}})
7073
7073
  */
7074
7074
  createWebhookEndpoint(input: ApiCreateWebhookEndpointInput, options?: RequestOptions): Promise<Result<ApiCreateWebhookEndpointResponse>>;
7075
7075
  /**
7076
7076
  * Creates and delivers a synthetic test webhook event to one active webhook endpoint. Safe to retry with the same Idempotency-Key.
7077
7077
  * POST /v1/webhook-endpoints/{webhook_endpoint_id}/test-events
7078
- * @example client.api.createWebhookTestEvent({"webhook_endpoint_id":"example","body":{"event_type":"balance.updated"}})
7078
+ * @example client.api.createWebhookTestEvent({webhook_endpoint_id: "example", body: {event_type: "balance.updated"}})
7079
7079
  */
7080
7080
  createWebhookTestEvent(input: ApiCreateWebhookTestEventInput, options?: RequestOptions): Promise<Result<ApiCreateWebhookTestEventResponse>>;
7081
7081
  /**
7082
7082
  * Record per-line Return decisions atomically. Each line selects policy_evaluation or explicit decision semantics.
7083
7083
  * POST /v1/returns/{return_id}/decide
7084
- * @example client.api.decideReturn({"return_id":"example","body":{"line_items":[{"approved_quantity":"0","decision_basis":"policy_evaluation","return_line_item_id":"example"}]}})
7084
+ * @example client.api.decideReturn({return_id: "example", body: {line_items: [{approved_quantity: "0", decision_basis: "policy_evaluation", return_line_item_id: "example"}]}})
7085
7085
  */
7086
7086
  decideReturn(input: ApiDecideReturnInput, options?: RequestOptions): Promise<Result<ApiDecideReturnResponse>>;
7087
7087
  /**
7088
7088
  * Record the accept or reject outcome for inspected quantity. Accepted quantity becomes dispositionable and satisfies after_inspection refund timing.
7089
7089
  * POST /v1/return-inspections/{return_inspection_id}/line-items/{return_inspection_line_item_id}/decide
7090
- * @example client.api.decideReturnInspectionLineItem({"return_inspection_id":"example","return_inspection_line_item_id":"example","body":{"acceptance_decision_reason":"inspection_result","acceptance_status":"accepted"}})
7090
+ * @example client.api.decideReturnInspectionLineItem({return_inspection_id: "example", return_inspection_line_item_id: "example", body: {acceptance_decision_reason: "inspection_result", acceptance_status: "accepted"}})
7091
7091
  */
7092
7092
  decideReturnInspectionLineItem(input: ApiDecideReturnInspectionLineItemInput, options?: RequestOptions): Promise<Result<ApiDecideReturnInspectionLineItemResponse>>;
7093
7093
  /**
7094
7094
  * Decline a payment review for the authenticated merchant environment.
7095
7095
  * POST /v1/reviews/{review_id}/decline
7096
- * @example client.api.declineReview({"review_id":"example"})
7096
+ * @example client.api.declineReview({review_id: "example"})
7097
7097
  */
7098
7098
  declineReview(input: ApiDeclineReviewInput, options?: RequestOptions): Promise<Result<ApiDeclineReviewResponse>>;
7099
7099
  /**
7100
7100
  * Archives a bundle and returns its final state.
7101
7101
  * DELETE /v1/bundles/{bundle_id}
7102
- * @example client.api.deleteBundle({"bundle_id":"example"})
7102
+ * @example client.api.deleteBundle({bundle_id: "example"})
7103
7103
  */
7104
7104
  deleteBundle(input: ApiDeleteBundleInput, options?: RequestOptions): Promise<Result<ApiDeleteBundleResponse>>;
7105
7105
  /**
7106
7106
  * Delete category.
7107
7107
  * DELETE /v1/categories/{category_id}
7108
- * @example client.api.deleteCategory({"category_id":"example"})
7108
+ * @example client.api.deleteCategory({category_id: "example"})
7109
7109
  */
7110
7110
  deleteCategory(input: ApiDeleteCategoryInput, options?: RequestOptions): Promise<Result<ApiDeleteCategoryResponse>>;
7111
7111
  /**
7112
7112
  * Atomically clears a provisional selection, releases inventory, removes its charges, and recalculates order economics.
7113
7113
  * DELETE /v1/checkout-sessions/{checkout_session_id}/delivery-selections/current
7114
- * @example client.api.deleteCheckoutSessionCurrentDeliverySelection({"checkout_session_id":"example","expected_delivery_selection_id":"example"})
7114
+ * @example client.api.deleteCheckoutSessionCurrentDeliverySelection({checkout_session_id: "example", expected_delivery_selection_id: "example"})
7115
7115
  */
7116
7116
  deleteCheckoutSessionCurrentDeliverySelection(input: ApiDeleteCheckoutSessionCurrentDeliverySelectionInput, options?: RequestOptions): Promise<Result<ApiDeleteCheckoutSessionCurrentDeliverySelectionResponse>>;
7117
7117
  /**
7118
7118
  * Deletes a saved address and moves any default designation to the newest remaining address.
7119
7119
  * DELETE /v1/customers/{customer_id}/addresses/{customer_address_id}
7120
- * @example client.api.deleteCustomerAddress({"customer_id":"example","customer_address_id":"example"})
7120
+ * @example client.api.deleteCustomerAddress({customer_id: "example", customer_address_id: "example"})
7121
7121
  */
7122
7122
  deleteCustomerAddress(input: ApiDeleteCustomerAddressInput, options?: RequestOptions): Promise<Result<ApiDeleteCustomerAddressResponse>>;
7123
7123
  /**
7124
7124
  * Retires the delivery location set after checking current dependencies. The retired resource remains available by ID for historical records.
7125
7125
  * DELETE /v1/delivery-location-sets/{delivery_location_set_id}
7126
- * @example client.api.deleteDeliveryLocationSet({"delivery_location_set_id":"example"})
7126
+ * @example client.api.deleteDeliveryLocationSet({delivery_location_set_id: "example"})
7127
7127
  */
7128
7128
  deleteDeliveryLocationSet(input: ApiDeleteDeliveryLocationSetInput, options?: RequestOptions): Promise<Result<ApiDeleteDeliveryLocationSetResponse>>;
7129
7129
  /**
7130
7130
  * Retires the delivery method after checking current dependencies. The retired resource remains available by ID for historical records.
7131
7131
  * DELETE /v1/delivery-methods/{delivery_method_id}
7132
- * @example client.api.deleteDeliveryMethod({"delivery_method_id":"example"})
7132
+ * @example client.api.deleteDeliveryMethod({delivery_method_id: "example"})
7133
7133
  */
7134
7134
  deleteDeliveryMethod(input: ApiDeleteDeliveryMethodInput, options?: RequestOptions): Promise<Result<ApiDeleteDeliveryMethodResponse>>;
7135
7135
  /**
7136
7136
  * Retires the delivery profile after checking current dependencies. The retired resource remains available by ID for historical records.
7137
7137
  * DELETE /v1/delivery-profiles/{delivery_profile_id}
7138
- * @example client.api.deleteDeliveryProfile({"delivery_profile_id":"example"})
7138
+ * @example client.api.deleteDeliveryProfile({delivery_profile_id: "example"})
7139
7139
  */
7140
7140
  deleteDeliveryProfile(input: ApiDeleteDeliveryProfileInput, options?: RequestOptions): Promise<Result<ApiDeleteDeliveryProfileResponse>>;
7141
7141
  /**
7142
7142
  * Retires the delivery rate callback after checking current dependencies. The retired resource remains available by ID for historical records.
7143
7143
  * DELETE /v1/delivery-rate-callbacks/{delivery_rate_callback_id}
7144
- * @example client.api.deleteDeliveryRateCallback({"delivery_rate_callback_id":"example"})
7144
+ * @example client.api.deleteDeliveryRateCallback({delivery_rate_callback_id: "example"})
7145
7145
  */
7146
7146
  deleteDeliveryRateCallback(input: ApiDeleteDeliveryRateCallbackInput, options?: RequestOptions): Promise<Result<ApiDeleteDeliveryRateCallbackResponse>>;
7147
7147
  /**
7148
7148
  * Retires the delivery zone after checking current dependencies. The retired resource remains available by ID for historical records.
7149
7149
  * DELETE /v1/delivery-zones/{delivery_zone_id}
7150
- * @example client.api.deleteDeliveryZone({"delivery_zone_id":"example"})
7150
+ * @example client.api.deleteDeliveryZone({delivery_zone_id: "example"})
7151
7151
  */
7152
7152
  deleteDeliveryZone(input: ApiDeleteDeliveryZoneInput, options?: RequestOptions): Promise<Result<ApiDeleteDeliveryZoneResponse>>;
7153
7153
  /**
7154
7154
  * Retires a non-default sandbox and frees its original name for reuse.
7155
7155
  * DELETE /v1/developer/sandboxes/{sandbox_id}
7156
- * @example client.api.deleteDeveloperSandbox({"sandbox_id":"example"})
7156
+ * @example client.api.deleteDeveloperSandbox({sandbox_id: "example"})
7157
7157
  */
7158
7158
  deleteDeveloperSandbox(input: ApiDeleteDeveloperSandboxInput, options?: RequestOptions): Promise<Result<ApiDeleteDeveloperSandboxResponse>>;
7159
7159
  /**
7160
7160
  * Marks a device as deleted and returns its final state.
7161
7161
  * DELETE /v1/devices/{device_id}
7162
- * @example client.api.deleteDevice({"device_id":"example"})
7162
+ * @example client.api.deleteDevice({device_id: "example"})
7163
7163
  */
7164
7164
  deleteDevice(input: ApiDeleteDeviceInput, options?: RequestOptions): Promise<Result<ApiDeleteDeviceResponse>>;
7165
7165
  /**
7166
7166
  * Retire an allocation policy. keeps the archived resource available in list results.
7167
7167
  * DELETE /v1/inventory-allocation-policies/{inventory_allocation_policy_id}
7168
- * @example client.api.deleteInventoryAllocationPolicy({"inventory_allocation_policy_id":"example"})
7168
+ * @example client.api.deleteInventoryAllocationPolicy({inventory_allocation_policy_id: "example"})
7169
7169
  */
7170
7170
  deleteInventoryAllocationPolicy(input: ApiDeleteInventoryAllocationPolicyInput, options?: RequestOptions): Promise<Result<ApiDeleteInventoryAllocationPolicyResponse>>;
7171
7171
  /**
7172
7172
  * Retire an inventory item. keeps the archived resource available in list results.
7173
7173
  * DELETE /v1/inventory-items/{inventory_item_id}
7174
- * @example client.api.deleteInventoryItem({"inventory_item_id":"example"})
7174
+ * @example client.api.deleteInventoryItem({inventory_item_id: "example"})
7175
7175
  */
7176
7176
  deleteInventoryItem(input: ApiDeleteInventoryItemInput, options?: RequestOptions): Promise<Result<ApiDeleteInventoryItemResponse>>;
7177
7177
  /**
7178
7178
  * Retires an invoice payment term by setting its status to archived. A default payment term cannot be retired.
7179
7179
  * DELETE /v1/invoice-payment-terms/{invoice_payment_term_id}
7180
- * @example client.api.deleteInvoicePaymentTerm({"invoice_payment_term_id":"example"})
7180
+ * @example client.api.deleteInvoicePaymentTerm({invoice_payment_term_id: "example"})
7181
7181
  */
7182
7182
  deleteInvoicePaymentTerm(input: ApiDeleteInvoicePaymentTermInput, options?: RequestOptions): Promise<Result<ApiDeleteInvoicePaymentTermResponse>>;
7183
7183
  /**
7184
7184
  * Retire a Location. Preserves the archived resource for direct reads.
7185
7185
  * DELETE /v1/locations/{location_id}
7186
- * @example client.api.deleteLocation({"location_id":"example"})
7186
+ * @example client.api.deleteLocation({location_id: "example"})
7187
7187
  */
7188
7188
  deleteLocation(input: ApiDeleteLocationInput, options?: RequestOptions): Promise<Result<ApiDeleteLocationResponse>>;
7189
7189
  /**
7190
7190
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Deletes a saved address and moves any default designation to the newest remaining address.
7191
7191
  * DELETE /v1/me/addresses/{customer_address_id}
7192
- * @example client.api.deleteMeAddress({"customer_address_id":"example"})
7192
+ * @example client.api.deleteMeAddress({customer_address_id: "example"})
7193
7193
  */
7194
7194
  deleteMeAddress(input: ApiDeleteMeAddressInput, options?: RequestOptions): Promise<Result<ApiDeleteMeAddressResponse>>;
7195
7195
  /**
7196
7196
  * Retire modifier group.
7197
7197
  * DELETE /v1/modifier-groups/{modifier_group_id}
7198
- * @example client.api.deleteModifierGroup({"modifier_group_id":"example"})
7198
+ * @example client.api.deleteModifierGroup({modifier_group_id: "example"})
7199
7199
  */
7200
7200
  deleteModifierGroup(input: ApiDeleteModifierGroupInput, options?: RequestOptions): Promise<Result<ApiDeleteModifierGroupResponse>>;
7201
7201
  /**
7202
7202
  * Retire modifier set.
7203
7203
  * DELETE /v1/modifier-sets/{modifier_set_id}
7204
- * @example client.api.deleteModifierSet({"modifier_set_id":"example"})
7204
+ * @example client.api.deleteModifierSet({modifier_set_id: "example"})
7205
7205
  */
7206
7206
  deleteModifierSet(input: ApiDeleteModifierSetInput, options?: RequestOptions): Promise<Result<ApiDeleteModifierSetResponse>>;
7207
7207
  /**
7208
7208
  * Removes a single service charge, fee, or surcharge from an order.
7209
7209
  * DELETE /v1/orders/{order_id}/charges/{order_charge_id}
7210
- * @example client.api.deleteOrderCharge({"order_id":"example","order_charge_id":"example"})
7210
+ * @example client.api.deleteOrderCharge({order_id: "example", order_charge_id: "example"})
7211
7211
  */
7212
7212
  deleteOrderCharge(input: ApiDeleteOrderChargeInput, options?: RequestOptions): Promise<Result<ApiDeleteOrderChargeResponse>>;
7213
7213
  /**
7214
7214
  * Removes a single line item from an order.
7215
7215
  * DELETE /v1/orders/{order_id}/line-items/{order_line_item_id}
7216
- * @example client.api.deleteOrderLineItem({"order_id":"example","order_line_item_id":"example"})
7216
+ * @example client.api.deleteOrderLineItem({order_id: "example", order_line_item_id: "example"})
7217
7217
  */
7218
7218
  deleteOrderLineItem(input: ApiDeleteOrderLineItemInput, options?: RequestOptions): Promise<Result<ApiDeleteOrderLineItemResponse>>;
7219
7219
  /**
7220
7220
  * Soft-deletes an organization when it has no active descendants or merchant links.
7221
7221
  * DELETE /v1/organizations/{organization_id}
7222
- * @example client.api.deleteOrganization({"organization_id":"example"})
7222
+ * @example client.api.deleteOrganization({organization_id: "example"})
7223
7223
  */
7224
7224
  deleteOrganization(input: ApiDeleteOrganizationInput, options?: RequestOptions): Promise<Result<ApiDeleteOrganizationResponse>>;
7225
7225
  /**
7226
7226
  * Removes an order line quantity from a package while the package is still mutable.
7227
7227
  * DELETE /v1/packages/{package_id}/items/{package_item_id}
7228
- * @example client.api.deletePackageItem({"package_id":"example","package_item_id":"example"})
7228
+ * @example client.api.deletePackageItem({package_id: "example", package_item_id: "example"})
7229
7229
  */
7230
7230
  deletePackageItem(input: ApiDeletePackageItemInput, options?: RequestOptions): Promise<Result<ApiDeletePackageItemResponse>>;
7231
7231
  /**
7232
7232
  * Disables an eligible payout destination and returns its final state. Safe to retry with the same Idempotency-Key.
7233
7233
  * DELETE /v1/payout-settings/destinations/{payout_destination_id}
7234
- * @example client.api.deletePayoutDestination({"payout_destination_id":"example","body":{}})
7234
+ * @example client.api.deletePayoutDestination({payout_destination_id: "example", body: {}})
7235
7235
  */
7236
7236
  deletePayoutDestination(input: ApiDeletePayoutDestinationInput, options?: RequestOptions): Promise<Result<ApiDeletePayoutDestinationResponse>>;
7237
7237
  /**
7238
7238
  * Archives a product and returns its final state.
7239
7239
  * DELETE /v1/products/{product_id}
7240
- * @example client.api.deleteProduct({"product_id":"example"})
7240
+ * @example client.api.deleteProduct({product_id: "example"})
7241
7241
  */
7242
7242
  deleteProduct(input: ApiDeleteProductInput, options?: RequestOptions): Promise<Result<ApiDeleteProductResponse>>;
7243
7243
  /**
7244
7244
  * Retire product variant.
7245
7245
  * DELETE /v1/products/{product_id}/variants/{variant_id}
7246
- * @example client.api.deleteProductVariant({"product_id":"example","variant_id":"example"})
7246
+ * @example client.api.deleteProductVariant({product_id: "example", variant_id: "example"})
7247
7247
  */
7248
7248
  deleteProductVariant(input: ApiDeleteProductVariantInput, options?: RequestOptions): Promise<Result<ApiDeleteProductVariantResponse>>;
7249
7249
  /**
7250
7250
  * Archives a promotion and returns its final state.
7251
7251
  * DELETE /v1/promotions/{promotion_id}
7252
- * @example client.api.deletePromotion({"promotion_id":"example"})
7252
+ * @example client.api.deletePromotion({promotion_id: "example"})
7253
7253
  */
7254
7254
  deletePromotion(input: ApiDeletePromotionInput, options?: RequestOptions): Promise<Result<ApiDeletePromotionResponse>>;
7255
7255
  /**
7256
7256
  * Deletes a promotion code.
7257
7257
  * DELETE /v1/promotions/{promotion_id}/codes/{promotion_code_id}
7258
- * @example client.api.deletePromotionCode({"promotion_id":"example","promotion_code_id":"example"})
7258
+ * @example client.api.deletePromotionCode({promotion_id: "example", promotion_code_id: "example"})
7259
7259
  */
7260
7260
  deletePromotionCode(input: ApiDeletePromotionCodeInput, options?: RequestOptions): Promise<Result<ApiDeletePromotionCodeResponse>>;
7261
7261
  /**
7262
7262
  * Remove a line item from a requested Return. The response is the updated Return.
7263
7263
  * DELETE /v1/returns/{return_id}/line-items/{return_line_item_id}
7264
- * @example client.api.deleteReturnLineItem({"return_id":"example","return_line_item_id":"example"})
7264
+ * @example client.api.deleteReturnLineItem({return_id: "example", return_line_item_id: "example"})
7265
7265
  */
7266
7266
  deleteReturnLineItem(input: ApiDeleteReturnLineItemInput, options?: RequestOptions): Promise<Result<ApiDeleteReturnLineItemResponse>>;
7267
7267
  /**
7268
7268
  * Retire a Return policy so it is no longer evaluated and no longer appears as an active choice.
7269
7269
  * DELETE /v1/return-policies/{return_policy_id}
7270
- * @example client.api.deleteReturnPolicy({"return_policy_id":"example"})
7270
+ * @example client.api.deleteReturnPolicy({return_policy_id: "example"})
7271
7271
  */
7272
7272
  deleteReturnPolicy(input: ApiDeleteReturnPolicyInput, options?: RequestOptions): Promise<Result<ApiDeleteReturnPolicyResponse>>;
7273
7273
  /**
7274
7274
  * Retire a Return reason so buyers can no longer select it. Returns that already recorded it keep the frozen reason name.
7275
7275
  * DELETE /v1/return-reasons/{return_reason_id}
7276
- * @example client.api.deleteReturnReason({"return_reason_id":"example"})
7276
+ * @example client.api.deleteReturnReason({return_reason_id: "example"})
7277
7277
  */
7278
7278
  deleteReturnReason(input: ApiDeleteReturnReasonInput, options?: RequestOptions): Promise<Result<ApiDeleteReturnReasonResponse>>;
7279
7279
  /**
7280
7280
  * Retire a risk list for the authenticated merchant environment.
7281
7281
  * DELETE /v1/risk-lists/{risk_list_id}
7282
- * @example client.api.deleteRiskList({"risk_list_id":"example"})
7282
+ * @example client.api.deleteRiskList({risk_list_id: "example"})
7283
7283
  */
7284
7284
  deleteRiskList(input: ApiDeleteRiskListInput, options?: RequestOptions): Promise<Result<ApiDeleteRiskListResponse>>;
7285
7285
  /**
7286
7286
  * Delete a risk list item for the authenticated merchant environment.
7287
7287
  * DELETE /v1/risk-lists/{risk_list_id}/items/{risk_list_item_id}
7288
- * @example client.api.deleteRiskListItem({"risk_list_id":"example","risk_list_item_id":"example"})
7288
+ * @example client.api.deleteRiskListItem({risk_list_id: "example", risk_list_item_id: "example"})
7289
7289
  */
7290
7290
  deleteRiskListItem(input: ApiDeleteRiskListItemInput, options?: RequestOptions): Promise<Result<ApiDeleteRiskListItemResponse>>;
7291
7291
  /**
7292
7292
  * Retire a risk rule for the authenticated merchant environment.
7293
7293
  * DELETE /v1/risk-rules/{risk_rule_id}
7294
- * @example client.api.deleteRiskRule({"risk_rule_id":"example"})
7294
+ * @example client.api.deleteRiskRule({risk_rule_id: "example"})
7295
7295
  */
7296
7296
  deleteRiskRule(input: ApiDeleteRiskRuleInput, options?: RequestOptions): Promise<Result<ApiDeleteRiskRuleResponse>>;
7297
7297
  /**
7298
7298
  * Retires a subscription plan. Plans with active subscriptions cannot be retired.
7299
7299
  * DELETE /v1/subscription-plans/{plan_id}
7300
- * @example client.api.deleteSubscriptionPlan({"plan_id":"example"})
7300
+ * @example client.api.deleteSubscriptionPlan({plan_id: "example"})
7301
7301
  */
7302
7302
  deleteSubscriptionPlan(input: ApiDeleteSubscriptionPlanInput, options?: RequestOptions): Promise<Result<ApiDeleteSubscriptionPlanResponse>>;
7303
7303
  /**
7304
7304
  * Marks a webhook endpoint as deleted so it no longer receives events.
7305
7305
  * DELETE /v1/webhook-endpoints/{webhook_endpoint_id}
7306
- * @example client.api.deleteWebhookEndpoint({"webhook_endpoint_id":"example"})
7306
+ * @example client.api.deleteWebhookEndpoint({webhook_endpoint_id: "example"})
7307
7307
  */
7308
7308
  deleteWebhookEndpoint(input: ApiDeleteWebhookEndpointInput, options?: RequestOptions): Promise<Result<ApiDeleteWebhookEndpointResponse>>;
7309
7309
  /**
7310
7310
  * Exchanges an authorization code or refresh token for an installation-scoped bearer token. This endpoint follows OAuth token endpoint conventions: it accepts application/x-www-form-urlencoded requests as well as JSON and returns OAuth token error objects for token exchange failures instead of the normal Flint error envelope.
7311
7311
  * POST /v1/oauth/token
7312
- * @example client.api.exchangePartnerInstallToken({"body":{"client_id":"example","client_secret":"example","grant_type":"example"}})
7312
+ * @example client.api.exchangePartnerInstallToken({body: {client_id: "example", client_secret: "example", grant_type: "example"}})
7313
7313
  */
7314
7314
  exchangePartnerInstallToken(input: ApiExchangePartnerInstallTokenInput, options?: RequestOptions): Promise<Result<ApiExchangePartnerInstallTokenResponse>>;
7315
7315
  /**
7316
7316
  * Returns high-level merchant analytics for the requested time range.
7317
7317
  * GET /v1/analytics/overview
7318
- * @example client.api.getAnalyticsOverview({"range":"today"})
7318
+ * @example client.api.getAnalyticsOverview({range: "today"})
7319
7319
  */
7320
7320
  getAnalyticsOverview(input: ApiGetAnalyticsOverviewInput, options?: RequestOptions): Promise<Result<ApiGetAnalyticsOverviewResponse>>;
7321
7321
  /**
7322
7322
  * Returns external API key metadata. Secrets, internal keys, and demo-session keys are not returned.
7323
7323
  * GET /v1/api-keys/{api_key_id}
7324
- * @example client.api.getAPIKey({"api_key_id":"example"})
7324
+ * @example client.api.getAPIKey({api_key_id: "example"})
7325
7325
  */
7326
7326
  getAPIKey(input: ApiGetAPIKeyInput, options?: RequestOptions): Promise<Result<ApiGetAPIKeyResponse>>;
7327
7327
  /**
7328
7328
  * Returns one balance transaction by ID, with optional related order expansion.
7329
7329
  * GET /v1/balance-transactions/{balance_transaction_id}
7330
- * @example client.api.getBalanceTransaction({"balance_transaction_id":"example"})
7330
+ * @example client.api.getBalanceTransaction({balance_transaction_id: "example"})
7331
7331
  */
7332
7332
  getBalanceTransaction(input: ApiGetBalanceTransactionInput, options?: RequestOptions): Promise<Result<ApiGetBalanceTransactionResponse>>;
7333
7333
  /**
7334
7334
  * Get bundle.
7335
7335
  * GET /v1/bundles/{bundle_id}
7336
- * @example client.api.getBundle({"bundle_id":"example"})
7336
+ * @example client.api.getBundle({bundle_id: "example"})
7337
7337
  */
7338
7338
  getBundle(input: ApiGetBundleInput, options?: RequestOptions): Promise<Result<ApiGetBundleResponse>>;
7339
7339
  /**
7340
7340
  * Get category.
7341
7341
  * GET /v1/categories/{category_id}
7342
- * @example client.api.getCategory({"category_id":"example"})
7342
+ * @example client.api.getCategory({category_id: "example"})
7343
7343
  */
7344
7344
  getCategory(input: ApiGetCategoryInput, options?: RequestOptions): Promise<Result<ApiGetCategoryResponse>>;
7345
7345
  /**
7346
7346
  * Returns a single checkout session by ID.
7347
7347
  * GET /v1/checkout-sessions/{checkout_session_id}
7348
- * @example client.api.getCheckoutSession({"checkout_session_id":"example"})
7348
+ * @example client.api.getCheckoutSession({checkout_session_id: "example"})
7349
7349
  */
7350
7350
  getCheckoutSession(input: ApiGetCheckoutSessionInput, options?: RequestOptions): Promise<Result<ApiGetCheckoutSessionResponse>>;
7351
7351
  /**
7352
7352
  * Returns the provisional selection or the order-level committed selection effective for this checkout.
7353
7353
  * GET /v1/checkout-sessions/{checkout_session_id}/delivery-selections/current
7354
- * @example client.api.getCheckoutSessionCurrentDeliverySelection({"checkout_session_id":"example"})
7354
+ * @example client.api.getCheckoutSessionCurrentDeliverySelection({checkout_session_id: "example"})
7355
7355
  */
7356
7356
  getCheckoutSessionCurrentDeliverySelection(input: ApiGetCheckoutSessionCurrentDeliverySelectionInput, options?: RequestOptions): Promise<Result<ApiGetCheckoutSessionCurrentDeliverySelectionResponse>>;
7357
7357
  /**
7358
7358
  * Returns one quote under its checkout authority. Buyer credentials receive the buyer-safe projection.
7359
7359
  * GET /v1/checkout-sessions/{checkout_session_id}/delivery-quotes/{delivery_quote_id}
7360
- * @example client.api.getCheckoutSessionDeliveryQuote({"checkout_session_id":"example","delivery_quote_id":"example"})
7360
+ * @example client.api.getCheckoutSessionDeliveryQuote({checkout_session_id: "example", delivery_quote_id: "example"})
7361
7361
  */
7362
7362
  getCheckoutSessionDeliveryQuote(input: ApiGetCheckoutSessionDeliveryQuoteInput, options?: RequestOptions): Promise<Result<ApiGetCheckoutSessionDeliveryQuoteResponse>>;
7363
7363
  /**
7364
7364
  * Returns one checkout selection with immutable economics, lifecycle events, and retention-aware private data.
7365
7365
  * GET /v1/checkout-sessions/{checkout_session_id}/delivery-selections/{delivery_selection_id}
7366
- * @example client.api.getCheckoutSessionDeliverySelectionHistory({"checkout_session_id":"example","delivery_selection_id":"example"})
7366
+ * @example client.api.getCheckoutSessionDeliverySelectionHistory({checkout_session_id: "example", delivery_selection_id: "example"})
7367
7367
  */
7368
7368
  getCheckoutSessionDeliverySelectionHistory(input: ApiGetCheckoutSessionDeliverySelectionHistoryInput, options?: RequestOptions): Promise<Result<ApiGetCheckoutSessionDeliverySelectionHistoryResponse>>;
7369
7369
  /**
7370
7370
  * Returns one credit note with its lines, total, and the credit still available to allocate.
7371
7371
  * GET /v1/credit-notes/{credit_note_id}
7372
- * @example client.api.getCreditNote({"credit_note_id":"example"})
7372
+ * @example client.api.getCreditNote({credit_note_id: "example"})
7373
7373
  */
7374
7374
  getCreditNote(input: ApiGetCreditNoteInput, options?: RequestOptions): Promise<Result<ApiGetCreditNoteResponse>>;
7375
7375
  /**
7376
7376
  * Returns one allocation. A non-null reversed_at means the credit was returned to the credit note and the invoice balance reopened.
7377
7377
  * GET /v1/credit-notes/{credit_note_id}/allocations/{credit_note_allocation_id}
7378
- * @example client.api.getCreditNoteAllocation({"credit_note_id":"example","credit_note_allocation_id":"example"})
7378
+ * @example client.api.getCreditNoteAllocation({credit_note_id: "example", credit_note_allocation_id: "example"})
7379
7379
  */
7380
7380
  getCreditNoteAllocation(input: ApiGetCreditNoteAllocationInput, options?: RequestOptions): Promise<Result<ApiGetCreditNoteAllocationResponse>>;
7381
7381
  /**
7382
7382
  * Returns the credit note document as application/pdf rather than a JSON envelope. The PDF exists from issue onward and carries your branding, the credited lines, and the invoice it corrects.
7383
7383
  * GET /v1/credit-notes/{credit_note_id}/pdf
7384
- * @example client.api.getCreditNotePDF({"credit_note_id":"example"})
7384
+ * @example client.api.getCreditNotePDF({credit_note_id: "example"})
7385
7385
  */
7386
7386
  getCreditNotePDF(input: ApiGetCreditNotePDFInput, options?: RequestOptions): Promise<Result<ApiGetCreditNotePDFResponse>>;
7387
7387
  /**
7388
7388
  * Returns redacted request log detail for a request generated by the authenticated API key. Detail responses remain current-key scoped and redact headers, query parameters, request bodies, and response bodies before returning them.
7389
7389
  * GET /v1/developer/request-logs/{api_request_log_id}
7390
- * @example client.api.getCurrentAPIKeyRequestLog({"api_request_log_id":"example"})
7390
+ * @example client.api.getCurrentAPIKeyRequestLog({api_request_log_id: "example"})
7391
7391
  */
7392
7392
  getCurrentAPIKeyRequestLog(input: ApiGetCurrentAPIKeyRequestLogInput, options?: RequestOptions): Promise<Result<ApiGetCurrentAPIKeyRequestLogResponse>>;
7393
7393
  /**
7394
7394
  * Returns a single customer by ID.
7395
7395
  * GET /v1/customers/{customer_id}
7396
- * @example client.api.getCustomer({"customer_id":"example"})
7396
+ * @example client.api.getCustomer({customer_id: "example"})
7397
7397
  */
7398
7398
  getCustomer(input: ApiGetCustomerInput, options?: RequestOptions): Promise<Result<ApiGetCustomerResponse>>;
7399
7399
  /**
7400
7400
  * Returns one saved address owned by the customer.
7401
7401
  * GET /v1/customers/{customer_id}/addresses/{customer_address_id}
7402
- * @example client.api.getCustomerAddress({"customer_id":"example","customer_address_id":"example"})
7402
+ * @example client.api.getCustomerAddress({customer_id: "example", customer_address_id: "example"})
7403
7403
  */
7404
7404
  getCustomerAddress(input: ApiGetCustomerAddressInput, options?: RequestOptions): Promise<Result<ApiGetCustomerAddressResponse>>;
7405
7405
  /**
7406
7406
  * Returns the current status of a tracked deletion request.
7407
7407
  * GET /v1/customers/{customer_id}/deletion-requests/{customer_deletion_request_id}
7408
- * @example client.api.getCustomerDeletionRequest({"customer_id":"example","customer_deletion_request_id":"example"})
7408
+ * @example client.api.getCustomerDeletionRequest({customer_id: "example", customer_deletion_request_id: "example"})
7409
7409
  */
7410
7410
  getCustomerDeletionRequest(input: ApiGetCustomerDeletionRequestInput, options?: RequestOptions): Promise<Result<ApiGetCustomerDeletionRequestResponse>>;
7411
7411
  /**
7412
7412
  * Returns the current revision and lifecycle state for one delivery location set.
7413
7413
  * GET /v1/delivery-location-sets/{delivery_location_set_id}
7414
- * @example client.api.getDeliveryLocationSet({"delivery_location_set_id":"example"})
7414
+ * @example client.api.getDeliveryLocationSet({delivery_location_set_id: "example"})
7415
7415
  */
7416
7416
  getDeliveryLocationSet(input: ApiGetDeliveryLocationSetInput, options?: RequestOptions): Promise<Result<ApiGetDeliveryLocationSetResponse>>;
7417
7417
  /**
7418
7418
  * Returns the current revision and lifecycle state for one delivery method.
7419
7419
  * GET /v1/delivery-methods/{delivery_method_id}
7420
- * @example client.api.getDeliveryMethod({"delivery_method_id":"example"})
7420
+ * @example client.api.getDeliveryMethod({delivery_method_id: "example"})
7421
7421
  */
7422
7422
  getDeliveryMethod(input: ApiGetDeliveryMethodInput, options?: RequestOptions): Promise<Result<ApiGetDeliveryMethodResponse>>;
7423
7423
  /**
7424
7424
  * Returns the current revision and lifecycle state for one delivery profile.
7425
7425
  * GET /v1/delivery-profiles/{delivery_profile_id}
7426
- * @example client.api.getDeliveryProfile({"delivery_profile_id":"example"})
7426
+ * @example client.api.getDeliveryProfile({delivery_profile_id: "example"})
7427
7427
  */
7428
7428
  getDeliveryProfile(input: ApiGetDeliveryProfileInput, options?: RequestOptions): Promise<Result<ApiGetDeliveryProfileResponse>>;
7429
7429
  /**
7430
7430
  * Returns the current revision and lifecycle state for one delivery rate callback.
7431
7431
  * GET /v1/delivery-rate-callbacks/{delivery_rate_callback_id}
7432
- * @example client.api.getDeliveryRateCallback({"delivery_rate_callback_id":"example"})
7432
+ * @example client.api.getDeliveryRateCallback({delivery_rate_callback_id: "example"})
7433
7433
  */
7434
7434
  getDeliveryRateCallback(input: ApiGetDeliveryRateCallbackInput, options?: RequestOptions): Promise<Result<ApiGetDeliveryRateCallbackResponse>>;
7435
7435
  /**
7436
7436
  * Returns one permanent delivery revocation and its estimated impact at creation time.
7437
7437
  * GET /v1/delivery-revocations/{delivery_revocation_id}
7438
- * @example client.api.getDeliveryRevocation({"delivery_revocation_id":"example"})
7438
+ * @example client.api.getDeliveryRevocation({delivery_revocation_id: "example"})
7439
7439
  */
7440
7440
  getDeliveryRevocation(input: ApiGetDeliveryRevocationInput, options?: RequestOptions): Promise<Result<ApiGetDeliveryRevocationResponse>>;
7441
7441
  /**
7442
7442
  * Returns the current revision and lifecycle state for one delivery zone.
7443
7443
  * GET /v1/delivery-zones/{delivery_zone_id}
7444
- * @example client.api.getDeliveryZone({"delivery_zone_id":"example"})
7444
+ * @example client.api.getDeliveryZone({delivery_zone_id: "example"})
7445
7445
  */
7446
7446
  getDeliveryZone(input: ApiGetDeliveryZoneInput, options?: RequestOptions): Promise<Result<ApiGetDeliveryZoneResponse>>;
7447
7447
  /**
@@ -7453,31 +7453,31 @@ export declare class Client {
7453
7453
  /**
7454
7454
  * Returns a single partner app owned by the authenticated merchant.
7455
7455
  * GET /v1/developer/partner/apps/{partner_app_id}
7456
- * @example client.api.getDeveloperPartnerApp({"partner_app_id":"example"})
7456
+ * @example client.api.getDeveloperPartnerApp({partner_app_id: "example"})
7457
7457
  */
7458
7458
  getDeveloperPartnerApp(input: ApiGetDeveloperPartnerAppInput, options?: RequestOptions): Promise<Result<ApiGetDeveloperPartnerAppResponse>>;
7459
7459
  /**
7460
7460
  * Returns a single install for a partner app owned by the authenticated merchant.
7461
7461
  * GET /v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}
7462
- * @example client.api.getDeveloperPartnerAppInstall({"partner_app_id":"example","partner_app_install_id":"example"})
7462
+ * @example client.api.getDeveloperPartnerAppInstall({partner_app_id: "example", partner_app_install_id: "example"})
7463
7463
  */
7464
7464
  getDeveloperPartnerAppInstall(input: ApiGetDeveloperPartnerAppInstallInput, options?: RequestOptions): Promise<Result<ApiGetDeveloperPartnerAppInstallResponse>>;
7465
7465
  /**
7466
7466
  * Returns a single sandbox by ID.
7467
7467
  * GET /v1/developer/sandboxes/{sandbox_id}
7468
- * @example client.api.getDeveloperSandbox({"sandbox_id":"example"})
7468
+ * @example client.api.getDeveloperSandbox({sandbox_id: "example"})
7469
7469
  */
7470
7470
  getDeveloperSandbox(input: ApiGetDeveloperSandboxInput, options?: RequestOptions): Promise<Result<ApiGetDeveloperSandboxResponse>>;
7471
7471
  /**
7472
7472
  * Returns a single device by ID.
7473
7473
  * GET /v1/devices/{device_id}
7474
- * @example client.api.getDevice({"device_id":"example"})
7474
+ * @example client.api.getDevice({device_id: "example"})
7475
7475
  */
7476
7476
  getDevice(input: ApiGetDeviceInput, options?: RequestOptions): Promise<Result<ApiGetDeviceResponse>>;
7477
7477
  /**
7478
7478
  * Returns one dispute by ID, with optional customer, order, and payment intent expansions.
7479
7479
  * GET /v1/disputes/{dispute_id}
7480
- * @example client.api.getDispute({"dispute_id":"example"})
7480
+ * @example client.api.getDispute({dispute_id: "example"})
7481
7481
  */
7482
7482
  getDispute(input: ApiGetDisputeInput, options?: RequestOptions): Promise<Result<ApiGetDisputeResponse>>;
7483
7483
  /**
@@ -7489,61 +7489,61 @@ export declare class Client {
7489
7489
  /**
7490
7490
  * Returns one immutable feedback report in the credential's merchant and environment.
7491
7491
  * GET /v1/feedback-reports/{feedback_report_id}
7492
- * @example client.api.getFeedbackReport({"feedback_report_id":"example"})
7492
+ * @example client.api.getFeedbackReport({feedback_report_id: "example"})
7493
7493
  */
7494
7494
  getFeedbackReport(input: ApiGetFeedbackReportInput, options?: RequestOptions): Promise<Result<ApiGetFeedbackReportResponse>>;
7495
7495
  /**
7496
7496
  * Get an early fraud warning for the authenticated merchant environment.
7497
7497
  * GET /v1/fraud-warnings/{fraud_warning_id}
7498
- * @example client.api.getFraudWarning({"fraud_warning_id":"example"})
7498
+ * @example client.api.getFraudWarning({fraud_warning_id: "example"})
7499
7499
  */
7500
7500
  getFraudWarning(input: ApiGetFraudWarningInput, options?: RequestOptions): Promise<Result<ApiGetFraudWarningResponse>>;
7501
7501
  /**
7502
7502
  * Retrieves a single fulfillment by ID.
7503
7503
  * GET /v1/fulfillments/{fulfillment_id}
7504
- * @example client.api.getFulfillment({"fulfillment_id":"example"})
7504
+ * @example client.api.getFulfillment({fulfillment_id: "example"})
7505
7505
  */
7506
7506
  getFulfillment(input: ApiGetFulfillmentInput, options?: RequestOptions): Promise<Result<ApiGetFulfillmentResponse>>;
7507
7507
  /**
7508
7508
  * Retrieves one provider-neutral fulfillment event by ID.
7509
7509
  * GET /v1/fulfillment-events/{fulfillment_event_id}
7510
- * @example client.api.getFulfillmentEvent({"fulfillment_event_id":"example"})
7510
+ * @example client.api.getFulfillmentEvent({fulfillment_event_id: "example"})
7511
7511
  */
7512
7512
  getFulfillmentEvent(input: ApiGetFulfillmentEventInput, options?: RequestOptions): Promise<Result<ApiGetFulfillmentEventResponse>>;
7513
7513
  /**
7514
7514
  * Retrieves one fulfillment notification audit record by ID.
7515
7515
  * GET /v1/fulfillment-notifications/{fulfillment_notification_id}
7516
- * @example client.api.getFulfillmentNotification({"fulfillment_notification_id":"example"})
7516
+ * @example client.api.getFulfillmentNotification({fulfillment_notification_id: "example"})
7517
7517
  */
7518
7518
  getFulfillmentNotification(input: ApiGetFulfillmentNotificationInput, options?: RequestOptions): Promise<Result<ApiGetFulfillmentNotificationResponse>>;
7519
7519
  /**
7520
7520
  * Returns a single invoice by ID.
7521
7521
  * GET /v1/invoices/{invoice_id}
7522
- * @example client.api.getInvoice({"invoice_id":"example"})
7522
+ * @example client.api.getInvoice({invoice_id: "example"})
7523
7523
  */
7524
7524
  getInvoice(input: ApiGetInvoiceInput, options?: RequestOptions): Promise<Result<ApiGetInvoiceResponse>>;
7525
7525
  /**
7526
7526
  * Returns one card or ACH collection attempt for the invoice.
7527
7527
  * GET /v1/invoices/{invoice_id}/payment-attempts/{invoice_payment_attempt_id}
7528
- * @example client.api.getInvoicePaymentAttempt({"invoice_id":"example","invoice_payment_attempt_id":"example"})
7528
+ * @example client.api.getInvoicePaymentAttempt({invoice_id: "example", invoice_payment_attempt_id: "example"})
7529
7529
  */
7530
7530
  getInvoicePaymentAttempt(input: ApiGetInvoicePaymentAttemptInput, options?: RequestOptions): Promise<Result<ApiGetInvoicePaymentAttemptResponse>>;
7531
7531
  /**
7532
7532
  * Returns one invoice payment term for the authenticated merchant.
7533
7533
  * GET /v1/invoice-payment-terms/{invoice_payment_term_id}
7534
- * @example client.api.getInvoicePaymentTerm({"invoice_payment_term_id":"example"})
7534
+ * @example client.api.getInvoicePaymentTerm({invoice_payment_term_id: "example"})
7535
7535
  */
7536
7536
  getInvoicePaymentTerm(input: ApiGetInvoicePaymentTermInput, options?: RequestOptions): Promise<Result<ApiGetInvoicePaymentTermResponse>>;
7537
7537
  /**
7538
7538
  * Downloads the merchant-authenticated PDF artifact generated from the invoice snapshot.
7539
7539
  * GET /v1/invoices/{invoice_id}/pdf
7540
- * @example client.api.getInvoicePDF({"invoice_id":"example"})
7540
+ * @example client.api.getInvoicePDF({invoice_id: "example"})
7541
7541
  */
7542
7542
  getInvoicePDF(input: ApiGetInvoicePDFInput, options?: RequestOptions): Promise<Result<ApiGetInvoicePDFResponse>>;
7543
7543
  /**
7544
7544
  * Get location.
7545
7545
  * GET /v1/locations/{location_id}
7546
- * @example client.api.getLocation({"location_id":"example"})
7546
+ * @example client.api.getLocation({location_id: "example"})
7547
7547
  */
7548
7548
  getLocation(input: ApiGetLocationInput, options?: RequestOptions): Promise<Result<ApiGetLocationResponse>>;
7549
7549
  /**
@@ -7555,85 +7555,85 @@ export declare class Client {
7555
7555
  /**
7556
7556
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns one saved address owned by the customer.
7557
7557
  * GET /v1/me/addresses/{customer_address_id}
7558
- * @example client.api.getMeAddress({"customer_address_id":"example"})
7558
+ * @example client.api.getMeAddress({customer_address_id: "example"})
7559
7559
  */
7560
7560
  getMeAddress(input: ApiGetMeAddressInput, options?: RequestOptions): Promise<Result<ApiGetMeAddressResponse>>;
7561
7561
  /**
7562
7562
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns one credit note with its lines, total, and the credit still available to allocate.
7563
7563
  * GET /v1/me/invoices/{invoice_id}/credit-notes/{credit_note_id}
7564
- * @example client.api.getMeCreditNote({"invoice_id":"example","credit_note_id":"example"})
7564
+ * @example client.api.getMeCreditNote({invoice_id: "example", credit_note_id: "example"})
7565
7565
  */
7566
7566
  getMeCreditNote(input: ApiGetMeCreditNoteInput, options?: RequestOptions): Promise<Result<ApiGetMeCreditNoteResponse>>;
7567
7567
  /**
7568
7568
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns the credit note document as application/pdf rather than a JSON envelope. The PDF exists from issue onward and carries your branding, the credited lines, and the invoice it corrects.
7569
7569
  * GET /v1/me/invoices/{invoice_id}/credit-notes/{credit_note_id}/pdf
7570
- * @example client.api.getMeCreditNotePDF({"invoice_id":"example","credit_note_id":"example"})
7570
+ * @example client.api.getMeCreditNotePDF({invoice_id: "example", credit_note_id: "example"})
7571
7571
  */
7572
7572
  getMeCreditNotePDF(input: ApiGetMeCreditNotePDFInput, options?: RequestOptions): Promise<Result<ApiGetMeCreditNotePDFResponse>>;
7573
7573
  /**
7574
7574
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns the current status of a tracked deletion request.
7575
7575
  * GET /v1/me/deletion-requests/{customer_deletion_request_id}
7576
- * @example client.api.getMeDeletionRequest({"customer_deletion_request_id":"example"})
7576
+ * @example client.api.getMeDeletionRequest({customer_deletion_request_id: "example"})
7577
7577
  */
7578
7578
  getMeDeletionRequest(input: ApiGetMeDeletionRequestInput, options?: RequestOptions): Promise<Result<ApiGetMeDeletionRequestResponse>>;
7579
7579
  /**
7580
7580
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a single invoice by ID.
7581
7581
  * GET /v1/me/invoices/{invoice_id}
7582
- * @example client.api.getMeInvoice({"invoice_id":"example"})
7582
+ * @example client.api.getMeInvoice({invoice_id: "example"})
7583
7583
  */
7584
7584
  getMeInvoice(input: ApiGetMeInvoiceInput, options?: RequestOptions): Promise<Result<ApiGetMeInvoiceResponse>>;
7585
7585
  /**
7586
7586
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Downloads the merchant-authenticated PDF artifact generated from the invoice snapshot.
7587
7587
  * GET /v1/me/invoices/{invoice_id}/pdf
7588
- * @example client.api.getMeInvoicePDF({"invoice_id":"example"})
7588
+ * @example client.api.getMeInvoicePDF({invoice_id: "example"})
7589
7589
  */
7590
7590
  getMeInvoicePDF(input: ApiGetMeInvoicePDFInput, options?: RequestOptions): Promise<Result<ApiGetMeInvoicePDFResponse>>;
7591
7591
  /**
7592
7592
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a single order by ID.
7593
7593
  * GET /v1/me/orders/{order_id}
7594
- * @example client.api.getMeOrder({"order_id":"example"})
7594
+ * @example client.api.getMeOrder({order_id: "example"})
7595
7595
  */
7596
7596
  getMeOrder(input: ApiGetMeOrderInput, options?: RequestOptions): Promise<Result<ApiGetMeOrderResponse>>;
7597
7597
  /**
7598
7598
  * Returns the authenticated merchant by ID.
7599
7599
  * GET /v1/merchants/{merchant_id}
7600
- * @example client.api.getMerchant({"merchant_id":"example"})
7600
+ * @example client.api.getMerchant({merchant_id: "example"})
7601
7601
  */
7602
7602
  getMerchant(input: ApiGetMerchantInput, options?: RequestOptions): Promise<Result<ApiGetMerchantResponse>>;
7603
7603
  /**
7604
7604
  * Returns what the merchant currently owes Flint and owns as account credit in one currency.
7605
7605
  * GET /v1/merchant-billing-balances/{merchant_billing_balance_id}
7606
- * @example client.api.getMerchantBillingBalance({"merchant_billing_balance_id":"example"})
7606
+ * @example client.api.getMerchantBillingBalance({merchant_billing_balance_id: "example"})
7607
7607
  */
7608
7608
  getMerchantBillingBalance(input: ApiGetMerchantBillingBalanceInput, options?: RequestOptions): Promise<Result<ApiGetMerchantBillingBalanceResponse>>;
7609
7609
  /**
7610
7610
  * Returns one invoice issued by Flint for the authenticated merchant environment.
7611
7611
  * GET /v1/merchant-subscription-invoices/{merchant_subscription_invoice_id}
7612
- * @example client.api.getMerchantSubscriptionInvoice({"merchant_subscription_invoice_id":"example"})
7612
+ * @example client.api.getMerchantSubscriptionInvoice({merchant_subscription_invoice_id: "example"})
7613
7613
  */
7614
7614
  getMerchantSubscriptionInvoice(input: ApiGetMerchantSubscriptionInvoiceInput, options?: RequestOptions): Promise<Result<ApiGetMerchantSubscriptionInvoiceResponse>>;
7615
7615
  /**
7616
7616
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Retrieve a Return with its line items, policy evaluation, financial summary, and completion blockers. Supports expand for the order, the customer, and each line item's reason and fulfillment.
7617
7617
  * GET /v1/me/returns/{return_id}
7618
- * @example client.api.getMeReturn({"return_id":"example"})
7618
+ * @example client.api.getMeReturn({return_id: "example"})
7619
7619
  */
7620
7620
  getMeReturn(input: ApiGetMeReturnInput, options?: RequestOptions): Promise<Result<ApiGetMeReturnResponse>>;
7621
7621
  /**
7622
7622
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a single subscription by ID.
7623
7623
  * GET /v1/me/subscriptions/{subscription_id}
7624
- * @example client.api.getMeSubscription({"subscription_id":"example"})
7624
+ * @example client.api.getMeSubscription({subscription_id: "example"})
7625
7625
  */
7626
7626
  getMeSubscription(input: ApiGetMeSubscriptionInput, options?: RequestOptions): Promise<Result<ApiGetMeSubscriptionResponse>>;
7627
7627
  /**
7628
7628
  * Get modifier group.
7629
7629
  * GET /v1/modifier-groups/{modifier_group_id}
7630
- * @example client.api.getModifierGroup({"modifier_group_id":"example"})
7630
+ * @example client.api.getModifierGroup({modifier_group_id: "example"})
7631
7631
  */
7632
7632
  getModifierGroup(input: ApiGetModifierGroupInput, options?: RequestOptions): Promise<Result<ApiGetModifierGroupResponse>>;
7633
7633
  /**
7634
7634
  * Get modifier set.
7635
7635
  * GET /v1/modifier-sets/{modifier_set_id}
7636
- * @example client.api.getModifierSet({"modifier_set_id":"example"})
7636
+ * @example client.api.getModifierSet({modifier_set_id: "example"})
7637
7637
  */
7638
7638
  getModifierSet(input: ApiGetModifierSetInput, options?: RequestOptions): Promise<Result<ApiGetModifierSetResponse>>;
7639
7639
  /**
@@ -7651,97 +7651,97 @@ export declare class Client {
7651
7651
  /**
7652
7652
  * Returns the current open invoice checkout session and aligned card attempt when they still match the invoice balance and collection run. A newly created session and attempt share the fixed expiration of the active invoice public-link generation. Unexpired sessions are reused regardless of remaining lifetime; active payment work returns a resolving conflict instead of creating competing collection.
7653
7653
  * POST /v1/invoices/{invoice_id}/checkout-session
7654
- * @example client.api.getOrCreateInvoiceCheckoutSession({"invoice_id":"example"})
7654
+ * @example client.api.getOrCreateInvoiceCheckoutSession({invoice_id: "example"})
7655
7655
  */
7656
7656
  getOrCreateInvoiceCheckoutSession(input: ApiGetOrCreateInvoiceCheckoutSessionInput, options?: RequestOptions): Promise<Result<ApiGetOrCreateInvoiceCheckoutSessionResponse>>;
7657
7657
  /**
7658
7658
  * Create or reuse the standard hosted checkout session for a buyer-owed replacement Order linked to this Return resolution.
7659
7659
  * POST /v1/return-resolutions/{return_resolution_id}/checkout-session
7660
- * @example client.api.getOrCreateReturnResolutionCheckoutSession({"return_resolution_id":"example"})
7660
+ * @example client.api.getOrCreateReturnResolutionCheckoutSession({return_resolution_id: "example"})
7661
7661
  */
7662
7662
  getOrCreateReturnResolutionCheckoutSession(input: ApiGetOrCreateReturnResolutionCheckoutSessionInput, options?: RequestOptions): Promise<Result<ApiGetOrCreateReturnResolutionCheckoutSessionResponse>>;
7663
7663
  /**
7664
7664
  * Returns a single order by ID.
7665
7665
  * GET /v1/orders/{order_id}
7666
- * @example client.api.getOrder({"order_id":"example"})
7666
+ * @example client.api.getOrder({order_id: "example"})
7667
7667
  */
7668
7668
  getOrder(input: ApiGetOrderInput, options?: RequestOptions): Promise<Result<ApiGetOrderResponse>>;
7669
7669
  /**
7670
7670
  * Returns the delivery selection committed to an order.
7671
7671
  * GET /v1/orders/{order_id}/delivery-selections/current
7672
- * @example client.api.getOrderCurrentDeliverySelection({"order_id":"example"})
7672
+ * @example client.api.getOrderCurrentDeliverySelection({order_id: "example"})
7673
7673
  */
7674
7674
  getOrderCurrentDeliverySelection(input: ApiGetOrderCurrentDeliverySelectionInput, options?: RequestOptions): Promise<Result<ApiGetOrderCurrentDeliverySelectionResponse>>;
7675
7675
  /**
7676
7676
  * Returns one durable payment attempt for the order. Checkout-session callers can read only attempts created by their own session.
7677
7677
  * GET /v1/orders/{order_id}/payment-attempts/{payment_attempt_id}
7678
- * @example client.api.getOrderPaymentAttempt({"order_id":"example","payment_attempt_id":"example"})
7678
+ * @example client.api.getOrderPaymentAttempt({order_id: "example", payment_attempt_id: "example"})
7679
7679
  */
7680
7680
  getOrderPaymentAttempt(input: ApiGetOrderPaymentAttemptInput, options?: RequestOptions): Promise<Result<ApiGetOrderPaymentAttemptResponse>>;
7681
7681
  /**
7682
7682
  * Returns an accessible organization by ID.
7683
7683
  * GET /v1/organizations/{organization_id}
7684
- * @example client.api.getOrganization({"organization_id":"example"})
7684
+ * @example client.api.getOrganization({organization_id: "example"})
7685
7685
  */
7686
7686
  getOrganization(input: ApiGetOrganizationInput, options?: RequestOptions): Promise<Result<ApiGetOrganizationResponse>>;
7687
7687
  /**
7688
7688
  * Retrieves one package by ID.
7689
7689
  * GET /v1/packages/{package_id}
7690
- * @example client.api.getPackage({"package_id":"example"})
7690
+ * @example client.api.getPackage({package_id: "example"})
7691
7691
  */
7692
7692
  getPackage(input: ApiGetPackageInput, options?: RequestOptions): Promise<Result<ApiGetPackageResponse>>;
7693
7693
  /**
7694
7694
  * Retrieves one package item by ID.
7695
7695
  * GET /v1/packages/{package_id}/items/{package_item_id}
7696
- * @example client.api.getPackageItem({"package_id":"example","package_item_id":"example"})
7696
+ * @example client.api.getPackageItem({package_id: "example", package_item_id: "example"})
7697
7697
  */
7698
7698
  getPackageItem(input: ApiGetPackageItemInput, options?: RequestOptions): Promise<Result<ApiGetPackageItemResponse>>;
7699
7699
  /**
7700
7700
  * Returns a single payment intent by ID.
7701
7701
  * GET /v1/payment-intents/{payment_intent_id}
7702
- * @example client.api.getPaymentIntent({"payment_intent_id":"example"})
7702
+ * @example client.api.getPaymentIntent({payment_intent_id: "example"})
7703
7703
  */
7704
7704
  getPaymentIntent(input: ApiGetPaymentIntentInput, options?: RequestOptions): Promise<Result<ApiGetPaymentIntentResponse>>;
7705
7705
  /**
7706
7706
  * Returns a single payment link by ID.
7707
7707
  * GET /v1/payment-links/{payment_link_id}
7708
- * @example client.api.getPaymentLink({"payment_link_id":"example"})
7708
+ * @example client.api.getPaymentLink({payment_link_id: "example"})
7709
7709
  */
7710
7710
  getPaymentLink(input: ApiGetPaymentLinkInput, options?: RequestOptions): Promise<Result<ApiGetPaymentLinkResponse>>;
7711
7711
  /**
7712
7712
  * Returns the sanitized buyer-facing payment-link snapshot and a private resolution context for this browser operation.
7713
7713
  * GET /v1/payment-links/{payment_link_id}/public
7714
- * @example client.api.getPaymentLinkPublic({"payment_link_id":"example"})
7714
+ * @example client.api.getPaymentLinkPublic({payment_link_id: "example"})
7715
7715
  */
7716
7716
  getPaymentLinkPublic(input: ApiGetPaymentLinkPublicInput, options?: RequestOptions): Promise<Result<ApiGetPaymentLinkPublicResponse>>;
7717
7717
  /**
7718
7718
  * Returns a single payment method by ID.
7719
7719
  * GET /v1/payment-methods/{payment_method_id}
7720
- * @example client.api.getPaymentMethod({"payment_method_id":"example"})
7720
+ * @example client.api.getPaymentMethod({payment_method_id: "example"})
7721
7721
  */
7722
7722
  getPaymentMethod(input: ApiGetPaymentMethodInput, options?: RequestOptions): Promise<Result<ApiGetPaymentMethodResponse>>;
7723
7723
  /**
7724
7724
  * Returns one environment-scoped payment method domain and its Apple Pay and Google Pay readiness.
7725
7725
  * GET /v1/payment-method-domains/{payment_method_domain_id}
7726
- * @example client.api.getPaymentMethodDomain({"payment_method_domain_id":"example"})
7726
+ * @example client.api.getPaymentMethodDomain({payment_method_domain_id: "example"})
7727
7727
  */
7728
7728
  getPaymentMethodDomain(input: ApiGetPaymentMethodDomainInput, options?: RequestOptions): Promise<Result<ApiGetPaymentMethodDomainResponse>>;
7729
7729
  /**
7730
7730
  * Returns merchant payment volume buckets for the requested time range.
7731
7731
  * GET /v1/analytics/payment-volume-timeseries
7732
- * @example client.api.getPaymentVolumeTimeseries({"range":"today"})
7732
+ * @example client.api.getPaymentVolumeTimeseries({range: "today"})
7733
7733
  */
7734
7734
  getPaymentVolumeTimeseries(input: ApiGetPaymentVolumeTimeseriesInput, options?: RequestOptions): Promise<Result<ApiGetPaymentVolumeTimeseriesResponse>>;
7735
7735
  /**
7736
7736
  * Returns one payout by ID, with optional related payout and payout destination expansions.
7737
7737
  * GET /v1/payouts/{payout_id}
7738
- * @example client.api.getPayout({"payout_id":"example"})
7738
+ * @example client.api.getPayout({payout_id: "example"})
7739
7739
  */
7740
7740
  getPayout(input: ApiGetPayoutInput, options?: RequestOptions): Promise<Result<ApiGetPayoutResponse>>;
7741
7741
  /**
7742
7742
  * Returns one payout destination by ID.
7743
7743
  * GET /v1/payout-settings/destinations/{payout_destination_id}
7744
- * @example client.api.getPayoutDestination({"payout_destination_id":"example"})
7744
+ * @example client.api.getPayoutDestination({payout_destination_id: "example"})
7745
7745
  */
7746
7746
  getPayoutDestination(input: ApiGetPayoutDestinationInput, options?: RequestOptions): Promise<Result<ApiGetPayoutDestinationResponse>>;
7747
7747
  /**
@@ -7753,127 +7753,127 @@ export declare class Client {
7753
7753
  /**
7754
7754
  * Returns a single product by ID.
7755
7755
  * GET /v1/products/{product_id}
7756
- * @example client.api.getProduct({"product_id":"example"})
7756
+ * @example client.api.getProduct({product_id: "example"})
7757
7757
  */
7758
7758
  getProduct(input: ApiGetProductInput, options?: RequestOptions): Promise<Result<ApiGetProductResponse>>;
7759
7759
  /**
7760
7760
  * Get product option.
7761
7761
  * GET /v1/products/{product_id}/options/{option_id}
7762
- * @example client.api.getProductOption({"product_id":"example","option_id":"example"})
7762
+ * @example client.api.getProductOption({product_id: "example", option_id: "example"})
7763
7763
  */
7764
7764
  getProductOption(input: ApiGetProductOptionInput, options?: RequestOptions): Promise<Result<ApiGetProductOptionResponse>>;
7765
7765
  /**
7766
7766
  * Get product variant.
7767
7767
  * GET /v1/products/{product_id}/variants/{variant_id}
7768
- * @example client.api.getProductVariant({"product_id":"example","variant_id":"example"})
7768
+ * @example client.api.getProductVariant({product_id: "example", variant_id: "example"})
7769
7769
  */
7770
7770
  getProductVariant(input: ApiGetProductVariantInput, options?: RequestOptions): Promise<Result<ApiGetProductVariantResponse>>;
7771
7771
  /**
7772
7772
  * Returns a single promotion by ID.
7773
7773
  * GET /v1/promotions/{promotion_id}
7774
- * @example client.api.getPromotion({"promotion_id":"example"})
7774
+ * @example client.api.getPromotion({promotion_id: "example"})
7775
7775
  */
7776
7776
  getPromotion(input: ApiGetPromotionInput, options?: RequestOptions): Promise<Result<ApiGetPromotionResponse>>;
7777
7777
  /**
7778
7778
  * Returns a single refund by ID.
7779
7779
  * GET /v1/refunds/{refund_id}
7780
- * @example client.api.getRefund({"refund_id":"example"})
7780
+ * @example client.api.getRefund({refund_id: "example"})
7781
7781
  */
7782
7782
  getRefund(input: ApiGetRefundInput, options?: RequestOptions): Promise<Result<ApiGetRefundResponse>>;
7783
7783
  /**
7784
7784
  * Returns one report and its terminal download or failure details when available.
7785
7785
  * GET /v1/reports/{report_id}
7786
- * @example client.api.getReport({"report_id":"example"})
7786
+ * @example client.api.getReport({report_id: "example"})
7787
7787
  */
7788
7788
  getReport(input: ApiGetReportInput, options?: RequestOptions): Promise<Result<ApiGetReportResponse>>;
7789
7789
  /**
7790
7790
  * Authorizes the stable Flint download URL and redirects to a short-lived private file URL.
7791
7791
  * GET /v1/report-downloads/{report_download_id}
7792
- * @example client.api.getReportDownload({"report_download_id":"example"})
7792
+ * @example client.api.getReportDownload({report_download_id: "example"})
7793
7793
  */
7794
7794
  getReportDownload(input: ApiGetReportDownloadInput, options?: RequestOptions): Promise<Result<ApiGetReportDownloadResponse>>;
7795
7795
  /**
7796
7796
  * Returns summary-only API request, webhook event, and webhook delivery attempt entries for a single public API resource. The caller must have developer.resource_timelines.read and the matching read scope for the requested resource type.
7797
7797
  * GET /v1/developer/resource-timelines/{resource_id}
7798
- * @example client.api.getResourceTimeline({"resource_id":"example"})
7798
+ * @example client.api.getResourceTimeline({resource_id: "example"})
7799
7799
  */
7800
7800
  getResourceTimeline(input: ApiGetResourceTimelineInput, options?: RequestOptions): Promise<Result<ApiGetResourceTimelineResponse>>;
7801
7801
  /**
7802
7802
  * Retrieve a Return with its line items, policy evaluation, financial summary, and completion blockers. Supports expand for the order, the customer, and each line item's reason and fulfillment.
7803
7803
  * GET /v1/returns/{return_id}
7804
- * @example client.api.getReturn({"return_id":"example"})
7804
+ * @example client.api.getReturn({return_id: "example"})
7805
7805
  */
7806
7806
  getReturn(input: ApiGetReturnInput, options?: RequestOptions): Promise<Result<ApiGetReturnResponse>>;
7807
7807
  /**
7808
7808
  * Retrieve one disposition with its type, destination, quantity, status, and any linked inventory effect.
7809
7809
  * GET /v1/return-dispositions/{return_disposition_id}
7810
- * @example client.api.getReturnDisposition({"return_disposition_id":"example"})
7810
+ * @example client.api.getReturnDisposition({return_disposition_id: "example"})
7811
7811
  */
7812
7812
  getReturnDisposition(input: ApiGetReturnDispositionInput, options?: RequestOptions): Promise<Result<ApiGetReturnDispositionResponse>>;
7813
7813
  /**
7814
7814
  * Retrieve one inspection with its line items, findings, and current or superseded observation status.
7815
7815
  * GET /v1/return-inspections/{return_inspection_id}
7816
- * @example client.api.getReturnInspection({"return_inspection_id":"example"})
7816
+ * @example client.api.getReturnInspection({return_inspection_id: "example"})
7817
7817
  */
7818
7818
  getReturnInspection(input: ApiGetReturnInspectionInput, options?: RequestOptions): Promise<Result<ApiGetReturnInspectionResponse>>;
7819
7819
  /**
7820
7820
  * Retrieve one Return line item, including its quantity counters and the reason the buyer selected.
7821
7821
  * GET /v1/returns/{return_id}/line-items/{return_line_item_id}
7822
- * @example client.api.getReturnLineItem({"return_id":"example","return_line_item_id":"example"})
7822
+ * @example client.api.getReturnLineItem({return_id: "example", return_line_item_id: "example"})
7823
7823
  */
7824
7824
  getReturnLineItem(input: ApiGetReturnLineItemInput, options?: RequestOptions): Promise<Result<ApiGetReturnLineItemResponse>>;
7825
7825
  /**
7826
7826
  * Retrieve one Return policy. Supports expand for current_revision.
7827
7827
  * GET /v1/return-policies/{return_policy_id}
7828
- * @example client.api.getReturnPolicy({"return_policy_id":"example"})
7828
+ * @example client.api.getReturnPolicy({return_policy_id: "example"})
7829
7829
  */
7830
7830
  getReturnPolicy(input: ApiGetReturnPolicyInput, options?: RequestOptions): Promise<Result<ApiGetReturnPolicyResponse>>;
7831
7831
  /**
7832
7832
  * Retrieve one immutable policy revision, including the exact rules a Return was evaluated against.
7833
7833
  * GET /v1/return-policies/{return_policy_id}/revisions/{return_policy_revision_id}
7834
- * @example client.api.getReturnPolicyRevision({"return_policy_id":"example","return_policy_revision_id":"example"})
7834
+ * @example client.api.getReturnPolicyRevision({return_policy_id: "example", return_policy_revision_id: "example"})
7835
7835
  */
7836
7836
  getReturnPolicyRevision(input: ApiGetReturnPolicyRevisionInput, options?: RequestOptions): Promise<Result<ApiGetReturnPolicyRevisionResponse>>;
7837
7837
  /**
7838
7838
  * Retrieve one Return reason with its handle, category handles, and status.
7839
7839
  * GET /v1/return-reasons/{return_reason_id}
7840
- * @example client.api.getReturnReason({"return_reason_id":"example"})
7840
+ * @example client.api.getReturnReason({return_reason_id: "example"})
7841
7841
  */
7842
7842
  getReturnReason(input: ApiGetReturnReasonInput, options?: RequestOptions): Promise<Result<ApiGetReturnReasonResponse>>;
7843
7843
  /**
7844
7844
  * Retrieve one merchandise receipt with its line items and its current or superseded observation status.
7845
7845
  * GET /v1/return-receipts/{return_receipt_id}
7846
- * @example client.api.getReturnReceipt({"return_receipt_id":"example"})
7846
+ * @example client.api.getReturnReceipt({return_receipt_id: "example"})
7847
7847
  */
7848
7848
  getReturnReceipt(input: ApiGetReturnReceiptInput, options?: RequestOptions): Promise<Result<ApiGetReturnReceiptResponse>>;
7849
7849
  /**
7850
7850
  * Retrieve one resolution with its amounts, adjustments, execution blockers, and linked refunds, payments, and replacement order. Supports expand for those links.
7851
7851
  * GET /v1/return-resolutions/{return_resolution_id}
7852
- * @example client.api.getReturnResolution({"return_resolution_id":"example"})
7852
+ * @example client.api.getReturnResolution({return_resolution_id: "example"})
7853
7853
  */
7854
7854
  getReturnResolution(input: ApiGetReturnResolutionInput, options?: RequestOptions): Promise<Result<ApiGetReturnResolutionResponse>>;
7855
7855
  /**
7856
7856
  * Get a payment review for the authenticated merchant environment.
7857
7857
  * GET /v1/reviews/{review_id}
7858
- * @example client.api.getReview({"review_id":"example"})
7858
+ * @example client.api.getReview({review_id: "example"})
7859
7859
  */
7860
7860
  getReview(input: ApiGetReviewInput, options?: RequestOptions): Promise<Result<ApiGetReviewResponse>>;
7861
7861
  /**
7862
7862
  * Get a risk list for the authenticated merchant environment.
7863
7863
  * GET /v1/risk-lists/{risk_list_id}
7864
- * @example client.api.getRiskList({"risk_list_id":"example"})
7864
+ * @example client.api.getRiskList({risk_list_id: "example"})
7865
7865
  */
7866
7866
  getRiskList(input: ApiGetRiskListInput, options?: RequestOptions): Promise<Result<ApiGetRiskListResponse>>;
7867
7867
  /**
7868
7868
  * Get a risk list item for the authenticated merchant environment.
7869
7869
  * GET /v1/risk-lists/{risk_list_id}/items/{risk_list_item_id}
7870
- * @example client.api.getRiskListItem({"risk_list_id":"example","risk_list_item_id":"example"})
7870
+ * @example client.api.getRiskListItem({risk_list_id: "example", risk_list_item_id: "example"})
7871
7871
  */
7872
7872
  getRiskListItem(input: ApiGetRiskListItemInput, options?: RequestOptions): Promise<Result<ApiGetRiskListItemResponse>>;
7873
7873
  /**
7874
7874
  * Get a risk rule for the authenticated merchant environment.
7875
7875
  * GET /v1/risk-rules/{risk_rule_id}
7876
- * @example client.api.getRiskRule({"risk_rule_id":"example"})
7876
+ * @example client.api.getRiskRule({risk_rule_id: "example"})
7877
7877
  */
7878
7878
  getRiskRule(input: ApiGetRiskRuleInput, options?: RequestOptions): Promise<Result<ApiGetRiskRuleResponse>>;
7879
7879
  /**
@@ -7891,73 +7891,73 @@ export declare class Client {
7891
7891
  /**
7892
7892
  * Retrieves one shipment execution record by ID.
7893
7893
  * GET /v1/shipments/{shipment_id}
7894
- * @example client.api.getShipment({"shipment_id":"example"})
7894
+ * @example client.api.getShipment({shipment_id: "example"})
7895
7895
  */
7896
7896
  getShipment(input: ApiGetShipmentInput, options?: RequestOptions): Promise<Result<ApiGetShipmentResponse>>;
7897
7897
  /**
7898
7898
  * Returns a single subscription by ID.
7899
7899
  * GET /v1/subscriptions/{subscription_id}
7900
- * @example client.api.getSubscription({"subscription_id":"example"})
7900
+ * @example client.api.getSubscription({subscription_id: "example"})
7901
7901
  */
7902
7902
  getSubscription(input: ApiGetSubscriptionInput, options?: RequestOptions): Promise<Result<ApiGetSubscriptionResponse>>;
7903
7903
  /**
7904
7904
  * Returns windowed subscription metrics plus current subscription snapshot metrics.
7905
7905
  * GET /v1/analytics/subscriptions
7906
- * @example client.api.getSubscriptionAnalytics({"range":"today"})
7906
+ * @example client.api.getSubscriptionAnalytics({range: "today"})
7907
7907
  */
7908
7908
  getSubscriptionAnalytics(input: ApiGetSubscriptionAnalyticsInput, options?: RequestOptions): Promise<Result<ApiGetSubscriptionAnalyticsResponse>>;
7909
7909
  /**
7910
7910
  * Returns one durable manual subscription payment retry.
7911
7911
  * GET /v1/subscriptions/{subscription_id}/payment-retries/{subscription_payment_retry_id}
7912
- * @example client.api.getSubscriptionPaymentRetry({"subscription_id":"example","subscription_payment_retry_id":"example"})
7912
+ * @example client.api.getSubscriptionPaymentRetry({subscription_id: "example", subscription_payment_retry_id: "example"})
7913
7913
  */
7914
7914
  getSubscriptionPaymentRetry(input: ApiGetSubscriptionPaymentRetryInput, options?: RequestOptions): Promise<Result<ApiGetSubscriptionPaymentRetryResponse>>;
7915
7915
  /**
7916
7916
  * Returns a single subscription plan by ID.
7917
7917
  * GET /v1/subscription-plans/{plan_id}
7918
- * @example client.api.getSubscriptionPlan({"plan_id":"example"})
7918
+ * @example client.api.getSubscriptionPlan({plan_id: "example"})
7919
7919
  */
7920
7920
  getSubscriptionPlan(input: ApiGetSubscriptionPlanInput, options?: RequestOptions): Promise<Result<ApiGetSubscriptionPlanResponse>>;
7921
7921
  /**
7922
7922
  * Returns one endpoint delivery and its current retry state.
7923
7923
  * GET /v1/webhook-deliveries/{webhook_delivery_id}
7924
- * @example client.api.getWebhookDelivery({"webhook_delivery_id":"example"})
7924
+ * @example client.api.getWebhookDelivery({webhook_delivery_id: "example"})
7925
7925
  */
7926
7926
  getWebhookDelivery(input: ApiGetWebhookDeliveryInput, options?: RequestOptions): Promise<Result<ApiGetWebhookDeliveryResponse>>;
7927
7927
  /**
7928
7928
  * Returns a single webhook endpoint by ID. The signing secret is omitted after creation.
7929
7929
  * GET /v1/webhook-endpoints/{webhook_endpoint_id}
7930
- * @example client.api.getWebhookEndpoint({"webhook_endpoint_id":"example"})
7930
+ * @example client.api.getWebhookEndpoint({webhook_endpoint_id: "example"})
7931
7931
  */
7932
7932
  getWebhookEndpoint(input: ApiGetWebhookEndpointInput, options?: RequestOptions): Promise<Result<ApiGetWebhookEndpointResponse>>;
7933
7933
  /**
7934
7934
  * Returns a specific webhook event for the authenticated merchant.
7935
7935
  * GET /v1/webhook-events/{webhook_event_id}
7936
- * @example client.api.getWebhookEvent({"webhook_event_id":"example"})
7936
+ * @example client.api.getWebhookEvent({webhook_event_id: "example"})
7937
7937
  */
7938
7938
  getWebhookEvent(input: ApiGetWebhookEventInput, options?: RequestOptions): Promise<Result<ApiGetWebhookEventResponse>>;
7939
7939
  /**
7940
7940
  * Adds or updates a direct organization membership for a user.
7941
7941
  * POST /v1/organizations/{organization_id}/memberships
7942
- * @example client.api.grantOrganizationMembership({"organization_id":"example","body":{"role":"owner","user_id":"example"}})
7942
+ * @example client.api.grantOrganizationMembership({organization_id: "example", body: {role: "owner", user_id: "example"}})
7943
7943
  */
7944
7944
  grantOrganizationMembership(input: ApiGrantOrganizationMembershipInput, options?: RequestOptions): Promise<Result<ApiGrantOrganizationMembershipResponse>>;
7945
7945
  /**
7946
7946
  * Issues a draft credit note. Assigns credit_note_number, freezes the lines, renders the PDF, and sets unallocated_money to the total. The over-credit check runs here rather than on line edits: across every issued credit note, an invoice line cannot be credited past its frozen value. Issuing does not change the invoice; allocating does.
7947
7947
  * POST /v1/credit-notes/{credit_note_id}/issue
7948
- * @example client.api.issueCreditNote({"credit_note_id":"example"})
7948
+ * @example client.api.issueCreditNote({credit_note_id: "example"})
7949
7949
  */
7950
7950
  issueCreditNote(input: ApiIssueCreditNoteInput, options?: RequestOptions): Promise<Result<ApiIssueCreditNoteResponse>>;
7951
7951
  /**
7952
7952
  * Creates a new test API key that is bound to the target sandbox.
7953
7953
  * POST /v1/developer/sandboxes/{sandbox_id}/test-key
7954
- * @example client.api.issueDeveloperSandboxTestKey({"sandbox_id":"example","body":{"name":"example"}})
7954
+ * @example client.api.issueDeveloperSandboxTestKey({sandbox_id: "example", body: {name: "example"}})
7955
7955
  */
7956
7956
  issueDeveloperSandboxTestKey(input: ApiIssueDeveloperSandboxTestKeyInput, options?: RequestOptions): Promise<Result<ApiIssueDeveloperSandboxTestKeyResponse>>;
7957
7957
  /**
7958
7958
  * Issues the invoice, creates the buyer-access link, and uses the selected delivery mode. Safe to retry with the same Idempotency-Key.
7959
7959
  * POST /v1/invoices/{invoice_id}/issue
7960
- * @example client.api.issueInvoice({"invoice_id":"example","body":{}})
7960
+ * @example client.api.issueInvoice({invoice_id: "example", body: {}})
7961
7961
  */
7962
7962
  issueInvoice(input: ApiIssueInvoiceInput, options?: RequestOptions): Promise<Result<ApiIssueInvoiceResponse>>;
7963
7963
  /**
@@ -7981,7 +7981,7 @@ export declare class Client {
7981
7981
  /**
7982
7982
  * List bundle components.
7983
7983
  * GET /v1/bundles/{bundle_id}/components
7984
- * @example client.api.listBundleComponents({"bundle_id":"example"})
7984
+ * @example client.api.listBundleComponents({bundle_id: "example"})
7985
7985
  */
7986
7986
  listBundleComponents(input: ApiListBundleComponentsInput, options?: RequestOptions): Promise<Result<ApiListBundleComponentsResponse>>;
7987
7987
  /**
@@ -8011,7 +8011,7 @@ export declare class Client {
8011
8011
  /**
8012
8012
  * Returns every allocation made from a credit note, including reversed ones. Filter by idempotency_key to find the allocation a given request produced.
8013
8013
  * GET /v1/credit-notes/{credit_note_id}/allocations
8014
- * @example client.api.listCreditNoteAllocations({"credit_note_id":"example"})
8014
+ * @example client.api.listCreditNoteAllocations({credit_note_id: "example"})
8015
8015
  */
8016
8016
  listCreditNoteAllocations(input: ApiListCreditNoteAllocationsInput, options?: RequestOptions): Promise<Result<ApiListCreditNoteAllocationsResponse>>;
8017
8017
  /**
@@ -8029,7 +8029,7 @@ export declare class Client {
8029
8029
  /**
8030
8030
  * Lists the customer's saved addresses with billing and shipping default flags.
8031
8031
  * GET /v1/customers/{customer_id}/addresses
8032
- * @example client.api.listCustomerAddresses({"customer_id":"example"})
8032
+ * @example client.api.listCustomerAddresses({customer_id: "example"})
8033
8033
  */
8034
8034
  listCustomerAddresses(input: ApiListCustomerAddressesInput, options?: RequestOptions): Promise<Result<ApiListCustomerAddressesResponse>>;
8035
8035
  /**
@@ -8083,7 +8083,7 @@ export declare class Client {
8083
8083
  /**
8084
8084
  * Returns installs for a partner app owned by the authenticated merchant.
8085
8085
  * GET /v1/developer/partner/apps/{partner_app_id}/installs
8086
- * @example client.api.listDeveloperPartnerAppInstalls({"partner_app_id":"example"})
8086
+ * @example client.api.listDeveloperPartnerAppInstalls({partner_app_id: "example"})
8087
8087
  */
8088
8088
  listDeveloperPartnerAppInstalls(input: ApiListDeveloperPartnerAppInstallsInput, options?: RequestOptions): Promise<Result<ApiListDeveloperPartnerAppInstallsResponse>>;
8089
8089
  /**
@@ -8197,19 +8197,19 @@ export declare class Client {
8197
8197
  /**
8198
8198
  * Returns email delivery attempts for send and reminder actions.
8199
8199
  * GET /v1/invoices/{invoice_id}/delivery-attempts
8200
- * @example client.api.listInvoiceDeliveryAttempts({"invoice_id":"example"})
8200
+ * @example client.api.listInvoiceDeliveryAttempts({invoice_id: "example"})
8201
8201
  */
8202
8202
  listInvoiceDeliveryAttempts(input: ApiListInvoiceDeliveryAttemptsInput, options?: RequestOptions): Promise<Result<ApiListInvoiceDeliveryAttemptsResponse>>;
8203
8203
  /**
8204
8204
  * Returns the audit timeline for an invoice.
8205
8205
  * GET /v1/invoices/{invoice_id}/events
8206
- * @example client.api.listInvoiceEvents({"invoice_id":"example"})
8206
+ * @example client.api.listInvoiceEvents({invoice_id: "example"})
8207
8207
  */
8208
8208
  listInvoiceEvents(input: ApiListInvoiceEventsInput, options?: RequestOptions): Promise<Result<ApiListInvoiceEventsResponse>>;
8209
8209
  /**
8210
8210
  * Lists card and ACH collection attempts for an invoice in reverse chronological order.
8211
8211
  * GET /v1/invoices/{invoice_id}/payment-attempts
8212
- * @example client.api.listInvoicePaymentAttempts({"invoice_id":"example"})
8212
+ * @example client.api.listInvoicePaymentAttempts({invoice_id: "example"})
8213
8213
  */
8214
8214
  listInvoicePaymentAttempts(input: ApiListInvoicePaymentAttemptsInput, options?: RequestOptions): Promise<Result<ApiListInvoicePaymentAttemptsResponse>>;
8215
8215
  /**
@@ -8239,7 +8239,7 @@ export declare class Client {
8239
8239
  /**
8240
8240
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns credit notes for the authenticated merchant, newest first. Filter by invoice_id to see everything credited against one invoice.
8241
8241
  * GET /v1/me/invoices/{invoice_id}/credit-notes
8242
- * @example client.api.listMeCreditNotes({"invoice_id":"example"})
8242
+ * @example client.api.listMeCreditNotes({invoice_id: "example"})
8243
8243
  */
8244
8244
  listMeCreditNotes(input: ApiListMeCreditNotesInput, options?: RequestOptions): Promise<Result<ApiListMeCreditNotesResponse>>;
8245
8245
  /**
@@ -8257,7 +8257,7 @@ export declare class Client {
8257
8257
  /**
8258
8258
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a read-only, human-readable history log for an order. Use it to render timelines and debug what happened, not as a source of truth, ledger, or webhook replacement. Read the owning resource for authoritative state: the order for balances and status, the payment for payment state, the refund for refund outcomes, and the checkout session for checkout state. Do not sum balance_delta_money to compute an order balance. Informational rows such as payment_failed, refund_failed, and checkout_session_expired have a zero balance delta. The default order is newest first. Use sort_direction=asc for chronological timeline rendering. A typical chronological log might show created, payment_failed, payment, refund, then refund_failed; each row gives one reference to click through for the authoritative resource.
8259
8259
  * GET /v1/me/orders/{order_id}/activities
8260
- * @example client.api.listMeOrderActivities({"order_id":"example"})
8260
+ * @example client.api.listMeOrderActivities({order_id: "example"})
8261
8261
  */
8262
8262
  listMeOrderActivities(input: ApiListMeOrderActivitiesInput, options?: RequestOptions): Promise<Result<ApiListMeOrderActivitiesResponse>>;
8263
8263
  /**
@@ -8335,13 +8335,13 @@ export declare class Client {
8335
8335
  /**
8336
8336
  * Returns a read-only, human-readable history log for an order. Use it to render timelines and debug what happened, not as a source of truth, ledger, or webhook replacement. Read the owning resource for authoritative state: the order for balances and status, the payment for payment state, the refund for refund outcomes, and the checkout session for checkout state. Do not sum balance_delta_money to compute an order balance. Informational rows such as payment_failed, refund_failed, and checkout_session_expired have a zero balance delta. The default order is newest first. Use sort_direction=asc for chronological timeline rendering. A typical chronological log might show created, payment_failed, payment, refund, then refund_failed; each row gives one reference to click through for the authoritative resource.
8337
8337
  * GET /v1/orders/{order_id}/activities
8338
- * @example client.api.listOrderActivities({"order_id":"example"})
8338
+ * @example client.api.listOrderActivities({order_id: "example"})
8339
8339
  */
8340
8340
  listOrderActivities(input: ApiListOrderActivitiesInput, options?: RequestOptions): Promise<Result<ApiListOrderActivitiesResponse>>;
8341
8341
  /**
8342
8342
  * Returns payment attempts for the order, newest first. Checkout-session callers see only attempts created by their own session.
8343
8343
  * GET /v1/orders/{order_id}/payment-attempts
8344
- * @example client.api.listOrderPaymentAttempts({"order_id":"example"})
8344
+ * @example client.api.listOrderPaymentAttempts({order_id: "example"})
8345
8345
  */
8346
8346
  listOrderPaymentAttempts(input: ApiListOrderPaymentAttemptsInput, options?: RequestOptions): Promise<Result<ApiListOrderPaymentAttemptsResponse>>;
8347
8347
  /**
@@ -8353,7 +8353,7 @@ export declare class Client {
8353
8353
  /**
8354
8354
  * Returns the direct memberships for an organization.
8355
8355
  * GET /v1/organizations/{organization_id}/memberships
8356
- * @example client.api.listOrganizationMemberships({"organization_id":"example"})
8356
+ * @example client.api.listOrganizationMemberships({organization_id: "example"})
8357
8357
  */
8358
8358
  listOrganizationMemberships(input: ApiListOrganizationMembershipsInput, options?: RequestOptions): Promise<Result<ApiListOrganizationMembershipsResponse>>;
8359
8359
  /**
@@ -8365,7 +8365,7 @@ export declare class Client {
8365
8365
  /**
8366
8366
  * Lists order line quantities contained in packages.
8367
8367
  * GET /v1/packages/{package_id}/items
8368
- * @example client.api.listPackageItems({"package_id":"example"})
8368
+ * @example client.api.listPackageItems({package_id: "example"})
8369
8369
  */
8370
8370
  listPackageItems(input: ApiListPackageItemsInput, options?: RequestOptions): Promise<Result<ApiListPackageItemsResponse>>;
8371
8371
  /**
@@ -8407,7 +8407,7 @@ export declare class Client {
8407
8407
  /**
8408
8408
  * Lists the authoritative balance-transaction allocations for a payout in ascending occurrence order. A paid payout returns an unavailable error instead of incomplete or inferred entries.
8409
8409
  * GET /v1/payouts/{payout_id}/entries
8410
- * @example client.api.listPayoutEntries({"payout_id":"example"})
8410
+ * @example client.api.listPayoutEntries({payout_id: "example"})
8411
8411
  */
8412
8412
  listPayoutEntries(input: ApiListPayoutEntriesInput, options?: RequestOptions): Promise<Result<ApiListPayoutEntriesResponse>>;
8413
8413
  /**
@@ -8419,7 +8419,7 @@ export declare class Client {
8419
8419
  /**
8420
8420
  * List product options.
8421
8421
  * GET /v1/products/{product_id}/options
8422
- * @example client.api.listProductOptions({"product_id":"example"})
8422
+ * @example client.api.listProductOptions({product_id: "example"})
8423
8423
  */
8424
8424
  listProductOptions(input: ApiListProductOptionsInput, options?: RequestOptions): Promise<Result<ApiListProductOptionsResponse>>;
8425
8425
  /**
@@ -8431,13 +8431,13 @@ export declare class Client {
8431
8431
  /**
8432
8432
  * List product variants.
8433
8433
  * GET /v1/products/{product_id}/variants
8434
- * @example client.api.listProductVariants({"product_id":"example"})
8434
+ * @example client.api.listProductVariants({product_id: "example"})
8435
8435
  */
8436
8436
  listProductVariants(input: ApiListProductVariantsInput, options?: RequestOptions): Promise<Result<ApiListProductVariantsResponse>>;
8437
8437
  /**
8438
8438
  * Returns a paginated list of codes for a promotion.
8439
8439
  * GET /v1/promotions/{promotion_id}/codes
8440
- * @example client.api.listPromotionCodes({"promotion_id":"example"})
8440
+ * @example client.api.listPromotionCodes({promotion_id: "example"})
8441
8441
  */
8442
8442
  listPromotionCodes(input: ApiListPromotionCodesInput, options?: RequestOptions): Promise<Result<ApiListPromotionCodesResponse>>;
8443
8443
  /**
@@ -8473,7 +8473,7 @@ export declare class Client {
8473
8473
  /**
8474
8474
  * List the line items on a Return with their quantity counters, eligibility, frozen display identity, and return value.
8475
8475
  * GET /v1/returns/{return_id}/line-items
8476
- * @example client.api.listReturnLineItems({"return_id":"example"})
8476
+ * @example client.api.listReturnLineItems({return_id: "example"})
8477
8477
  */
8478
8478
  listReturnLineItems(input: ApiListReturnLineItemsInput, options?: RequestOptions): Promise<Result<ApiListReturnLineItemsResponse>>;
8479
8479
  /**
@@ -8485,7 +8485,7 @@ export declare class Client {
8485
8485
  /**
8486
8486
  * List every published revision of a Return policy.
8487
8487
  * GET /v1/return-policies/{return_policy_id}/revisions
8488
- * @example client.api.listReturnPolicyRevisions({"return_policy_id":"example"})
8488
+ * @example client.api.listReturnPolicyRevisions({return_policy_id: "example"})
8489
8489
  */
8490
8490
  listReturnPolicyRevisions(input: ApiListReturnPolicyRevisionsInput, options?: RequestOptions): Promise<Result<ApiListReturnPolicyRevisionsResponse>>;
8491
8491
  /**
@@ -8521,7 +8521,7 @@ export declare class Client {
8521
8521
  /**
8522
8522
  * List risk list items for the authenticated merchant environment.
8523
8523
  * GET /v1/risk-lists/{risk_list_id}/items
8524
- * @example client.api.listRiskListItems({"risk_list_id":"example"})
8524
+ * @example client.api.listRiskListItems({risk_list_id: "example"})
8525
8525
  */
8526
8526
  listRiskListItems(input: ApiListRiskListItemsInput, options?: RequestOptions): Promise<Result<ApiListRiskListItemsResponse>>;
8527
8527
  /**
@@ -8545,7 +8545,7 @@ export declare class Client {
8545
8545
  /**
8546
8546
  * Returns a subscription's manual payment retries, newest first.
8547
8547
  * GET /v1/subscriptions/{subscription_id}/payment-retries
8548
- * @example client.api.listSubscriptionPaymentRetries({"subscription_id":"example"})
8548
+ * @example client.api.listSubscriptionPaymentRetries({subscription_id: "example"})
8549
8549
  */
8550
8550
  listSubscriptionPaymentRetries(input: ApiListSubscriptionPaymentRetriesInput, options?: RequestOptions): Promise<Result<ApiListSubscriptionPaymentRetriesResponse>>;
8551
8551
  /**
@@ -8563,13 +8563,13 @@ export declare class Client {
8563
8563
  /**
8564
8564
  * Returns endpoint deliveries created for one canonical webhook event.
8565
8565
  * GET /v1/webhook-events/{webhook_event_id}/deliveries
8566
- * @example client.api.listWebhookDeliveries({"webhook_event_id":"example"})
8566
+ * @example client.api.listWebhookDeliveries({webhook_event_id: "example"})
8567
8567
  */
8568
8568
  listWebhookDeliveries(input: ApiListWebhookDeliveriesInput, options?: RequestOptions): Promise<Result<ApiListWebhookDeliveriesResponse>>;
8569
8569
  /**
8570
8570
  * Returns the attempts recorded for a specific webhook delivery.
8571
8571
  * GET /v1/webhook-deliveries/{webhook_delivery_id}/attempts
8572
- * @example client.api.listWebhookDeliveryAttempts({"webhook_delivery_id":"example"})
8572
+ * @example client.api.listWebhookDeliveryAttempts({webhook_delivery_id: "example"})
8573
8573
  */
8574
8574
  listWebhookDeliveryAttempts(input: ApiListWebhookDeliveryAttemptsInput, options?: RequestOptions): Promise<Result<ApiListWebhookDeliveryAttemptsResponse>>;
8575
8575
  /**
@@ -8593,355 +8593,355 @@ export declare class Client {
8593
8593
  /**
8594
8594
  * Closes the outstanding balance as a write-off and releases the order's invoice collection authority. Safe to retry with the same Idempotency-Key.
8595
8595
  * POST /v1/invoices/{invoice_id}/mark-uncollectible
8596
- * @example client.api.markInvoiceUncollectible({"invoice_id":"example"})
8596
+ * @example client.api.markInvoiceUncollectible({invoice_id: "example"})
8597
8597
  */
8598
8598
  markInvoiceUncollectible(input: ApiMarkInvoiceUncollectibleInput, options?: RequestOptions): Promise<Result<ApiMarkInvoiceUncollectibleResponse>>;
8599
8599
  /**
8600
8600
  * Stops the automatic reminder cadence on a collectible invoice and sets reminders_paused_at. Manual send-reminder calls still work, and invoice.overdue and invoice.late_fee_due still fire.
8601
8601
  * POST /v1/invoices/{invoice_id}/pause-reminders
8602
- * @example client.api.pauseInvoiceReminders({"invoice_id":"example"})
8602
+ * @example client.api.pauseInvoiceReminders({invoice_id: "example"})
8603
8603
  */
8604
8604
  pauseInvoiceReminders(input: ApiPauseInvoiceRemindersInput, options?: RequestOptions): Promise<Result<ApiPauseInvoiceRemindersResponse>>;
8605
8605
  /**
8606
8606
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Pauses a subscription immediately, optionally for a fixed number of billing cycles.
8607
8607
  * POST /v1/me/subscriptions/{subscription_id}/pause
8608
- * @example client.api.pauseMeSubscription({"subscription_id":"example","body":{}})
8608
+ * @example client.api.pauseMeSubscription({subscription_id: "example", body: {}})
8609
8609
  */
8610
8610
  pauseMeSubscription(input: ApiPauseMeSubscriptionInput, options?: RequestOptions): Promise<Result<ApiPauseMeSubscriptionResponse>>;
8611
8611
  /**
8612
8612
  * Pauses a subscription immediately, optionally for a fixed number of billing cycles.
8613
8613
  * POST /v1/subscriptions/{subscription_id}/pause
8614
- * @example client.api.pauseSubscription({"subscription_id":"example","body":{}})
8614
+ * @example client.api.pauseSubscription({subscription_id: "example", body: {}})
8615
8615
  */
8616
8616
  pauseSubscription(input: ApiPauseSubscriptionInput, options?: RequestOptions): Promise<Result<ApiPauseSubscriptionResponse>>;
8617
8617
  /**
8618
8618
  * Starts or resumes a payment attempt on the order. Set action to pay to charge the full outstanding balance, confirm_payment_intents to confirm order-owned payment intents, setup to save a newly collected token on a zero-balance order, or resume to continue an attempt after a pending client action. Each action accepts only its own fields. Only confirm_payment_intents accepts completion_behavior. A pay action without payment_source is valid only when the outstanding balance is zero. To resume, send action: resume with payment_attempt_id, or replay the exact original request with the same Idempotency-Key while the attempt is open. Payment intents with manual capture return an active authorization instead of settling immediately.
8619
8619
  * POST /v1/orders/{order_id}/pay
8620
- * @example client.api.payOrder({"order_id":"example","body":{"action":"pay"}})
8620
+ * @example client.api.payOrder({order_id: "example", body: {action: "pay"}})
8621
8621
  */
8622
8622
  payOrder(input: ApiPayOrderInput, options?: RequestOptions): Promise<Result<ApiPayOrderResponse>>;
8623
8623
  /**
8624
8624
  * Evaluates promotion outcomes for an order without mutating it. Merchant-authenticated callers may include a promotion by promotion_id or promotion_code; checkout-authenticated buyers must provide a code. The response includes applied, skipped, and single-threshold available promotion candidates.
8625
8625
  * POST /v1/orders/{order_id}/discounts/preview
8626
- * @example client.api.previewOrderDiscounts({"order_id":"example"})
8626
+ * @example client.api.previewOrderDiscounts({order_id: "example"})
8627
8627
  */
8628
8628
  previewOrderDiscounts(input: ApiPreviewOrderDiscountsInput, options?: RequestOptions): Promise<Result<ApiPreviewOrderDiscountsResponse>>;
8629
8629
  /**
8630
8630
  * Validates the install link inputs and returns the partner app metadata and requested permissions for the consent screen.
8631
8631
  * GET /v1/oauth/authorize/preview
8632
- * @example client.api.previewPartnerInstallAuthorization({"client_id":"example","redirect_uri":"example","mode":"test"})
8632
+ * @example client.api.previewPartnerInstallAuthorization({client_id: "example", redirect_uri: "example", mode: "test"})
8633
8633
  */
8634
8634
  previewPartnerInstallAuthorization(input: ApiPreviewPartnerInstallAuthorizationInput, options?: RequestOptions): Promise<Result<ApiPreviewPartnerInstallAuthorizationResponse>>;
8635
8635
  /**
8636
8636
  * Process an existing requested Return atomically at the Flint facts layer. Requires the current Return version and Idempotency-Key. Linked effects remain asynchronous.
8637
8637
  * POST /v1/returns/{return_id}/process
8638
- * @example client.api.processExistingReturn({"return_id":"example","Idempotency-Key":"example","body":{"line_items":[{"return_line_item_id":"example"}]}})
8638
+ * @example client.api.processExistingReturn({return_id: "example", "Idempotency-Key": "example", body: {line_items: [{return_line_item_id: "example"}]}})
8639
8639
  */
8640
8640
  processExistingReturn(input: ApiProcessExistingReturnInput, options?: RequestOptions): Promise<Result<ApiProcessExistingReturnResponse>>;
8641
8641
  /**
8642
8642
  * Publishes the location geography atomically. Supply the complete address and timezone; omitted coordinates are cleared. This PATCH does not merge nested address fields. Requires expected_geography_revision, independently of the location version used for metadata edits.
8643
8643
  * PATCH /v1/locations/{location_id}/geography
8644
- * @example client.api.publishLocationGeography({"location_id":"example","body":{"address":{},"expected_geography_revision":"0","timezone":"example"}})
8644
+ * @example client.api.publishLocationGeography({location_id: "example", body: {address: {}, expected_geography_revision: "0", timezone: "example"}})
8645
8645
  */
8646
8646
  publishLocationGeography(input: ApiPublishLocationGeographyInput, options?: RequestOptions): Promise<Result<ApiPublishLocationGeographyResponse>>;
8647
8647
  /**
8648
8648
  * Publish a new immutable Return policy revision while preserving the stable policy identity.
8649
8649
  * POST /v1/return-policies/{return_policy_id}/revisions
8650
- * @example client.api.publishReturnPolicyRevision({"return_policy_id":"example","body":{"expected_current_return_policy_revision_id":"example","revision":{"approval_mode":"automatic","eligibility_result":"ineligible","is_merchandise_return_required":true,"priority":1,"scope":{}}}})
8650
+ * @example client.api.publishReturnPolicyRevision({return_policy_id: "example", body: {expected_current_return_policy_revision_id: "example", revision: {approval_mode: "automatic", eligibility_result: "ineligible", is_merchandise_return_required: true, priority: 1, scope: {}}}})
8651
8651
  */
8652
8652
  publishReturnPolicyRevision(input: ApiPublishReturnPolicyRevisionInput, options?: RequestOptions): Promise<Result<ApiPublishReturnPolicyRevisionResponse>>;
8653
8653
  /**
8654
8654
  * Computes a bounded, non-holding pickup-location projection from current checkout authority and one inventory snapshot. Merchant-authenticated requests include configured Location diagnostics; checkout credentials receive only buyer-safe results.
8655
8655
  * POST /v1/checkout-sessions/{checkout_session_id}/query-pickup-availability
8656
- * @example client.api.queryCheckoutSessionPickupAvailability({"checkout_session_id":"example","body":{}})
8656
+ * @example client.api.queryCheckoutSessionPickupAvailability({checkout_session_id: "example", body: {}})
8657
8657
  */
8658
8658
  queryCheckoutSessionPickupAvailability(input: ApiQueryCheckoutSessionPickupAvailabilityInput, options?: RequestOptions): Promise<Result<ApiQueryCheckoutSessionPickupAvailabilityResponse>>;
8659
8659
  /**
8660
8660
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Clears a pending period-end cancellation without changing the current billing period.
8661
8661
  * POST /v1/me/subscriptions/{subscription_id}/reactivate
8662
- * @example client.api.reactivateMeSubscription({"subscription_id":"example"})
8662
+ * @example client.api.reactivateMeSubscription({subscription_id: "example"})
8663
8663
  */
8664
8664
  reactivateMeSubscription(input: ApiReactivateMeSubscriptionInput, options?: RequestOptions): Promise<Result<ApiReactivateMeSubscriptionResponse>>;
8665
8665
  /**
8666
8666
  * Clears a pending period-end cancellation without changing the current billing period.
8667
8667
  * POST /v1/subscriptions/{subscription_id}/reactivate
8668
- * @example client.api.reactivateSubscription({"subscription_id":"example"})
8668
+ * @example client.api.reactivateSubscription({subscription_id: "example"})
8669
8669
  */
8670
8670
  reactivateSubscription(input: ApiReactivateSubscriptionInput, options?: RequestOptions): Promise<Result<ApiReactivateSubscriptionResponse>>;
8671
8671
  /**
8672
8672
  * Applies an offline/manual payment to an issued invoice. Recording is rejected with INVOICE_PAYMENT_RESOLVING while an online payment is still resolving; an idle open checkout does not block. A payment that clears the balance invalidates the open checkout session. Safe to retry with the same Idempotency-Key.
8673
8673
  * POST /v1/invoices/{invoice_id}/manual-payments
8674
- * @example client.api.recordManualInvoicePayment({"invoice_id":"example","body":{"amount_money":{"amount":"0","currency":"USD"}}})
8674
+ * @example client.api.recordManualInvoicePayment({invoice_id: "example", body: {amount_money: {amount: "0", currency: "USD"}}})
8675
8675
  */
8676
8676
  recordManualInvoicePayment(input: ApiRecordManualInvoicePaymentInput, options?: RequestOptions): Promise<Result<ApiRecordManualInvoicePaymentResponse>>;
8677
8677
  /**
8678
8678
  * Rotates a customer session secret and refresh token without a merchant API key. Reusing a rotated refresh token revokes the session family.
8679
8679
  * POST /v1/customer-sessions/refresh
8680
- * @example client.api.refreshCustomerSession({"Idempotency-Key":"example","body":{"refresh_token":"example"}})
8680
+ * @example client.api.refreshCustomerSession({"Idempotency-Key": "example", body: {refresh_token: "example"}})
8681
8681
  */
8682
8682
  refreshCustomerSession(input: ApiRefreshCustomerSessionInput, options?: RequestOptions): Promise<Result<ApiRefreshCustomerSessionResponse>>;
8683
8683
  /**
8684
8684
  * Creates a fresh provider session from a signed launch token after rechecking the authenticated principal, merchant environment, account controller, and component grant.
8685
8685
  * POST /v1/merchant-account-sessions/refresh
8686
- * @example client.api.refreshMerchantAccountSession({"body":{"launch_token":"example"}})
8686
+ * @example client.api.refreshMerchantAccountSession({body: {launch_token: "example"}})
8687
8687
  */
8688
8688
  refreshMerchantAccountSession(input: ApiRefreshMerchantAccountSessionInput, options?: RequestOptions): Promise<Result<ApiRefreshMerchantAccountSessionResponse>>;
8689
8689
  /**
8690
8690
  * Revokes the current buyer-access link and all checkout credentials derived from it, then returns a new public_url. The current checkout session and its payment lineage are preserved. Safe to retry with the same Idempotency-Key.
8691
8691
  * POST /v1/invoices/{invoice_id}/regenerate-public-link
8692
- * @example client.api.regenerateInvoicePublicLink({"invoice_id":"example"})
8692
+ * @example client.api.regenerateInvoicePublicLink({invoice_id: "example"})
8693
8693
  */
8694
8694
  regenerateInvoicePublicLink(input: ApiRegenerateInvoicePublicLinkInput, options?: RequestOptions): Promise<Result<ApiRegenerateInvoicePublicLinkResponse>>;
8695
8695
  /**
8696
8696
  * Release held or committed quantity back to available. Cumulative targets; released quantity is terminal.
8697
8697
  * POST /v1/inventory-reservations/{inventory_reservation_id}/release
8698
- * @example client.api.releaseInventoryReservation({"Idempotency-Key":"example","inventory_reservation_id":"example","body":{"lines":[]}})
8698
+ * @example client.api.releaseInventoryReservation({"Idempotency-Key": "example", inventory_reservation_id: "example", body: {lines: []}})
8699
8699
  */
8700
8700
  releaseInventoryReservation(input: ApiReleaseInventoryReservationInput, options?: RequestOptions): Promise<Result<ApiReleaseInventoryReservationResponse>>;
8701
8701
  /**
8702
8702
  * Release a confirmed resolution that is waiting on a manual release. Available only while action_reason is manual_release.
8703
8703
  * POST /v1/return-resolutions/{return_resolution_id}/release
8704
- * @example client.api.releaseReturnResolution({"return_resolution_id":"example","body":{"reason":"merchant_approved"}})
8704
+ * @example client.api.releaseReturnResolution({return_resolution_id: "example", body: {reason: "merchant_approved"}})
8705
8705
  */
8706
8706
  releaseReturnResolution(input: ApiReleaseReturnResolutionInput, options?: RequestOptions): Promise<Result<ApiReleaseReturnResolutionResponse>>;
8707
8707
  /**
8708
8708
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Soft-removes a saved payment method so it can no longer be used for future payments.
8709
8709
  * DELETE /v1/me/payment-methods/{payment_method_id}
8710
- * @example client.api.removeMePaymentMethod({"payment_method_id":"example"})
8710
+ * @example client.api.removeMePaymentMethod({payment_method_id: "example"})
8711
8711
  */
8712
8712
  removeMePaymentMethod(input: ApiRemoveMePaymentMethodInput, options?: RequestOptions): Promise<Result<ApiRemoveMePaymentMethodResponse>>;
8713
8713
  /**
8714
8714
  * Removes one or more pending applied discounts from an order. Redeemed or canceled discounts are settlement history and cannot be removed.
8715
8715
  * POST /v1/orders/{order_id}/discounts/remove
8716
- * @example client.api.removeOrderDiscounts({"order_id":"example","body":{"order_discount_ids":[]}})
8716
+ * @example client.api.removeOrderDiscounts({order_id: "example", body: {order_discount_ids: []}})
8717
8717
  */
8718
8718
  removeOrderDiscounts(input: ApiRemoveOrderDiscountsInput, options?: RequestOptions): Promise<Result<ApiRemoveOrderDiscountsResponse>>;
8719
8719
  /**
8720
8720
  * Soft-removes a saved payment method so it can no longer be used for future payments.
8721
8721
  * DELETE /v1/payment-methods/{payment_method_id}
8722
- * @example client.api.removePaymentMethod({"payment_method_id":"example"})
8722
+ * @example client.api.removePaymentMethod({payment_method_id: "example"})
8723
8723
  */
8724
8724
  removePaymentMethod(input: ApiRemovePaymentMethodInput, options?: RequestOptions): Promise<Result<ApiRemovePaymentMethodResponse>>;
8725
8725
  /**
8726
8726
  * Reopen a completed Return to record late compensating facts. Confirmed money movements are never edited backward, so a monetary fix is a new correction resolution.
8727
8727
  * POST /v1/returns/{return_id}/reopen
8728
- * @example client.api.reopenReturn({"return_id":"example","body":{"reason":"linked_effect_changed"}})
8728
+ * @example client.api.reopenReturn({return_id: "example", body: {reason: "linked_effect_changed"}})
8729
8729
  */
8730
8730
  reopenReturn(input: ApiReopenReturnInput, options?: RequestOptions): Promise<Result<ApiReopenReturnResponse>>;
8731
8731
  /**
8732
8732
  * Recalculates pending discounts and automatic promotions for a mutable order.
8733
8733
  * POST /v1/orders/{order_id}/discounts/reprice
8734
- * @example client.api.repriceOrderDiscounts({"order_id":"example"})
8734
+ * @example client.api.repriceOrderDiscounts({order_id: "example"})
8735
8735
  */
8736
8736
  repriceOrderDiscounts(input: ApiRepriceOrderDiscountsInput, options?: RequestOptions): Promise<Result<ApiRepriceOrderDiscountsResponse>>;
8737
8737
  /**
8738
8738
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Queues another receipt email for a paid order when Flint manages receipt delivery. The recipient is derived from the order and cannot be supplied by the caller. When the merchant manages receipt delivery, ask the merchant for another copy.
8739
8739
  * POST /v1/me/orders/{order_id}/receipt
8740
- * @example client.api.resendMeOrderReceipt({"order_id":"example"})
8740
+ * @example client.api.resendMeOrderReceipt({order_id: "example"})
8741
8741
  */
8742
8742
  resendMeOrderReceipt(input: ApiResendMeOrderReceiptInput, options?: RequestOptions): Promise<Result<ApiResendMeOrderReceiptResponse>>;
8743
8743
  /**
8744
8744
  * Queues another receipt email for a paid order when Flint manages receipt delivery. The recipient is derived from the order and cannot be supplied by the caller. When the merchant manages receipt delivery, ask the merchant for another copy.
8745
8745
  * POST /v1/orders/{order_id}/receipt
8746
- * @example client.api.resendOrderReceipt({"order_id":"example"})
8746
+ * @example client.api.resendOrderReceipt({order_id: "example"})
8747
8747
  */
8748
8748
  resendOrderReceipt(input: ApiResendOrderReceiptInput, options?: RequestOptions): Promise<Result<ApiResendOrderReceiptResponse>>;
8749
8749
  /**
8750
8750
  * Sends the canonical event payload again to the delivery's current webhook endpoint URL. Safe to retry with the same Idempotency-Key.
8751
8751
  * POST /v1/webhook-deliveries/{webhook_delivery_id}/resend
8752
- * @example client.api.resendWebhookDelivery({"webhook_delivery_id":"example"})
8752
+ * @example client.api.resendWebhookDelivery({webhook_delivery_id: "example"})
8753
8753
  */
8754
8754
  resendWebhookDelivery(input: ApiResendWebhookDeliveryInput, options?: RequestOptions): Promise<Result<ApiResendWebhookDeliveryResponse>>;
8755
8755
  /**
8756
8756
  * Ends the caller's current demo sandbox (if any) and provisions a fresh one, returning a new temporary API key. Useful when the original one-time secret was lost. Subject to the same per-client daily limit as creation.
8757
8757
  * POST /v1/demo-sessions/reset
8758
- * @example client.api.resetDemoSession({"body":{}})
8758
+ * @example client.api.resetDemoSession({body: {}})
8759
8759
  */
8760
8760
  resetDemoSession(input: ApiResetDemoSessionInput, options?: RequestOptions): Promise<Result<ApiResetDemoSessionResponse>>;
8761
8761
  /**
8762
8762
  * Clears a non-default sandbox and returns its replacement environment. The replacement has a new sandbox ID, retains the stable provider-account lineage, and requires newly issued test keys.
8763
8763
  * POST /v1/developer/sandboxes/{sandbox_id}/reset
8764
- * @example client.api.resetDeveloperSandbox({"sandbox_id":"example"})
8764
+ * @example client.api.resetDeveloperSandbox({sandbox_id: "example"})
8765
8765
  */
8766
8766
  resetDeveloperSandbox(input: ApiResetDeveloperSandboxInput, options?: RequestOptions): Promise<Result<ApiResetDeveloperSandboxResponse>>;
8767
8767
  /**
8768
8768
  * Approves or rejects a pending deletion request. Approval returns processing while account data and buyer credentials are deleted asynchronously. A failed deletion can be approved again but cannot be rejected. Approval is blocked while the customer has non-canceled subscriptions or usable saved payment methods.
8769
8769
  * POST /v1/customer-deletion-requests/{customer_deletion_request_id}/resolve
8770
- * @example client.api.resolveCustomerDeletionRequest({"customer_deletion_request_id":"example","body":{"decision":"approve"}})
8770
+ * @example client.api.resolveCustomerDeletionRequest({customer_deletion_request_id: "example", body: {decision: "approve"}})
8771
8771
  */
8772
8772
  resolveCustomerDeletionRequest(input: ApiResolveCustomerDeletionRequestInput, options?: RequestOptions): Promise<Result<ApiResolveCustomerDeletionRequestResponse>>;
8773
8773
  /**
8774
8774
  * Marks a paid inventory failure as resolved after an operator has completed manual inventory remediation.
8775
8775
  * POST /v1/orders/{order_id}/inventory-exception/resolve
8776
- * @example client.api.resolveOrderInventoryException({"order_id":"example"})
8776
+ * @example client.api.resolveOrderInventoryException({order_id: "example"})
8777
8777
  */
8778
8778
  resolveOrderInventoryException(input: ApiResolveOrderInventoryExceptionInput, options?: RequestOptions): Promise<Result<ApiResolveOrderInventoryExceptionResponse>>;
8779
8779
  /**
8780
8780
  * Creates a buyer checkout session from an active payment link. Catalog-backed modifier availability is frozen onto the checkout session and selected modifiers are resolved onto the backing order.
8781
8781
  * POST /v1/payment-links/{payment_link_id}/resolve
8782
- * @example client.api.resolvePaymentLink({"payment_link_id":"example","Idempotency-Key":"example","body":{"resolution_context":"example"}})
8782
+ * @example client.api.resolvePaymentLink({payment_link_id: "example", "Idempotency-Key": "example", body: {resolution_context: "example"}})
8783
8783
  */
8784
8784
  resolvePaymentLink(input: ApiResolvePaymentLinkInput, options?: RequestOptions): Promise<Result<ApiResolvePaymentLinkResponse>>;
8785
8785
  /**
8786
8786
  * Resolves a buyer-entered promotion code to its promotion code record and parent promotion. This does not evaluate the code against an order or redeem it.
8787
8787
  * GET /v1/promotions/by-code/{code}
8788
- * @example client.api.resolvePromotionCode({"code":"example"})
8788
+ * @example client.api.resolvePromotionCode({code: "example"})
8789
8789
  */
8790
8790
  resolvePromotionCode(input: ApiResolvePromotionCodeInput, options?: RequestOptions): Promise<Result<ApiResolvePromotionCodeResponse>>;
8791
8791
  /**
8792
8792
  * Clears reminders_paused_at so the invoice resumes its reminder cadence. Reminder times that passed while it was paused do not fire retroactively.
8793
8793
  * POST /v1/invoices/{invoice_id}/resume-reminders
8794
- * @example client.api.resumeInvoiceReminders({"invoice_id":"example"})
8794
+ * @example client.api.resumeInvoiceReminders({invoice_id: "example"})
8795
8795
  */
8796
8796
  resumeInvoiceReminders(input: ApiResumeInvoiceRemindersInput, options?: RequestOptions): Promise<Result<ApiResumeInvoiceRemindersResponse>>;
8797
8797
  /**
8798
8798
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Resumes a paused subscription.
8799
8799
  * POST /v1/me/subscriptions/{subscription_id}/resume
8800
- * @example client.api.resumeMeSubscription({"subscription_id":"example"})
8800
+ * @example client.api.resumeMeSubscription({subscription_id: "example"})
8801
8801
  */
8802
8802
  resumeMeSubscription(input: ApiResumeMeSubscriptionInput, options?: RequestOptions): Promise<Result<ApiResumeMeSubscriptionResponse>>;
8803
8803
  /**
8804
8804
  * Resumes a paused subscription.
8805
8805
  * POST /v1/subscriptions/{subscription_id}/resume
8806
- * @example client.api.resumeSubscription({"subscription_id":"example"})
8806
+ * @example client.api.resumeSubscription({subscription_id: "example"})
8807
8807
  */
8808
8808
  resumeSubscription(input: ApiResumeSubscriptionInput, options?: RequestOptions): Promise<Result<ApiResumeSubscriptionResponse>>;
8809
8809
  /**
8810
8810
  * Retry a failed disposition with the same immutable intent. Disposition and effect identities are preserved, so a retry does not move stock twice.
8811
8811
  * POST /v1/return-dispositions/{return_disposition_id}/retry
8812
- * @example client.api.retryReturnDisposition({"return_disposition_id":"example","body":{"reason":"dependency_recovered"}})
8812
+ * @example client.api.retryReturnDisposition({return_disposition_id: "example", body: {reason: "dependency_recovered"}})
8813
8813
  */
8814
8814
  retryReturnDisposition(input: ApiRetryReturnDispositionInput, options?: RequestOptions): Promise<Result<ApiRetryReturnDispositionResponse>>;
8815
8815
  /**
8816
8816
  * Retry a failed resolution. A new attempt starts, historical payment and refund IDs stay on the resolution, and a late event from an earlier attempt cannot settle the new attempt.
8817
8817
  * POST /v1/return-resolutions/{return_resolution_id}/retry
8818
- * @example client.api.retryReturnResolution({"return_resolution_id":"example","body":{"reason":"dependency_recovered"}})
8818
+ * @example client.api.retryReturnResolution({return_resolution_id: "example", body: {reason: "dependency_recovered"}})
8819
8819
  */
8820
8820
  retryReturnResolution(input: ApiRetryReturnResolutionInput, options?: RequestOptions): Promise<Result<ApiRetryReturnResolutionResponse>>;
8821
8821
  /**
8822
8822
  * Reverses an allocation and reopens that much of the invoice balance. The original allocation keeps its row and gains reversed_at, so the history stays append-only. Reversing the allocation that closed an invoice moves it from credited back to open or partially_paid.
8823
8823
  * POST /v1/credit-notes/{credit_note_id}/allocations/{credit_note_allocation_id}/reverse
8824
- * @example client.api.reverseCreditNoteAllocation({"credit_note_id":"example","credit_note_allocation_id":"example"})
8824
+ * @example client.api.reverseCreditNoteAllocation({credit_note_id: "example", credit_note_allocation_id: "example"})
8825
8825
  */
8826
8826
  reverseCreditNoteAllocation(input: ApiReverseCreditNoteAllocationInput, options?: RequestOptions): Promise<Result<ApiReverseCreditNoteAllocationResponse>>;
8827
8827
  /**
8828
8828
  * Reverses previously applied manual/offline payment amount from an invoice. Safe to retry with the same Idempotency-Key.
8829
8829
  * POST /v1/invoices/{invoice_id}/manual-payments/reverse
8830
- * @example client.api.reverseManualInvoicePayment({"invoice_id":"example","body":{"amount_money":{"amount":"0","currency":"USD"}}})
8830
+ * @example client.api.reverseManualInvoicePayment({invoice_id: "example", body: {amount_money: {amount: "0", currency: "USD"}}})
8831
8831
  */
8832
8832
  reverseManualInvoicePayment(input: ApiReverseManualInvoicePaymentInput, options?: RequestOptions): Promise<Result<ApiReverseManualInvoicePaymentResponse>>;
8833
8833
  /**
8834
8834
  * Permanently revokes an external API key and returns metadata with status revoked.
8835
8835
  * POST /v1/api-keys/{api_key_id}/revoke
8836
- * @example client.api.revokeAPIKey({"api_key_id":"example"})
8836
+ * @example client.api.revokeAPIKey({api_key_id: "example"})
8837
8837
  */
8838
8838
  revokeAPIKey(input: ApiRevokeAPIKeyInput, options?: RequestOptions): Promise<Result<ApiRevokeAPIKeyResponse>>;
8839
8839
  /**
8840
8840
  * Revokes one customer session. This does not revoke an independent Flint Account buyer session.
8841
8841
  * POST /v1/customer-sessions/{customer_session_id}/revoke
8842
- * @example client.api.revokeCustomerSession({"customer_session_id":"example"})
8842
+ * @example client.api.revokeCustomerSession({customer_session_id: "example"})
8843
8843
  */
8844
8844
  revokeCustomerSession(input: ApiRevokeCustomerSessionInput, options?: RequestOptions): Promise<Result<ApiRevokeCustomerSessionResponse>>;
8845
8845
  /**
8846
8846
  * Revokes every customer session for one customer in the selected merchant environment. Flint Account buyer sessions remain independent.
8847
8847
  * POST /v1/customers/{customer_id}/sessions/revoke
8848
- * @example client.api.revokeCustomerSessions({"customer_id":"example"})
8848
+ * @example client.api.revokeCustomerSessions({customer_id: "example"})
8849
8849
  */
8850
8850
  revokeCustomerSessions(input: ApiRevokeCustomerSessionsInput, options?: RequestOptions): Promise<Result<ApiRevokeCustomerSessionsResponse>>;
8851
8851
  /**
8852
8852
  * Permanently fences one exact method, endpoint, signing key, revision, or Location geography version. Issued quotes are revoked immediately. Current selections are released the next time they are read. Stable method and callback-endpoint targets require expected_version so a concurrent publication cannot broaden the revocation.
8853
8853
  * POST /v1/delivery-revocations
8854
- * @example client.api.revokeDeliveryDependency({"body":{"reason":"unsafe_configuration","target":{"target_type":"location_geography","location_id":"example","location_geography_revision":"100"}}})
8854
+ * @example client.api.revokeDeliveryDependency({body: {reason: "unsafe_configuration", target: {target_type: "location_geography", location_id: "example", location_geography_revision: "100"}}})
8855
8855
  */
8856
8856
  revokeDeliveryDependency(input: ApiRevokeDeliveryDependencyInput, options?: RequestOptions): Promise<Result<ApiRevokeDeliveryDependencyResponse>>;
8857
8857
  /**
8858
8858
  * Revokes a partner app install and all of its environment grants.
8859
8859
  * POST /v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}/revoke
8860
- * @example client.api.revokeDeveloperPartnerAppInstall({"partner_app_id":"example","partner_app_install_id":"example"})
8860
+ * @example client.api.revokeDeveloperPartnerAppInstall({partner_app_id: "example", partner_app_install_id: "example"})
8861
8861
  */
8862
8862
  revokeDeveloperPartnerAppInstall(input: ApiRevokeDeveloperPartnerAppInstallInput, options?: RequestOptions): Promise<Result<ApiRevokeDeveloperPartnerAppInstallResponse>>;
8863
8863
  /**
8864
8864
  * Revokes a single test or live environment grant for a partner app install.
8865
8865
  * POST /v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}/environment-grants/{environment_grant_id}/revoke
8866
- * @example client.api.revokeDeveloperPartnerEnvironmentGrant({"partner_app_id":"example","partner_app_install_id":"example","environment_grant_id":"example"})
8866
+ * @example client.api.revokeDeveloperPartnerEnvironmentGrant({partner_app_id: "example", partner_app_install_id: "example", environment_grant_id: "example"})
8867
8867
  */
8868
8868
  revokeDeveloperPartnerEnvironmentGrant(input: ApiRevokeDeveloperPartnerEnvironmentGrantInput, options?: RequestOptions): Promise<Result<ApiRevokeDeveloperPartnerEnvironmentGrantResponse>>;
8869
8869
  /**
8870
8870
  * Revokes a direct organization membership for a user.
8871
8871
  * DELETE /v1/organizations/{organization_id}/memberships/{user_id}
8872
- * @example client.api.revokeOrganizationMembership({"organization_id":"example","user_id":"example"})
8872
+ * @example client.api.revokeOrganizationMembership({organization_id: "example", user_id: "example"})
8873
8873
  */
8874
8874
  revokeOrganizationMembership(input: ApiRevokeOrganizationMembershipInput, options?: RequestOptions): Promise<Result<ApiRevokeOrganizationMembershipResponse>>;
8875
8875
  /**
8876
8876
  * Rotates the endpoint signing secret, accepts both keys for one hour, and returns the new secret once.
8877
8877
  * POST /v1/delivery-rate-callbacks/{delivery_rate_callback_id}/rotate-secret
8878
- * @example client.api.rotateDeliveryRateCallbackSigningKey({"delivery_rate_callback_id":"example"})
8878
+ * @example client.api.rotateDeliveryRateCallbackSigningKey({delivery_rate_callback_id: "example"})
8879
8879
  */
8880
8880
  rotateDeliveryRateCallbackSigningKey(input: ApiRotateDeliveryRateCallbackSigningKeyInput, options?: RequestOptions): Promise<Result<ApiRotateDeliveryRateCallbackSigningKeyResponse>>;
8881
8881
  /**
8882
8882
  * Rotates the client secret for a partner app owned by the authenticated merchant. The new client_secret is only returned once.
8883
8883
  * POST /v1/developer/partner/apps/{partner_app_id}/rotate-secret
8884
- * @example client.api.rotateDeveloperPartnerAppSecret({"partner_app_id":"example"})
8884
+ * @example client.api.rotateDeveloperPartnerAppSecret({partner_app_id: "example"})
8885
8885
  */
8886
8886
  rotateDeveloperPartnerAppSecret(input: ApiRotateDeveloperPartnerAppSecretInput, options?: RequestOptions): Promise<Result<ApiRotateDeveloperPartnerAppSecretResponse>>;
8887
8887
  /**
8888
8888
  * Rotates the signing secret for a webhook endpoint and returns the new secret once.
8889
8889
  * POST /v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret
8890
- * @example client.api.rotateWebhookSecret({"webhook_endpoint_id":"example"})
8890
+ * @example client.api.rotateWebhookSecret({webhook_endpoint_id: "example"})
8891
8891
  */
8892
8892
  rotateWebhookSecret(input: ApiRotateWebhookSecretInput, options?: RequestOptions): Promise<Result<ApiRotateWebhookSecretResponse>>;
8893
8893
  /**
8894
8894
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Initiates saving a payment method and returns the client setup payload needed to complete setup on the frontend.
8895
8895
  * POST /v1/me/payment-methods
8896
- * @example client.api.saveMePaymentMethod({"body":{}})
8896
+ * @example client.api.saveMePaymentMethod({body: {}})
8897
8897
  */
8898
8898
  saveMePaymentMethod(input: ApiSaveMePaymentMethodInput, options?: RequestOptions): Promise<Result<ApiSaveMePaymentMethodResponse>>;
8899
8899
  /**
8900
8900
  * Initiates saving a payment method and returns the client setup payload needed to complete setup on the frontend.
8901
8901
  * POST /v1/payment-methods
8902
- * @example client.api.savePaymentMethod({"body":{"customer_id":"example"}})
8902
+ * @example client.api.savePaymentMethod({body: {customer_id: "example"}})
8903
8903
  */
8904
8904
  savePaymentMethod(input: ApiSavePaymentMethodInput, options?: RequestOptions): Promise<Result<ApiSavePaymentMethodResponse>>;
8905
8905
  /**
8906
8906
  * Attempts a reminder email for an already issued collectible invoice. Safe to retry with the same Idempotency-Key.
8907
8907
  * POST /v1/invoices/{invoice_id}/send-reminder
8908
- * @example client.api.sendInvoiceReminder({"invoice_id":"example"})
8908
+ * @example client.api.sendInvoiceReminder({invoice_id: "example"})
8909
8909
  */
8910
8910
  sendInvoiceReminder(input: ApiSendInvoiceReminderInput, options?: RequestOptions): Promise<Result<ApiSendInvoiceReminderResponse>>;
8911
8911
  /**
8912
8912
  * Sets the address as the billing default, shipping default, or both and makes it the customer's effective address for each selected role.
8913
8913
  * POST /v1/customers/{customer_id}/addresses/{customer_address_id}/set-default
8914
- * @example client.api.setDefaultCustomerAddress({"customer_id":"example","customer_address_id":"example","body":{"default_for":"billing"}})
8914
+ * @example client.api.setDefaultCustomerAddress({customer_id: "example", customer_address_id: "example", body: {default_for: "billing"}})
8915
8915
  */
8916
8916
  setDefaultCustomerAddress(input: ApiSetDefaultCustomerAddressInput, options?: RequestOptions): Promise<Result<ApiSetDefaultCustomerAddressResponse>>;
8917
8917
  /**
8918
8918
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Sets the address as the billing default, shipping default, or both and makes it the customer's effective address for each selected role.
8919
8919
  * POST /v1/me/addresses/{customer_address_id}/set-default
8920
- * @example client.api.setDefaultMeAddress({"customer_address_id":"example","body":{"default_for":"billing"}})
8920
+ * @example client.api.setDefaultMeAddress({customer_address_id: "example", body: {default_for: "billing"}})
8921
8921
  */
8922
8922
  setDefaultMeAddress(input: ApiSetDefaultMeAddressInput, options?: RequestOptions): Promise<Result<ApiSetDefaultMeAddressResponse>>;
8923
8923
  /**
8924
8924
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Sets the default payment method for the payment method's owning customer.
8925
8925
  * POST /v1/me/payment-methods/{payment_method_id}/set-default
8926
- * @example client.api.setDefaultMePaymentMethod({"payment_method_id":"example"})
8926
+ * @example client.api.setDefaultMePaymentMethod({payment_method_id: "example"})
8927
8927
  */
8928
8928
  setDefaultMePaymentMethod(input: ApiSetDefaultMePaymentMethodInput, options?: RequestOptions): Promise<Result<ApiSetDefaultMePaymentMethodResponse>>;
8929
8929
  /**
8930
8930
  * Sets the default payment method for the payment method's owning customer.
8931
8931
  * POST /v1/payment-methods/{payment_method_id}/set-default
8932
- * @example client.api.setDefaultPaymentMethod({"payment_method_id":"example"})
8932
+ * @example client.api.setDefaultPaymentMethod({payment_method_id: "example"})
8933
8933
  */
8934
8934
  setDefaultPaymentMethod(input: ApiSetDefaultPaymentMethodInput, options?: RequestOptions): Promise<Result<ApiSetDefaultPaymentMethodResponse>>;
8935
8935
  /**
8936
8936
  * Moves the next billing date forward by one plan interval without charging the current cycle.
8937
8937
  * POST /v1/subscriptions/{subscription_id}/skip-cycle
8938
- * @example client.api.skipSubscriptionCycle({"subscription_id":"example","body":{}})
8938
+ * @example client.api.skipSubscriptionCycle({subscription_id: "example", body: {}})
8939
8939
  */
8940
8940
  skipSubscriptionCycle(input: ApiSkipSubscriptionCycleInput, options?: RequestOptions): Promise<Result<ApiSkipSubscriptionCycleResponse>>;
8941
8941
  /**
8942
8942
  * Starts the consolidated onboarding flow by emailing a short-lived verification code and returning a temporary verification token.
8943
8943
  * POST /v1/onboarding/start
8944
- * @example client.api.startOnboarding({"body":{"email":"example","first_name":"example","last_name":"example"}})
8944
+ * @example client.api.startOnboarding({body: {email: "example", first_name: "example", last_name: "example"}})
8945
8945
  */
8946
8946
  startOnboarding(input: ApiStartOnboardingInput, options?: RequestOptions): Promise<Result<ApiStartOnboardingResponse>>;
8947
8947
  /**
@@ -8953,415 +8953,415 @@ export declare class Client {
8953
8953
  /**
8954
8954
  * Transfers the organization owner role to another user.
8955
8955
  * POST /v1/organizations/{organization_id}/transfer-ownership
8956
- * @example client.api.transferOrganizationOwnership({"organization_id":"example","body":{"new_owner_user_id":"example"}})
8956
+ * @example client.api.transferOrganizationOwnership({organization_id: "example", body: {new_owner_user_id: "example"}})
8957
8957
  */
8958
8958
  transferOrganizationOwnership(input: ApiTransferOrganizationOwnershipInput, options?: RequestOptions): Promise<Result<ApiTransferOrganizationOwnershipResponse>>;
8959
8959
  /**
8960
8960
  * Performs one action from the fulfillment's supported_actions. Each action accepts only its action-specific fields. expected_version is optional and rejects a stale resource version when supplied.
8961
8961
  * POST /v1/fulfillments/{fulfillment_id}/transitions
8962
- * @example client.api.transitionFulfillment({"fulfillment_id":"example","body":{"action":"complete"}})
8962
+ * @example client.api.transitionFulfillment({fulfillment_id: "example", body: {action: "complete"}})
8963
8963
  */
8964
8964
  transitionFulfillment(input: ApiTransitionFulfillmentInput, options?: RequestOptions): Promise<Result<ApiTransitionFulfillmentResponse>>;
8965
8965
  /**
8966
8966
  * Run one action from supported_actions using cumulative line targets. Send expected_version to reject the request if the transfer changed after you read it. The response includes the updated transfer and its inventory effects.
8967
8967
  * POST /v1/inventory-transfers/{inventory_transfer_id}/transitions
8968
- * @example client.api.transitionInventoryTransfer({"Idempotency-Key":"example","inventory_transfer_id":"example","body":{"action":"depart","provenance":{},"lines":[{"inventory_transfer_line_id":"example","target_departed_quantity":"0"}]}})
8968
+ * @example client.api.transitionInventoryTransfer({"Idempotency-Key": "example", inventory_transfer_id: "example", body: {action: "depart", provenance: {}, lines: [{inventory_transfer_line_id: "example", target_departed_quantity: "0"}]}})
8969
8969
  */
8970
8970
  transitionInventoryTransfer(input: ApiTransitionInventoryTransferInput, options?: RequestOptions): Promise<Result<ApiTransitionInventoryTransferResponse>>;
8971
8971
  /**
8972
8972
  * Performs one action from the package's supported_actions. expected_version is optional and rejects a stale resource version when supplied.
8973
8973
  * POST /v1/packages/{package_id}/transitions
8974
- * @example client.api.transitionPackage({"package_id":"example","body":{"action":"mark_delivered"}})
8974
+ * @example client.api.transitionPackage({package_id: "example", body: {action: "mark_delivered"}})
8975
8975
  */
8976
8976
  transitionPackage(input: ApiTransitionPackageInput, options?: RequestOptions): Promise<Result<ApiTransitionPackageResponse>>;
8977
8977
  /**
8978
8978
  * Updates an active external API key's name or complete scope list. API-key-authenticated callers may delegate only scopes already granted to the calling key.
8979
8979
  * PATCH /v1/api-keys/{api_key_id}
8980
- * @example client.api.updateAPIKey({"api_key_id":"example","body":{}})
8980
+ * @example client.api.updateAPIKey({api_key_id: "example", body: {}})
8981
8981
  */
8982
8982
  updateAPIKey(input: ApiUpdateAPIKeyInput, options?: RequestOptions): Promise<Result<ApiUpdateAPIKeyResponse>>;
8983
8983
  /**
8984
8984
  * Update bundle.
8985
8985
  * PATCH /v1/bundles/{bundle_id}
8986
- * @example client.api.updateBundle({"bundle_id":"example","body":{}})
8986
+ * @example client.api.updateBundle({bundle_id: "example", body: {}})
8987
8987
  */
8988
8988
  updateBundle(input: ApiUpdateBundleInput, options?: RequestOptions): Promise<Result<ApiUpdateBundleResponse>>;
8989
8989
  /**
8990
8990
  * Update category.
8991
8991
  * PATCH /v1/categories/{category_id}
8992
- * @example client.api.updateCategory({"category_id":"example","body":{}})
8992
+ * @example client.api.updateCategory({category_id: "example", body: {}})
8993
8993
  */
8994
8994
  updateCategory(input: ApiUpdateCategoryInput, options?: RequestOptions): Promise<Result<ApiUpdateCategoryResponse>>;
8995
8995
  /**
8996
8996
  * Updates mutable checkout session fields. Currently only metadata is mutable.
8997
8997
  * PATCH /v1/checkout-sessions/{checkout_session_id}
8998
- * @example client.api.updateCheckoutSession({"checkout_session_id":"example","body":{}})
8998
+ * @example client.api.updateCheckoutSession({checkout_session_id: "example", body: {}})
8999
8999
  */
9000
9000
  updateCheckoutSession(input: ApiUpdateCheckoutSessionInput, options?: RequestOptions): Promise<Result<ApiUpdateCheckoutSessionResponse>>;
9001
9001
  /**
9002
9002
  * Updates draft credit note fields and corrections atomically. Omitted fields are unchanged, a null memo clears it, and credit_note_lines requires expected_version. Issued and void credit notes are frozen.
9003
9003
  * PATCH /v1/credit-notes/{credit_note_id}
9004
- * @example client.api.updateCreditNote({"credit_note_id":"example","body":{}})
9004
+ * @example client.api.updateCreditNote({credit_note_id: "example", body: {}})
9005
9005
  */
9006
9006
  updateCreditNote(input: ApiUpdateCreditNoteInput, options?: RequestOptions): Promise<Result<ApiUpdateCreditNoteResponse>>;
9007
9007
  /**
9008
9008
  * Applies a sparse update to a customer. Writing billing_address or shipping_address clears the corresponding saved-address default, so that field remains effective until another saved default is selected.
9009
9009
  * PATCH /v1/customers/{customer_id}
9010
- * @example client.api.updateCustomer({"customer_id":"example","body":{}})
9010
+ * @example client.api.updateCustomer({customer_id: "example", body: {}})
9011
9011
  */
9012
9012
  updateCustomer(input: ApiUpdateCustomerInput, options?: RequestOptions): Promise<Result<ApiUpdateCustomerResponse>>;
9013
9013
  /**
9014
9014
  * Applies a sparse update to a saved address. Updating a default address also updates the customer's effective address for that role.
9015
9015
  * PATCH /v1/customers/{customer_id}/addresses/{customer_address_id}
9016
- * @example client.api.updateCustomerAddress({"customer_id":"example","customer_address_id":"example","body":{}})
9016
+ * @example client.api.updateCustomerAddress({customer_id: "example", customer_address_id: "example", body: {}})
9017
9017
  */
9018
9018
  updateCustomerAddress(input: ApiUpdateCustomerAddressInput, options?: RequestOptions): Promise<Result<ApiUpdateCustomerAddressResponse>>;
9019
9019
  /**
9020
9020
  * Sparsely updates mutable fields. A change to pinned configuration publishes a new immutable revision and requires expected_version.
9021
9021
  * PATCH /v1/delivery-location-sets/{delivery_location_set_id}
9022
- * @example client.api.updateDeliveryLocationSet({"delivery_location_set_id":"example","body":{"name":"example"}})
9022
+ * @example client.api.updateDeliveryLocationSet({delivery_location_set_id: "example", body: {name: "example"}})
9023
9023
  */
9024
9024
  updateDeliveryLocationSet(input: ApiUpdateDeliveryLocationSetInput, options?: RequestOptions): Promise<Result<ApiUpdateDeliveryLocationSetResponse>>;
9025
9025
  /**
9026
9026
  * Sparsely updates mutable fields. A change to pinned configuration publishes a new immutable revision and requires expected_version.
9027
9027
  * PATCH /v1/delivery-methods/{delivery_method_id}
9028
- * @example client.api.updateDeliveryMethod({"body":{"status":"active"},"delivery_method_id":"example"})
9028
+ * @example client.api.updateDeliveryMethod({body: {status: "active"}, delivery_method_id: "example"})
9029
9029
  */
9030
9030
  updateDeliveryMethod(input: ApiUpdateDeliveryMethodInput, options?: RequestOptions): Promise<Result<ApiUpdateDeliveryMethodResponse>>;
9031
9031
  /**
9032
9032
  * Sparsely updates mutable fields. A change to pinned configuration publishes a new immutable revision and requires expected_version.
9033
9033
  * PATCH /v1/delivery-profiles/{delivery_profile_id}
9034
- * @example client.api.updateDeliveryProfile({"delivery_profile_id":"example","body":{"name":"example"}})
9034
+ * @example client.api.updateDeliveryProfile({delivery_profile_id: "example", body: {name: "example"}})
9035
9035
  */
9036
9036
  updateDeliveryProfile(input: ApiUpdateDeliveryProfileInput, options?: RequestOptions): Promise<Result<ApiUpdateDeliveryProfileResponse>>;
9037
9037
  /**
9038
9038
  * Sparsely updates mutable fields. A change to pinned configuration publishes a new immutable revision and requires expected_version.
9039
9039
  * PATCH /v1/delivery-rate-callbacks/{delivery_rate_callback_id}
9040
- * @example client.api.updateDeliveryRateCallback({"delivery_rate_callback_id":"example","body":{"name":"example"}})
9040
+ * @example client.api.updateDeliveryRateCallback({delivery_rate_callback_id: "example", body: {name: "example"}})
9041
9041
  */
9042
9042
  updateDeliveryRateCallback(input: ApiUpdateDeliveryRateCallbackInput, options?: RequestOptions): Promise<Result<ApiUpdateDeliveryRateCallbackResponse>>;
9043
9043
  /**
9044
9044
  * Sparsely updates mutable fields. A change to pinned configuration publishes a new immutable revision and requires expected_version.
9045
9045
  * PATCH /v1/delivery-zones/{delivery_zone_id}
9046
- * @example client.api.updateDeliveryZone({"delivery_zone_id":"example","body":{"name":"example"}})
9046
+ * @example client.api.updateDeliveryZone({delivery_zone_id: "example", body: {name: "example"}})
9047
9047
  */
9048
9048
  updateDeliveryZone(input: ApiUpdateDeliveryZoneInput, options?: RequestOptions): Promise<Result<ApiUpdateDeliveryZoneResponse>>;
9049
9049
  /**
9050
9050
  * Updates the API version for a partner app owned by the authenticated merchant. Any supported version can be selected.
9051
9051
  * PATCH /v1/developer/partner/apps/{partner_app_id}
9052
- * @example client.api.updateDeveloperPartnerApp({"partner_app_id":"example","body":{}})
9052
+ * @example client.api.updateDeveloperPartnerApp({partner_app_id: "example", body: {}})
9053
9053
  */
9054
9054
  updateDeveloperPartnerApp(input: ApiUpdateDeveloperPartnerAppInput, options?: RequestOptions): Promise<Result<ApiUpdateDeveloperPartnerAppResponse>>;
9055
9055
  /**
9056
9056
  * Applies a sparse update to a device. Send location_id=null to unassign a location.
9057
9057
  * PATCH /v1/devices/{device_id}
9058
- * @example client.api.updateDevice({"device_id":"example","body":{}})
9058
+ * @example client.api.updateDevice({device_id: "example", body: {}})
9059
9059
  */
9060
9060
  updateDevice(input: ApiUpdateDeviceInput, options?: RequestOptions): Promise<Result<ApiUpdateDeviceResponse>>;
9061
9061
  /**
9062
9062
  * Updates mutable fulfillment fields and fulfillment-specific details. Fulfillment line item allocation is set when the fulfillment is created. expected_version is optional and rejects a stale resource version when supplied.
9063
9063
  * PATCH /v1/fulfillments/{fulfillment_id}
9064
- * @example client.api.updateFulfillment({"fulfillment_id":"example","body":{}})
9064
+ * @example client.api.updateFulfillment({fulfillment_id: "example", body: {}})
9065
9065
  */
9066
9066
  updateFulfillment(input: ApiUpdateFulfillmentInput, options?: RequestOptions): Promise<Result<ApiUpdateFulfillmentResponse>>;
9067
9067
  /**
9068
9068
  * Update policy fields, availability, or atomically replace its routing configuration. Send expected_version to reject concurrent changes.
9069
9069
  * PATCH /v1/inventory-allocation-policies/{inventory_allocation_policy_id}
9070
- * @example client.api.updateInventoryAllocationPolicy({"inventory_allocation_policy_id":"example","body":{}})
9070
+ * @example client.api.updateInventoryAllocationPolicy({inventory_allocation_policy_id: "example", body: {}})
9071
9071
  */
9072
9072
  updateInventoryAllocationPolicy(input: ApiUpdateInventoryAllocationPolicyInput, options?: RequestOptions): Promise<Result<ApiUpdateInventoryAllocationPolicyResponse>>;
9073
9073
  /**
9074
9074
  * Replace a count's observations atomically. Send expected_version to reject concurrent changes.
9075
9075
  * PATCH /v1/inventory-counts/{inventory_count_id}
9076
- * @example client.api.updateInventoryCount({"body":{"expected_version":"2","observations":[{"counted_damaged_quantity":"0","counted_on_hand_quantity":"12","counted_quality_control_quantity":"0","counted_quarantined_quantity":"0","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM"}],"source_system":{"type":"manual"}},"Idempotency-Key":"example","inventory_count_id":"example"})
9076
+ * @example client.api.updateInventoryCount({body: {expected_version: "2", observations: [{counted_damaged_quantity: "0", counted_on_hand_quantity: "12", counted_quality_control_quantity: "0", counted_quarantined_quantity: "0", inventory_item_id: "invi_01K0P7W6A4N9F3J2T8Q5R1C6XM"}], source_system: {type: "manual"}}, "Idempotency-Key": "example", inventory_count_id: "example"})
9077
9077
  */
9078
9078
  updateInventoryCount(input: ApiUpdateInventoryCountInput, options?: RequestOptions): Promise<Result<ApiUpdateInventoryCountResponse>>;
9079
9079
  /**
9080
9080
  * Update an inventory item. accepts status active or inactive. Send sku or barcode as null to clear.
9081
9081
  * PATCH /v1/inventory-items/{inventory_item_id}
9082
- * @example client.api.updateInventoryItem({"inventory_item_id":"example","body":{}})
9082
+ * @example client.api.updateInventoryItem({inventory_item_id: "example", body: {}})
9083
9083
  */
9084
9084
  updateInventoryItem(input: ApiUpdateInventoryItemInput, options?: RequestOptions): Promise<Result<ApiUpdateInventoryItemResponse>>;
9085
9085
  /**
9086
9086
  * Set one inventory level's safety_stock_quantity. returns the updated level with durable command evidence.
9087
9087
  * PATCH /v1/inventory-levels/{inventory_level_id}
9088
- * @example client.api.updateInventoryLevel({"Idempotency-Key":"example","inventory_level_id":"example","body":{"safety_stock_quantity":"0"}})
9088
+ * @example client.api.updateInventoryLevel({"Idempotency-Key": "example", inventory_level_id: "example", body: {safety_stock_quantity: "0"}})
9089
9089
  */
9090
9090
  updateInventoryLevel(input: ApiUpdateInventoryLevelInput, options?: RequestOptions): Promise<Result<ApiUpdateInventoryLevelResponse>>;
9091
9091
  /**
9092
9092
  * Update an open transfer's planning details.
9093
9093
  * PATCH /v1/inventory-transfers/{inventory_transfer_id}
9094
- * @example client.api.updateInventoryTransfer({"inventory_transfer_id":"example","body":{}})
9094
+ * @example client.api.updateInventoryTransfer({inventory_transfer_id: "example", body: {}})
9095
9095
  */
9096
9096
  updateInventoryTransfer(input: ApiUpdateInventoryTransferInput, options?: RequestOptions): Promise<Result<ApiUpdateInventoryTransferResponse>>;
9097
9097
  /**
9098
9098
  * Updates mutable fields on a draft invoice. Sent invoices are immutable except for delivery-related actions.
9099
9099
  * PATCH /v1/invoices/{invoice_id}
9100
- * @example client.api.updateInvoice({"invoice_id":"example","body":{}})
9100
+ * @example client.api.updateInvoice({invoice_id: "example", body: {}})
9101
9101
  */
9102
9102
  updateInvoice(input: ApiUpdateInvoiceInput, options?: RequestOptions): Promise<Result<ApiUpdateInvoiceResponse>>;
9103
9103
  /**
9104
9104
  * Update invoice payment term for the authenticated merchant.
9105
9105
  * PATCH /v1/invoice-payment-terms/{invoice_payment_term_id}
9106
- * @example client.api.updateInvoicePaymentTerm({"invoice_payment_term_id":"example","body":{"calculation":{"type":"on_receipt"}}})
9106
+ * @example client.api.updateInvoicePaymentTerm({invoice_payment_term_id: "example", body: {calculation: {type: "on_receipt"}}})
9107
9107
  */
9108
9108
  updateInvoicePaymentTerm(input: ApiUpdateInvoicePaymentTermInput, options?: RequestOptions): Promise<Result<ApiUpdateInvoicePaymentTermResponse>>;
9109
9109
  /**
9110
9110
  * Update a Location's profile or availability. Accepts status active or inactive.
9111
9111
  * PATCH /v1/locations/{location_id}
9112
- * @example client.api.updateLocation({"location_id":"example","body":{}})
9112
+ * @example client.api.updateLocation({location_id: "example", body: {}})
9113
9113
  */
9114
9114
  updateLocation(input: ApiUpdateLocationInput, options?: RequestOptions): Promise<Result<ApiUpdateLocationResponse>>;
9115
9115
  /**
9116
9116
  * Enable or disable inventory allocation at a Location. Omit expected_inventory_revision when enabling inventory for the first time; otherwise send the current inventory_revision.
9117
9117
  * PATCH /v1/locations/{location_id}/inventory
9118
- * @example client.api.updateLocationInventory({"location_id":"example","body":{"allocation_status":"active"}})
9118
+ * @example client.api.updateLocationInventory({location_id: "example", body: {allocation_status: "active"}})
9119
9119
  */
9120
9120
  updateLocationInventory(input: ApiUpdateLocationInventoryInput, options?: RequestOptions): Promise<Result<ApiUpdateLocationInventoryResponse>>;
9121
9121
  /**
9122
9122
  * Uses the customer identity fixed by the customer session. Updates the current buyer's name or phone. Manage billing and shipping addresses through /v1/me/addresses.
9123
9123
  * PATCH /v1/me
9124
- * @example client.api.updateMe({"body":{}})
9124
+ * @example client.api.updateMe({body: {}})
9125
9125
  */
9126
9126
  updateMe(input: ApiUpdateMeInput, options?: RequestOptions): Promise<Result<ApiUpdateMeResponse>>;
9127
9127
  /**
9128
9128
  * Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Applies a sparse update to a saved address. Updating a default address also updates the customer's effective address for that role.
9129
9129
  * PATCH /v1/me/addresses/{customer_address_id}
9130
- * @example client.api.updateMeAddress({"customer_address_id":"example","body":{}})
9130
+ * @example client.api.updateMeAddress({customer_address_id: "example", body: {}})
9131
9131
  */
9132
9132
  updateMeAddress(input: ApiUpdateMeAddressInput, options?: RequestOptions): Promise<Result<ApiUpdateMeAddressResponse>>;
9133
9133
  /**
9134
9134
  * Applies a sparse update to the authenticated merchant's public business profile fields.
9135
9135
  * PATCH /v1/merchants/{merchant_id}
9136
- * @example client.api.updateMerchant({"merchant_id":"example","body":{}})
9136
+ * @example client.api.updateMerchant({merchant_id: "example", body: {}})
9137
9137
  */
9138
9138
  updateMerchant(input: ApiUpdateMerchantInput, options?: RequestOptions): Promise<Result<ApiUpdateMerchantResponse>>;
9139
9139
  /**
9140
9140
  * Update modifier group.
9141
9141
  * PATCH /v1/modifier-groups/{modifier_group_id}
9142
- * @example client.api.updateModifierGroup({"modifier_group_id":"example","body":{}})
9142
+ * @example client.api.updateModifierGroup({modifier_group_id: "example", body: {}})
9143
9143
  */
9144
9144
  updateModifierGroup(input: ApiUpdateModifierGroupInput, options?: RequestOptions): Promise<Result<ApiUpdateModifierGroupResponse>>;
9145
9145
  /**
9146
9146
  * Update modifier set.
9147
9147
  * PATCH /v1/modifier-sets/{modifier_set_id}
9148
- * @example client.api.updateModifierSet({"modifier_set_id":"example","body":{}})
9148
+ * @example client.api.updateModifierSet({modifier_set_id: "example", body: {}})
9149
9149
  */
9150
9150
  updateModifierSet(input: ApiUpdateModifierSetInput, options?: RequestOptions): Promise<Result<ApiUpdateModifierSetResponse>>;
9151
9151
  /**
9152
9152
  * Applies a sparse update to mutable order fields such as customer_id, notes, metadata, tax, the delivery destination, and the requested tip. Send requested_tip: null to clear the current requested tip.
9153
9153
  * PATCH /v1/orders/{order_id}
9154
- * @example client.api.updateOrder({"order_id":"example","body":{"buyer_note":"example"}})
9154
+ * @example client.api.updateOrder({order_id: "example", body: {buyer_note: "example"}})
9155
9155
  */
9156
9156
  updateOrder(input: ApiUpdateOrderInput, options?: RequestOptions): Promise<Result<ApiUpdateOrderResponse>>;
9157
9157
  /**
9158
9158
  * Updates a single service charge, fee, or surcharge on an order.
9159
9159
  * PATCH /v1/orders/{order_id}/charges/{order_charge_id}
9160
- * @example client.api.updateOrderCharge({"order_id":"example","order_charge_id":"example","body":{}})
9160
+ * @example client.api.updateOrderCharge({order_id: "example", order_charge_id: "example", body: {}})
9161
9161
  */
9162
9162
  updateOrderCharge(input: ApiUpdateOrderChargeInput, options?: RequestOptions): Promise<Result<ApiUpdateOrderChargeResponse>>;
9163
9163
  /**
9164
9164
  * Updates a single line item on an order.
9165
9165
  * PATCH /v1/orders/{order_id}/line-items/{order_line_item_id}
9166
- * @example client.api.updateOrderLineItem({"order_id":"example","order_line_item_id":"example","body":{}})
9166
+ * @example client.api.updateOrderLineItem({order_id: "example", order_line_item_id: "example", body: {}})
9167
9167
  */
9168
9168
  updateOrderLineItem(input: ApiUpdateOrderLineItemInput, options?: RequestOptions): Promise<Result<ApiUpdateOrderLineItemResponse>>;
9169
9169
  /**
9170
9170
  * Applies a sparse update to an accessible organization.
9171
9171
  * PATCH /v1/organizations/{organization_id}
9172
- * @example client.api.updateOrganization({"organization_id":"example","body":{}})
9172
+ * @example client.api.updateOrganization({organization_id: "example", body: {}})
9173
9173
  */
9174
9174
  updateOrganization(input: ApiUpdateOrganizationInput, options?: RequestOptions): Promise<Result<ApiUpdateOrganizationResponse>>;
9175
9175
  /**
9176
9176
  * Updates non-lifecycle package fields such as carrier, tracking, label access, measurements, metadata, and caller-owned external references. Package status cannot be patched directly. expected_version is optional and rejects a stale resource version when supplied.
9177
9177
  * PATCH /v1/packages/{package_id}
9178
- * @example client.api.updatePackage({"package_id":"example","body":{}})
9178
+ * @example client.api.updatePackage({package_id: "example", body: {}})
9179
9179
  */
9180
9180
  updatePackage(input: ApiUpdatePackageInput, options?: RequestOptions): Promise<Result<ApiUpdatePackageResponse>>;
9181
9181
  /**
9182
9182
  * Updates a package item quantity or metadata while the package is still mutable.
9183
9183
  * PATCH /v1/packages/{package_id}/items/{package_item_id}
9184
- * @example client.api.updatePackageItem({"package_id":"example","package_item_id":"example","body":{}})
9184
+ * @example client.api.updatePackageItem({package_id: "example", package_item_id: "example", body: {}})
9185
9185
  */
9186
9186
  updatePackageItem(input: ApiUpdatePackageItemInput, options?: RequestOptions): Promise<Result<ApiUpdatePackageItemResponse>>;
9187
9187
  /**
9188
9188
  * Applies a sparse update to a payment intent before it reaches a terminal state.
9189
9189
  * PATCH /v1/payment-intents/{payment_intent_id}
9190
- * @example client.api.updatePaymentIntent({"payment_intent_id":"example","body":{}})
9190
+ * @example client.api.updatePaymentIntent({payment_intent_id: "example", body: {}})
9191
9191
  */
9192
9192
  updatePaymentIntent(input: ApiUpdatePaymentIntentInput, options?: RequestOptions): Promise<Result<ApiUpdatePaymentIntentResponse>>;
9193
9193
  /**
9194
9194
  * Updates a payment link. To replace line items, custom fields, or delivery methods, send the complete array with `expected_version`.
9195
9195
  * PATCH /v1/payment-links/{payment_link_id}
9196
- * @example client.api.updatePaymentLink({"payment_link_id":"example","body":{}})
9196
+ * @example client.api.updatePaymentLink({payment_link_id: "example", body: {}})
9197
9197
  */
9198
9198
  updatePaymentLink(input: ApiUpdatePaymentLinkInput, options?: RequestOptions): Promise<Result<ApiUpdatePaymentLinkResponse>>;
9199
9199
  /**
9200
9200
  * Sets the domain registration status. Activating the domain also validates Apple Pay and Google Pay readiness.
9201
9201
  * PATCH /v1/payment-method-domains/{payment_method_domain_id}
9202
- * @example client.api.updatePaymentMethodDomain({"payment_method_domain_id":"example","body":{"status":"active"}})
9202
+ * @example client.api.updatePaymentMethodDomain({payment_method_domain_id: "example", body: {status: "active"}})
9203
9203
  */
9204
9204
  updatePaymentMethodDomain(input: ApiUpdatePaymentMethodDomainInput, options?: RequestOptions): Promise<Result<ApiUpdatePaymentMethodDomainResponse>>;
9205
9205
  /**
9206
9206
  * Updates mutable metadata and settings for a payout destination. Safe to retry with the same Idempotency-Key.
9207
9207
  * PATCH /v1/payout-settings/destinations/{payout_destination_id}
9208
- * @example client.api.updatePayoutDestination({"payout_destination_id":"example","body":{}})
9208
+ * @example client.api.updatePayoutDestination({payout_destination_id: "example", body: {}})
9209
9209
  */
9210
9210
  updatePayoutDestination(input: ApiUpdatePayoutDestinationInput, options?: RequestOptions): Promise<Result<ApiUpdatePayoutDestinationResponse>>;
9211
9211
  /**
9212
9212
  * Updates mutable payout settings for the authenticated merchant. Safe to retry with the same Idempotency-Key.
9213
9213
  * PATCH /v1/payout-settings
9214
- * @example client.api.updatePayoutSettings({"body":{}})
9214
+ * @example client.api.updatePayoutSettings({body: {}})
9215
9215
  */
9216
9216
  updatePayoutSettings(input: ApiUpdatePayoutSettingsInput, options?: RequestOptions): Promise<Result<ApiUpdatePayoutSettingsResponse>>;
9217
9217
  /**
9218
9218
  * Applies a sparse update to product-parent fields. When categories is present, it replaces the full category list; send an empty array to clear categories. Sellable price, SKU, and inventory live on variants.
9219
9219
  * PATCH /v1/products/{product_id}
9220
- * @example client.api.updateProduct({"product_id":"example","body":{}})
9220
+ * @example client.api.updateProduct({product_id: "example", body: {}})
9221
9221
  */
9222
9222
  updateProduct(input: ApiUpdateProductInput, options?: RequestOptions): Promise<Result<ApiUpdateProductResponse>>;
9223
9223
  /**
9224
9224
  * Update product variant.
9225
9225
  * PATCH /v1/products/{product_id}/variants/{variant_id}
9226
- * @example client.api.updateProductVariant({"product_id":"example","variant_id":"example","body":{}})
9226
+ * @example client.api.updateProductVariant({product_id: "example", variant_id: "example", body: {}})
9227
9227
  */
9228
9228
  updateProductVariant(input: ApiUpdateProductVariantInput, options?: RequestOptions): Promise<Result<ApiUpdateProductVariantResponse>>;
9229
9229
  /**
9230
9230
  * Applies a sparse update to promotion fields.
9231
9231
  * PATCH /v1/promotions/{promotion_id}
9232
- * @example client.api.updatePromotion({"promotion_id":"example","body":{}})
9232
+ * @example client.api.updatePromotion({promotion_id: "example", body: {}})
9233
9233
  */
9234
9234
  updatePromotion(input: ApiUpdatePromotionInput, options?: RequestOptions): Promise<Result<ApiUpdatePromotionResponse>>;
9235
9235
  /**
9236
9236
  * Applies a sparse update to a promotion code.
9237
9237
  * PATCH /v1/promotions/{promotion_id}/codes/{promotion_code_id}
9238
- * @example client.api.updatePromotionCode({"promotion_id":"example","promotion_code_id":"example","body":{}})
9238
+ * @example client.api.updatePromotionCode({promotion_id: "example", promotion_code_id: "example", body: {}})
9239
9239
  */
9240
9240
  updatePromotionCode(input: ApiUpdatePromotionCodeInput, options?: RequestOptions): Promise<Result<ApiUpdatePromotionCodeResponse>>;
9241
9241
  /**
9242
9242
  * Updates refund metadata.
9243
9243
  * PATCH /v1/refunds/{refund_id}
9244
- * @example client.api.updateRefund({"refund_id":"example","body":{}})
9244
+ * @example client.api.updateRefund({refund_id: "example", body: {}})
9245
9245
  */
9246
9246
  updateRefund(input: ApiUpdateRefundInput, options?: RequestOptions): Promise<Result<ApiUpdateRefundResponse>>;
9247
9247
  /**
9248
9248
  * Update caller-owned fields on a Return. Only external_reference_id and metadata are writable; every other change goes through a decision, operation, or resolution command.
9249
9249
  * PATCH /v1/returns/{return_id}
9250
- * @example client.api.updateReturn({"return_id":"example","body":{}})
9250
+ * @example client.api.updateReturn({return_id: "example", body: {}})
9251
9251
  */
9252
9252
  updateReturn(input: ApiUpdateReturnInput, options?: RequestOptions): Promise<Result<ApiUpdateReturnResponse>>;
9253
9253
  /**
9254
9254
  * Update a requested Return line item. Send null to clear buyer_note or requested_resolution_type. The response is the updated Return.
9255
9255
  * PATCH /v1/returns/{return_id}/line-items/{return_line_item_id}
9256
- * @example client.api.updateReturnLineItem({"return_id":"example","return_line_item_id":"example","body":{}})
9256
+ * @example client.api.updateReturnLineItem({return_id: "example", return_line_item_id: "example", body: {}})
9257
9257
  */
9258
9258
  updateReturnLineItem(input: ApiUpdateReturnLineItemInput, options?: RequestOptions): Promise<Result<ApiUpdateReturnLineItemResponse>>;
9259
9259
  /**
9260
9260
  * Update policy identity fields or set status to active or inactive. Rules live on revisions, so changing a window, fee, or scope means publishing a new revision.
9261
9261
  * PATCH /v1/return-policies/{return_policy_id}
9262
- * @example client.api.updateReturnPolicy({"return_policy_id":"example","body":{}})
9262
+ * @example client.api.updateReturnPolicy({return_policy_id: "example", body: {}})
9263
9263
  */
9264
9264
  updateReturnPolicy(input: ApiUpdateReturnPolicyInput, options?: RequestOptions): Promise<Result<ApiUpdateReturnPolicyResponse>>;
9265
9265
  /**
9266
9266
  * Update a Return reason. Send null to clear description. A present category_handles array replaces the existing set.
9267
9267
  * PATCH /v1/return-reasons/{return_reason_id}
9268
- * @example client.api.updateReturnReason({"return_reason_id":"example","body":{}})
9268
+ * @example client.api.updateReturnReason({return_reason_id: "example", body: {}})
9269
9269
  */
9270
9270
  updateReturnReason(input: ApiUpdateReturnReasonInput, options?: RequestOptions): Promise<Result<ApiUpdateReturnReasonResponse>>;
9271
9271
  /**
9272
9272
  * Update a proposed resolution before confirmation. A present line_items or replacement_line_items array replaces that collection and requires expected_version.
9273
9273
  * PATCH /v1/return-resolutions/{return_resolution_id}
9274
- * @example client.api.updateReturnResolution({"return_resolution_id":"example","body":{}})
9274
+ * @example client.api.updateReturnResolution({return_resolution_id: "example", body: {}})
9275
9275
  */
9276
9276
  updateReturnResolution(input: ApiUpdateReturnResolutionInput, options?: RequestOptions): Promise<Result<ApiUpdateReturnResolutionResponse>>;
9277
9277
  /**
9278
9278
  * Update a risk list for the authenticated merchant environment.
9279
9279
  * PATCH /v1/risk-lists/{risk_list_id}
9280
- * @example client.api.updateRiskList({"risk_list_id":"example","body":{"name":"example"}})
9280
+ * @example client.api.updateRiskList({risk_list_id: "example", body: {name: "example"}})
9281
9281
  */
9282
9282
  updateRiskList(input: ApiUpdateRiskListInput, options?: RequestOptions): Promise<Result<ApiUpdateRiskListResponse>>;
9283
9283
  /**
9284
9284
  * Update a risk rule for the authenticated merchant environment.
9285
9285
  * PATCH /v1/risk-rules/{risk_rule_id}
9286
- * @example client.api.updateRiskRule({"risk_rule_id":"example","body":{"action":"allow"}})
9286
+ * @example client.api.updateRiskRule({risk_rule_id: "example", body: {action: "allow"}})
9287
9287
  */
9288
9288
  updateRiskRule(input: ApiUpdateRiskRuleInput, options?: RequestOptions): Promise<Result<ApiUpdateRiskRuleResponse>>;
9289
9289
  /**
9290
9290
  * Applies a sparse patch to merchant-scoped settings. Send catalog by itself because it has its own version fence. Fee and payment limit controls remain internal-only.
9291
9291
  * PATCH /v1/settings
9292
- * @example client.api.updateSettings({"body":{}})
9292
+ * @example client.api.updateSettings({body: {}})
9293
9293
  */
9294
9294
  updateSettings(input: ApiUpdateSettingsInput, options?: RequestOptions): Promise<Result<ApiUpdateSettingsResponse>>;
9295
9295
  /**
9296
9296
  * Updates shipment metadata and caller-owned external references. Shipment status is derived from package statuses and cannot be patched directly. expected_version is optional and rejects a stale resource version when supplied.
9297
9297
  * PATCH /v1/shipments/{shipment_id}
9298
- * @example client.api.updateShipment({"shipment_id":"example","body":{}})
9298
+ * @example client.api.updateShipment({shipment_id: "example", body: {}})
9299
9299
  */
9300
9300
  updateShipment(input: ApiUpdateShipmentInput, options?: RequestOptions): Promise<Result<ApiUpdateShipmentResponse>>;
9301
9301
  /**
9302
9302
  * Updates mutable subscription fields such as payment_method_id and metadata.
9303
9303
  * PATCH /v1/subscriptions/{subscription_id}
9304
- * @example client.api.updateSubscription({"subscription_id":"example","body":{}})
9304
+ * @example client.api.updateSubscription({subscription_id: "example", body: {}})
9305
9305
  */
9306
9306
  updateSubscription(input: ApiUpdateSubscriptionInput, options?: RequestOptions): Promise<Result<ApiUpdateSubscriptionResponse>>;
9307
9307
  /**
9308
9308
  * Sets the next billing date, clears an external schedule while it awaits a date, or transfers schedule ownership. The response carries the updated subscription.
9309
9309
  * PATCH /v1/subscriptions/{subscription_id}/billing-schedule
9310
- * @example client.api.updateSubscriptionBillingSchedule({"subscription_id":"example","body":{"owner":"flint","initiated_by":"buyer","next_billing_at":"2026-01-01T00:00:00Z"}})
9310
+ * @example client.api.updateSubscriptionBillingSchedule({subscription_id: "example", body: {owner: "flint", initiated_by: "buyer", next_billing_at: "2026-01-01T00:00:00Z"}})
9311
9311
  */
9312
9312
  updateSubscriptionBillingSchedule(input: ApiUpdateSubscriptionBillingScheduleInput, options?: RequestOptions): Promise<Result<ApiUpdateSubscriptionBillingScheduleResponse>>;
9313
9313
  /**
9314
9314
  * Applies a sparse update to mutable subscription plan fields. Line items are mutated through the subscription plan line-item endpoints.
9315
9315
  * PATCH /v1/subscription-plans/{plan_id}
9316
- * @example client.api.updateSubscriptionPlan({"plan_id":"example","body":{}})
9316
+ * @example client.api.updateSubscriptionPlan({plan_id: "example", body: {}})
9317
9317
  */
9318
9318
  updateSubscriptionPlan(input: ApiUpdateSubscriptionPlanInput, options?: RequestOptions): Promise<Result<ApiUpdateSubscriptionPlanResponse>>;
9319
9319
  /**
9320
9320
  * Updates the mutable fields on a webhook endpoint.
9321
9321
  * PATCH /v1/webhook-endpoints/{webhook_endpoint_id}
9322
- * @example client.api.updateWebhookEndpoint({"webhook_endpoint_id":"example","body":{}})
9322
+ * @example client.api.updateWebhookEndpoint({webhook_endpoint_id: "example", body: {}})
9323
9323
  */
9324
9324
  updateWebhookEndpoint(input: ApiUpdateWebhookEndpointInput, options?: RequestOptions): Promise<Result<ApiUpdateWebhookEndpointResponse>>;
9325
9325
  /**
9326
9326
  * Verifies the emailed code, provisions the Flint user and merchant if needed, and returns a short-lived session token for the rest of onboarding.
9327
9327
  * POST /v1/onboarding/verify-email
9328
- * @example client.api.verifyOnboardingEmail({"body":{"verification_code":"example","verification_token":"example"}})
9328
+ * @example client.api.verifyOnboardingEmail({body: {verification_code: "example", verification_token: "example"}})
9329
9329
  */
9330
9330
  verifyOnboardingEmail(input: ApiVerifyOnboardingEmailInput, options?: RequestOptions): Promise<Result<ApiVerifyOnboardingEmailResponse>>;
9331
9331
  /**
9332
9332
  * Establish the Return line identity for receipt quantity that arrived without one. Unverified quantity counts toward no line and releases no refund timing gate until it is verified.
9333
9333
  * POST /v1/return-receipts/{return_receipt_id}/line-items/{return_receipt_line_item_id}/verify
9334
- * @example client.api.verifyReturnReceiptLineItem({"return_receipt_id":"example","return_receipt_line_item_id":"example","body":{"return_line_item_id":"example","verification_reason":"order_match_confirmed"}})
9334
+ * @example client.api.verifyReturnReceiptLineItem({return_receipt_id: "example", return_receipt_line_item_id: "example", body: {return_line_item_id: "example", verification_reason: "order_match_confirmed"}})
9335
9335
  */
9336
9336
  verifyReturnReceiptLineItem(input: ApiVerifyReturnReceiptLineItemInput, options?: RequestOptions): Promise<Result<ApiVerifyReturnReceiptLineItemResponse>>;
9337
9337
  /**
9338
9338
  * Voids an issued credit note. Every allocation has to be reversed first. Void is terminal, and an invoice cannot be voided while an issued credit note stands against it.
9339
9339
  * POST /v1/credit-notes/{credit_note_id}/void
9340
- * @example client.api.voidCreditNote({"credit_note_id":"example"})
9340
+ * @example client.api.voidCreditNote({credit_note_id: "example"})
9341
9341
  */
9342
9342
  voidCreditNote(input: ApiVoidCreditNoteInput, options?: RequestOptions): Promise<Result<ApiVoidCreditNoteResponse>>;
9343
9343
  /**
9344
9344
  * Voids an unpaid invoice so the associated order can be edited or collected again. An invoice with an issued credit note against it cannot be voided until that credit note is voided.
9345
9345
  * POST /v1/invoices/{invoice_id}/void
9346
- * @example client.api.voidInvoice({"invoice_id":"example"})
9346
+ * @example client.api.voidInvoice({invoice_id: "example"})
9347
9347
  */
9348
9348
  voidInvoice(input: ApiVoidInvoiceInput, options?: RequestOptions): Promise<Result<ApiVoidInvoiceResponse>>;
9349
9349
  /**
9350
9350
  * Voids a package before carrier handoff and appends a package timeline event. Voided package items no longer count against fulfillment package allocation capacity. expected_version is optional and rejects a stale resource version when supplied.
9351
9351
  * POST /v1/packages/{package_id}/void
9352
- * @example client.api.voidPackage({"package_id":"example"})
9352
+ * @example client.api.voidPackage({package_id: "example"})
9353
9353
  */
9354
9354
  voidPackage(input: ApiVoidPackageInput, options?: RequestOptions): Promise<Result<ApiVoidPackageResponse>>;
9355
9355
  /**
9356
9356
  * Voids a shipment before carrier handoff and voids all child packages that have not shipped. The action appends timeline events for the shipment and affected packages. expected_version is optional and rejects a stale resource version when supplied.
9357
9357
  * POST /v1/shipments/{shipment_id}/void
9358
- * @example client.api.voidShipment({"shipment_id":"example"})
9358
+ * @example client.api.voidShipment({shipment_id: "example"})
9359
9359
  */
9360
9360
  voidShipment(input: ApiVoidShipmentInput, options?: RequestOptions): Promise<Result<ApiVoidShipmentResponse>>;
9361
9361
  /**
9362
9362
  * Waive the inspection requirement on a Return line item so received quantity can be dispositioned and resolved without an inspection observation.
9363
9363
  * POST /v1/returns/{return_id}/line-items/{return_line_item_id}/waive-inspection
9364
- * @example client.api.waiveReturnLineInspection({"return_id":"example","return_line_item_id":"example","body":{"reason":"policy_override"}})
9364
+ * @example client.api.waiveReturnLineInspection({return_id: "example", return_line_item_id: "example", body: {reason: "policy_override"}})
9365
9365
  */
9366
9366
  waiveReturnLineInspection(input: ApiWaiveReturnLineInspectionInput, options?: RequestOptions): Promise<Result<ApiWaiveReturnLineInspectionResponse>>;
9367
9367
  };