@usethrottle/api-client 5.7.0 → 5.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/services/DefaultService.d.ts +122 -2
- package/dist/generated/services/DefaultService.d.ts.map +1 -1
- package/dist/generated/services/DefaultService.js +3 -0
- package/dist/generated/services/DefaultService.js.map +1 -1
- package/dist/generated/services/OrdersService.d.ts +479 -3
- package/dist/generated/services/OrdersService.d.ts.map +1 -1
- package/dist/generated/services/OrdersService.js +2 -2
- package/dist/generated/services/OrdersService.js.map +1 -1
- package/dist/generated/services/PaymentsService.d.ts +2 -2
- package/dist/generated/services/PaymentsService.d.ts.map +1 -1
- package/dist/generated/services/PaymentsService.js +6 -2
- package/dist/generated/services/PaymentsService.js.map +1 -1
- package/package.json +1 -1
|
@@ -43,7 +43,7 @@ export class PaymentsService {
|
|
|
43
43
|
});
|
|
44
44
|
}
|
|
45
45
|
/**
|
|
46
|
-
* Record money that arrived outside Throttle — cash, a bank transfer to the merchant's own account, a cheque. The payment is created already captured, so the order advances exactly as a processor capture would. Excluded from billable GMV.
|
|
46
|
+
* Record money that arrived outside Throttle — cash, a bank transfer to the merchant's own account, a cheque. The payment is created already captured, so the order advances exactly as a processor capture would. Excluded from billable GMV. When the order's balance is on an unpaid Net-N invoice (`method: net30`, status `authorized` or `pending`), the payment goes to that invoice: an amount equal to the invoice settles it — the invoice payment itself is captured, as marking it paid does (`payment.captured`), the recorded method/reference/note are kept in its `metadata.recordedPayment`, and that payment is returned; a smaller amount is recorded as its own payment and the invoice then bills what is left; a larger amount is refused with 422 `amount_exceeds_invoice`, a payment in another currency than the invoice with 422 `currency_mismatch`. If the invoice changes while the payment is being recorded (a concurrent payment, edit or cancellation, or the same full payment submitted twice), the call answers 409 `invoice_changed` and records nothing; send an `Idempotency-Key` to make retries safe.
|
|
47
47
|
* @param id
|
|
48
48
|
* @param requestBody
|
|
49
49
|
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
@@ -62,6 +62,10 @@ export class PaymentsService {
|
|
|
62
62
|
},
|
|
63
63
|
body: requestBody,
|
|
64
64
|
mediaType: 'application/json',
|
|
65
|
+
errors: {
|
|
66
|
+
409: `\`invoice_changed\`: the unpaid Net-N invoice changed while the payment was being recorded (a concurrent payment, edit or cancellation, or a double submit). Nothing was recorded; reload and retry.`,
|
|
67
|
+
422: `\`invalid_order_state\` (the order is cancelled or closed), \`amount_exceeds_invoice\` (more than the unpaid Net-N invoice the balance is on; record the invoice amount, then any excess) or \`currency_mismatch\` (not the invoice currency).`,
|
|
68
|
+
},
|
|
65
69
|
});
|
|
66
70
|
}
|
|
67
71
|
/**
|
|
@@ -212,7 +216,7 @@ export class PaymentsService {
|
|
|
212
216
|
});
|
|
213
217
|
}
|
|
214
218
|
/**
|
|
215
|
-
* Void an authorized payment
|
|
219
|
+
* Void an authorized payment, or cancel an unpaid Net-N invoice (`method: net30`, status `authorized` or `pending`). A pending card payment is still in flight at the processor and cannot be voided; captured money must be refunded.
|
|
216
220
|
* @param id
|
|
217
221
|
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
218
222
|
* @returns any Default Response
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PaymentsService.js","sourceRoot":"","sources":["../../../src/generated/services/PaymentsService.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1D,MAAM,OAAO,eAAe;IACxB;;;;;;;OAOG;IACI,MAAM,CAAC,uBAAuB,CACjC,EAAU,EACV,WAYC,EACD,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,8BAA8B;YACnC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,sBAAsB,CAChC,EAAU,EACV,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,8BAA8B;YACnC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,6BAA6B,CACvC,EAAU,EACV,WAUC,EACD,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,qCAAqC;YAC1C,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;
|
|
1
|
+
{"version":3,"file":"PaymentsService.js","sourceRoot":"","sources":["../../../src/generated/services/PaymentsService.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1D,MAAM,OAAO,eAAe;IACxB;;;;;;;OAOG;IACI,MAAM,CAAC,uBAAuB,CACjC,EAAU,EACV,WAYC,EACD,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,8BAA8B;YACnC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,sBAAsB,CAChC,EAAU,EACV,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,8BAA8B;YACnC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,6BAA6B,CACvC,EAAU,EACV,WAUC,EACD,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,qCAAqC;YAC1C,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACJ,GAAG,EAAE,sMAAsM;gBAC3M,GAAG,EAAE,gPAAgP;aACxP;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,uBAAuB,CACjC,EAAU,EACV,SAAiB,EACjB,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,0CAA0C;YAC/C,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;gBACR,WAAW,EAAE,SAAS;aACzB;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,MAAM,EAAE;gBACJ,GAAG,EAAE,oFAAoF;aAC5F;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,4BAA4B,CACtC,EAAU,EACV,sBAA+B;QA2B/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,oCAAoC;YACzC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,gBAAgB,CAC1B,sBAA+B,EAC/B,MAAe,EACf,MAAiC,EACjC,KAAc,EACd,MAAe,EACf,KAA8C,EAC9C,OAAgB,EAChB,OAAgB,EAChB,KAAc,EACd,SAAkB,EAClB,SAAkB;QAElB,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,kBAAkB;YACvB,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,KAAK,EAAE;gBACH,QAAQ,EAAE,MAAM;gBAChB,QAAQ,EAAE,MAAM;gBAChB,OAAO,EAAE,KAAK;gBACd,QAAQ,EAAE,MAAM;gBAChB,OAAO,EAAE,KAAK;gBACd,UAAU,EAAE,OAAO;gBACnB,UAAU,EAAE,OAAO;gBACnB,QAAQ,EAAE,KAAK;gBACf,YAAY,EAAE,SAAS;gBACvB,YAAY,EAAE,SAAS;aAC1B;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,iBAAiB,CAC3B,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,uBAAuB;YAC5B,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,0BAA0B,CACpC,EAAU,EACV,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,iCAAiC;YACtC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,MAAM,EAAE;gBACJ,GAAG,EAAE,sFAAsF;aAC9F;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,wBAAwB,CAClC,EAAU,EACV,WAKC,EACD,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,+BAA+B;YACpC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACJ,GAAG,EAAE,sFAAsF;gBAC3F,GAAG,EAAE,gFAAgF;aACxF;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,qBAAqB,CAC/B,EAAU,EACV,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,4BAA4B;YACjC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,MAAM,EAAE;gBACJ,GAAG,EAAE,sFAAsF;aAC9F;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,2BAA2B,CACrC,EAAU,EACV,WAKC,EACD,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,mCAAmC;YACxC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACJ,GAAG,EAAE,+DAA+D;aACvE;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,uBAAuB,CACjC,EAAU,EACV,WAMC,EACD,sBAA+B;QAiD/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,8BAA8B;YACnC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,8BAA8B,CACxC,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,sCAAsC;YAC3C,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,0BAA0B,CACpC,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,mCAAmC;YACxC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,mCAAmC,CAC7C,WA6BC,EACD,sBAA+B;QAe/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,uCAAuC;YAC5C,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,kCAAkC,CAC5C,EAAU,EACV,sBAA+B;QAc/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,4CAA4C;YACjD,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,uBAAuB,CACjC,EAAU,EACV,WAEC,EACD,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,OAAO;YACf,GAAG,EAAE,6BAA6B;YAClC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,wBAAwB,CAClC,EAAU,EACV,WAEC,EACD,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,+BAA+B;YACpC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,6BAA6B,CACvC,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,qCAAqC;YAC1C,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,gCAAgC,CAC1C,EAAU,EACV,WAEC,EACD,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,yCAAyC;YAC9C,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,qBAAqB,CAC/B,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,wBAAwB;YAC7B,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;CACJ"}
|