@polar-sh/sdk 0.40.3 → 0.41.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/README.md +1 -1
- package/dist/commonjs/funcs/eventsList.js +1 -0
- package/dist/commonjs/funcs/eventsList.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/models/components/benefitcycledevent.d.ts +5 -0
- package/dist/commonjs/models/components/benefitcycledevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/benefitcycledevent.js +4 -0
- package/dist/commonjs/models/components/benefitcycledevent.js.map +1 -1
- package/dist/commonjs/models/components/benefitgrantedevent.d.ts +5 -0
- package/dist/commonjs/models/components/benefitgrantedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/benefitgrantedevent.js +4 -0
- package/dist/commonjs/models/components/benefitgrantedevent.js.map +1 -1
- package/dist/commonjs/models/components/benefitrevokedevent.d.ts +5 -0
- package/dist/commonjs/models/components/benefitrevokedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/benefitrevokedevent.js +4 -0
- package/dist/commonjs/models/components/benefitrevokedevent.js.map +1 -1
- package/dist/commonjs/models/components/benefitupdatedevent.d.ts +5 -0
- package/dist/commonjs/models/components/benefitupdatedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/benefitupdatedevent.js +4 -0
- package/dist/commonjs/models/components/benefitupdatedevent.js.map +1 -1
- package/dist/commonjs/models/components/customercreate.d.ts +0 -3
- package/dist/commonjs/models/components/customercreate.d.ts.map +1 -1
- package/dist/commonjs/models/components/customercreate.js.map +1 -1
- package/dist/commonjs/models/components/customercreatedevent.d.ts +5 -0
- package/dist/commonjs/models/components/customercreatedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/customercreatedevent.js +4 -0
- package/dist/commonjs/models/components/customercreatedevent.js.map +1 -1
- package/dist/commonjs/models/components/customerdeletedevent.d.ts +5 -0
- package/dist/commonjs/models/components/customerdeletedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/customerdeletedevent.js +4 -0
- package/dist/commonjs/models/components/customerdeletedevent.js.map +1 -1
- package/dist/commonjs/models/components/customerupdate.d.ts +0 -3
- package/dist/commonjs/models/components/customerupdate.d.ts.map +1 -1
- package/dist/commonjs/models/components/customerupdate.js.map +1 -1
- package/dist/commonjs/models/components/customerupdatedevent.d.ts +5 -0
- package/dist/commonjs/models/components/customerupdatedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/customerupdatedevent.js +4 -0
- package/dist/commonjs/models/components/customerupdatedevent.js.map +1 -1
- package/dist/commonjs/models/components/customerupdateexternalid.d.ts +0 -3
- package/dist/commonjs/models/components/customerupdateexternalid.d.ts.map +1 -1
- package/dist/commonjs/models/components/customerupdateexternalid.js.map +1 -1
- package/dist/commonjs/models/components/eventcreatecustomer.d.ts +10 -0
- package/dist/commonjs/models/components/eventcreatecustomer.d.ts.map +1 -1
- package/dist/commonjs/models/components/eventcreatecustomer.js +8 -0
- package/dist/commonjs/models/components/eventcreatecustomer.js.map +1 -1
- package/dist/commonjs/models/components/eventcreateexternalcustomer.d.ts +10 -0
- package/dist/commonjs/models/components/eventcreateexternalcustomer.d.ts.map +1 -1
- package/dist/commonjs/models/components/eventcreateexternalcustomer.js +8 -0
- package/dist/commonjs/models/components/eventcreateexternalcustomer.js.map +1 -1
- package/dist/commonjs/models/components/eventsingestresponse.d.ts +5 -0
- package/dist/commonjs/models/components/eventsingestresponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/eventsingestresponse.js +2 -0
- package/dist/commonjs/models/components/eventsingestresponse.js.map +1 -1
- package/dist/commonjs/models/components/metercreditevent.d.ts +5 -0
- package/dist/commonjs/models/components/metercreditevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/metercreditevent.js +4 -0
- package/dist/commonjs/models/components/metercreditevent.js.map +1 -1
- package/dist/commonjs/models/components/meterresetevent.d.ts +5 -0
- package/dist/commonjs/models/components/meterresetevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/meterresetevent.js +4 -0
- package/dist/commonjs/models/components/meterresetevent.js.map +1 -1
- package/dist/commonjs/models/components/orderpaidevent.d.ts +5 -0
- package/dist/commonjs/models/components/orderpaidevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/orderpaidevent.js +4 -0
- package/dist/commonjs/models/components/orderpaidevent.js.map +1 -1
- package/dist/commonjs/models/components/orderrefundedevent.d.ts +5 -0
- package/dist/commonjs/models/components/orderrefundedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/orderrefundedevent.js +4 -0
- package/dist/commonjs/models/components/orderrefundedevent.js.map +1 -1
- package/dist/commonjs/models/components/subscriptioncycledevent.d.ts +5 -0
- package/dist/commonjs/models/components/subscriptioncycledevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/subscriptioncycledevent.js +4 -0
- package/dist/commonjs/models/components/subscriptioncycledevent.js.map +1 -1
- package/dist/commonjs/models/components/subscriptionproductupdatedevent.d.ts +5 -0
- package/dist/commonjs/models/components/subscriptionproductupdatedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/subscriptionproductupdatedevent.js +4 -0
- package/dist/commonjs/models/components/subscriptionproductupdatedevent.js.map +1 -1
- package/dist/commonjs/models/components/subscriptionrevokedevent.d.ts +5 -0
- package/dist/commonjs/models/components/subscriptionrevokedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/subscriptionrevokedevent.js +4 -0
- package/dist/commonjs/models/components/subscriptionrevokedevent.js.map +1 -1
- package/dist/commonjs/models/components/userevent.d.ts +5 -0
- package/dist/commonjs/models/components/userevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/userevent.js +4 -0
- package/dist/commonjs/models/components/userevent.js.map +1 -1
- package/dist/commonjs/models/operations/eventslist.d.ts +5 -0
- package/dist/commonjs/models/operations/eventslist.d.ts.map +1 -1
- package/dist/commonjs/models/operations/eventslist.js +4 -0
- package/dist/commonjs/models/operations/eventslist.js.map +1 -1
- package/dist/esm/funcs/eventsList.js +1 -0
- package/dist/esm/funcs/eventsList.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/models/components/benefitcycledevent.d.ts +5 -0
- package/dist/esm/models/components/benefitcycledevent.d.ts.map +1 -1
- package/dist/esm/models/components/benefitcycledevent.js +4 -0
- package/dist/esm/models/components/benefitcycledevent.js.map +1 -1
- package/dist/esm/models/components/benefitgrantedevent.d.ts +5 -0
- package/dist/esm/models/components/benefitgrantedevent.d.ts.map +1 -1
- package/dist/esm/models/components/benefitgrantedevent.js +4 -0
- package/dist/esm/models/components/benefitgrantedevent.js.map +1 -1
- package/dist/esm/models/components/benefitrevokedevent.d.ts +5 -0
- package/dist/esm/models/components/benefitrevokedevent.d.ts.map +1 -1
- package/dist/esm/models/components/benefitrevokedevent.js +4 -0
- package/dist/esm/models/components/benefitrevokedevent.js.map +1 -1
- package/dist/esm/models/components/benefitupdatedevent.d.ts +5 -0
- package/dist/esm/models/components/benefitupdatedevent.d.ts.map +1 -1
- package/dist/esm/models/components/benefitupdatedevent.js +4 -0
- package/dist/esm/models/components/benefitupdatedevent.js.map +1 -1
- package/dist/esm/models/components/customercreate.d.ts +0 -3
- package/dist/esm/models/components/customercreate.d.ts.map +1 -1
- package/dist/esm/models/components/customercreate.js.map +1 -1
- package/dist/esm/models/components/customercreatedevent.d.ts +5 -0
- package/dist/esm/models/components/customercreatedevent.d.ts.map +1 -1
- package/dist/esm/models/components/customercreatedevent.js +4 -0
- package/dist/esm/models/components/customercreatedevent.js.map +1 -1
- package/dist/esm/models/components/customerdeletedevent.d.ts +5 -0
- package/dist/esm/models/components/customerdeletedevent.d.ts.map +1 -1
- package/dist/esm/models/components/customerdeletedevent.js +4 -0
- package/dist/esm/models/components/customerdeletedevent.js.map +1 -1
- package/dist/esm/models/components/customerupdate.d.ts +0 -3
- package/dist/esm/models/components/customerupdate.d.ts.map +1 -1
- package/dist/esm/models/components/customerupdate.js.map +1 -1
- package/dist/esm/models/components/customerupdatedevent.d.ts +5 -0
- package/dist/esm/models/components/customerupdatedevent.d.ts.map +1 -1
- package/dist/esm/models/components/customerupdatedevent.js +4 -0
- package/dist/esm/models/components/customerupdatedevent.js.map +1 -1
- package/dist/esm/models/components/customerupdateexternalid.d.ts +0 -3
- package/dist/esm/models/components/customerupdateexternalid.d.ts.map +1 -1
- package/dist/esm/models/components/customerupdateexternalid.js.map +1 -1
- package/dist/esm/models/components/eventcreatecustomer.d.ts +10 -0
- package/dist/esm/models/components/eventcreatecustomer.d.ts.map +1 -1
- package/dist/esm/models/components/eventcreatecustomer.js +8 -0
- package/dist/esm/models/components/eventcreatecustomer.js.map +1 -1
- package/dist/esm/models/components/eventcreateexternalcustomer.d.ts +10 -0
- package/dist/esm/models/components/eventcreateexternalcustomer.d.ts.map +1 -1
- package/dist/esm/models/components/eventcreateexternalcustomer.js +8 -0
- package/dist/esm/models/components/eventcreateexternalcustomer.js.map +1 -1
- package/dist/esm/models/components/eventsingestresponse.d.ts +5 -0
- package/dist/esm/models/components/eventsingestresponse.d.ts.map +1 -1
- package/dist/esm/models/components/eventsingestresponse.js +2 -0
- package/dist/esm/models/components/eventsingestresponse.js.map +1 -1
- package/dist/esm/models/components/metercreditevent.d.ts +5 -0
- package/dist/esm/models/components/metercreditevent.d.ts.map +1 -1
- package/dist/esm/models/components/metercreditevent.js +4 -0
- package/dist/esm/models/components/metercreditevent.js.map +1 -1
- package/dist/esm/models/components/meterresetevent.d.ts +5 -0
- package/dist/esm/models/components/meterresetevent.d.ts.map +1 -1
- package/dist/esm/models/components/meterresetevent.js +4 -0
- package/dist/esm/models/components/meterresetevent.js.map +1 -1
- package/dist/esm/models/components/orderpaidevent.d.ts +5 -0
- package/dist/esm/models/components/orderpaidevent.d.ts.map +1 -1
- package/dist/esm/models/components/orderpaidevent.js +4 -0
- package/dist/esm/models/components/orderpaidevent.js.map +1 -1
- package/dist/esm/models/components/orderrefundedevent.d.ts +5 -0
- package/dist/esm/models/components/orderrefundedevent.d.ts.map +1 -1
- package/dist/esm/models/components/orderrefundedevent.js +4 -0
- package/dist/esm/models/components/orderrefundedevent.js.map +1 -1
- package/dist/esm/models/components/subscriptioncycledevent.d.ts +5 -0
- package/dist/esm/models/components/subscriptioncycledevent.d.ts.map +1 -1
- package/dist/esm/models/components/subscriptioncycledevent.js +4 -0
- package/dist/esm/models/components/subscriptioncycledevent.js.map +1 -1
- package/dist/esm/models/components/subscriptionproductupdatedevent.d.ts +5 -0
- package/dist/esm/models/components/subscriptionproductupdatedevent.d.ts.map +1 -1
- package/dist/esm/models/components/subscriptionproductupdatedevent.js +4 -0
- package/dist/esm/models/components/subscriptionproductupdatedevent.js.map +1 -1
- package/dist/esm/models/components/subscriptionrevokedevent.d.ts +5 -0
- package/dist/esm/models/components/subscriptionrevokedevent.d.ts.map +1 -1
- package/dist/esm/models/components/subscriptionrevokedevent.js +4 -0
- package/dist/esm/models/components/subscriptionrevokedevent.js.map +1 -1
- package/dist/esm/models/components/userevent.d.ts +5 -0
- package/dist/esm/models/components/userevent.d.ts.map +1 -1
- package/dist/esm/models/components/userevent.js +4 -0
- package/dist/esm/models/components/userevent.js.map +1 -1
- package/dist/esm/models/operations/eventslist.d.ts +5 -0
- package/dist/esm/models/operations/eventslist.d.ts.map +1 -1
- package/dist/esm/models/operations/eventslist.js +4 -0
- package/dist/esm/models/operations/eventslist.js.map +1 -1
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/eventsList.ts +1 -0
- package/src/lib/config.ts +3 -3
- package/src/models/components/benefitcycledevent.ts +9 -0
- package/src/models/components/benefitgrantedevent.ts +9 -0
- package/src/models/components/benefitrevokedevent.ts +9 -0
- package/src/models/components/benefitupdatedevent.ts +9 -0
- package/src/models/components/customercreate.ts +0 -3
- package/src/models/components/customercreatedevent.ts +9 -0
- package/src/models/components/customerdeletedevent.ts +9 -0
- package/src/models/components/customerupdate.ts +0 -3
- package/src/models/components/customerupdatedevent.ts +9 -0
- package/src/models/components/customerupdateexternalid.ts +0 -3
- package/src/models/components/eventcreatecustomer.ts +18 -0
- package/src/models/components/eventcreateexternalcustomer.ts +18 -0
- package/src/models/components/eventsingestresponse.ts +7 -0
- package/src/models/components/metercreditevent.ts +9 -0
- package/src/models/components/meterresetevent.ts +9 -0
- package/src/models/components/orderpaidevent.ts +9 -0
- package/src/models/components/orderrefundedevent.ts +9 -0
- package/src/models/components/subscriptioncycledevent.ts +9 -0
- package/src/models/components/subscriptionproductupdatedevent.ts +9 -0
- package/src/models/components/subscriptionrevokedevent.ts +9 -0
- package/src/models/components/userevent.ts +9 -0
- package/src/models/operations/eventslist.ts +9 -0
- package/.devcontainer/README.md +0 -35
- package/docs/sdks/benefitgrants/README.md +0 -88
- package/docs/sdks/benefits/README.md +0 -500
- package/docs/sdks/checkoutlinks/README.md +0 -407
- package/docs/sdks/checkouts/README.md +0 -600
- package/docs/sdks/clients/README.md +0 -331
- package/docs/sdks/customermeters/README.md +0 -166
- package/docs/sdks/customers/README.md +0 -1036
- package/docs/sdks/customerseats/README.md +0 -441
- package/docs/sdks/customersession/README.md +0 -79
- package/docs/sdks/customersessions/README.md +0 -84
- package/docs/sdks/customfields/README.md +0 -417
- package/docs/sdks/discounts/README.md +0 -409
- package/docs/sdks/downloadables/README.md +0 -83
- package/docs/sdks/events/README.md +0 -324
- package/docs/sdks/files/README.md +0 -460
- package/docs/sdks/licensekeys/README.md +0 -576
- package/docs/sdks/meters/README.md +0 -437
- package/docs/sdks/metrics/README.md +0 -165
- package/docs/sdks/oauth2/README.md +0 -371
- package/docs/sdks/orders/README.md +0 -489
- package/docs/sdks/organizations/README.md +0 -322
- package/docs/sdks/payments/README.md +0 -166
- package/docs/sdks/polarbenefitgrants/README.md +0 -250
- package/docs/sdks/polarcustomermeters/README.md +0 -164
- package/docs/sdks/polarcustomers/README.md +0 -482
- package/docs/sdks/polarlicensekeys/README.md +0 -406
- package/docs/sdks/polarorders/README.md +0 -574
- package/docs/sdks/polarorganizations/README.md +0 -79
- package/docs/sdks/polarsubscriptions/README.md +0 -326
- package/docs/sdks/polarwallets/README.md +0 -164
- package/docs/sdks/products/README.md +0 -441
- package/docs/sdks/refunds/README.md +0 -171
- package/docs/sdks/seats/README.md +0 -379
- package/docs/sdks/subscriptions/README.md +0 -493
- package/docs/sdks/wallets/README.md +0 -256
- package/docs/sdks/webhooks/README.md +0 -650
- package/examples/README.md +0 -31
|
@@ -1,574 +0,0 @@
|
|
|
1
|
-
# PolarOrders
|
|
2
|
-
(*customerPortal.orders*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [list](#list) - List Orders
|
|
9
|
-
* [get](#get) - Get Order
|
|
10
|
-
* [update](#update) - Update Order
|
|
11
|
-
* [generateInvoice](#generateinvoice) - Generate Order Invoice
|
|
12
|
-
* [invoice](#invoice) - Get Order Invoice
|
|
13
|
-
* [getPaymentStatus](#getpaymentstatus) - Get Order Payment Status
|
|
14
|
-
* [confirmRetryPayment](#confirmretrypayment) - Confirm Retry Payment
|
|
15
|
-
|
|
16
|
-
## list
|
|
17
|
-
|
|
18
|
-
List orders of the authenticated customer.
|
|
19
|
-
|
|
20
|
-
**Scopes**: `customer_portal:read` `customer_portal:write`
|
|
21
|
-
|
|
22
|
-
### Example Usage
|
|
23
|
-
|
|
24
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:orders:list" method="get" path="/v1/customer-portal/orders/" -->
|
|
25
|
-
```typescript
|
|
26
|
-
import { Polar } from "@polar-sh/sdk";
|
|
27
|
-
|
|
28
|
-
const polar = new Polar();
|
|
29
|
-
|
|
30
|
-
async function run() {
|
|
31
|
-
const result = await polar.customerPortal.orders.list({
|
|
32
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
33
|
-
}, {});
|
|
34
|
-
|
|
35
|
-
for await (const page of result) {
|
|
36
|
-
console.log(page);
|
|
37
|
-
}
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
run();
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### Standalone function
|
|
44
|
-
|
|
45
|
-
The standalone function version of this method:
|
|
46
|
-
|
|
47
|
-
```typescript
|
|
48
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
49
|
-
import { customerPortalOrdersList } from "@polar-sh/sdk/funcs/customerPortalOrdersList.js";
|
|
50
|
-
|
|
51
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
52
|
-
// You can create one instance of it to use across an application.
|
|
53
|
-
const polar = new PolarCore();
|
|
54
|
-
|
|
55
|
-
async function run() {
|
|
56
|
-
const res = await customerPortalOrdersList(polar, {
|
|
57
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
58
|
-
}, {});
|
|
59
|
-
if (res.ok) {
|
|
60
|
-
const { value: result } = res;
|
|
61
|
-
for await (const page of result) {
|
|
62
|
-
console.log(page);
|
|
63
|
-
}
|
|
64
|
-
} else {
|
|
65
|
-
console.log("customerPortalOrdersList failed:", res.error);
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
run();
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
### Parameters
|
|
73
|
-
|
|
74
|
-
| Parameter | Type | Required | Description |
|
|
75
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
76
|
-
| `request` | [operations.CustomerPortalOrdersListRequest](../../models/operations/customerportalorderslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
77
|
-
| `security` | [operations.CustomerPortalOrdersListSecurity](../../models/operations/customerportalorderslistsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
78
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
79
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
80
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
81
|
-
|
|
82
|
-
### Response
|
|
83
|
-
|
|
84
|
-
**Promise\<[operations.CustomerPortalOrdersListResponse](../../models/operations/customerportalorderslistresponse.md)\>**
|
|
85
|
-
|
|
86
|
-
### Errors
|
|
87
|
-
|
|
88
|
-
| Error Type | Status Code | Content Type |
|
|
89
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
90
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
91
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
92
|
-
|
|
93
|
-
## get
|
|
94
|
-
|
|
95
|
-
Get an order by ID for the authenticated customer.
|
|
96
|
-
|
|
97
|
-
**Scopes**: `customer_portal:read` `customer_portal:write`
|
|
98
|
-
|
|
99
|
-
### Example Usage
|
|
100
|
-
|
|
101
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:orders:get" method="get" path="/v1/customer-portal/orders/{id}" -->
|
|
102
|
-
```typescript
|
|
103
|
-
import { Polar } from "@polar-sh/sdk";
|
|
104
|
-
|
|
105
|
-
const polar = new Polar();
|
|
106
|
-
|
|
107
|
-
async function run() {
|
|
108
|
-
const result = await polar.customerPortal.orders.get({
|
|
109
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
110
|
-
}, {
|
|
111
|
-
id: "<value>",
|
|
112
|
-
});
|
|
113
|
-
|
|
114
|
-
console.log(result);
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
run();
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
### Standalone function
|
|
121
|
-
|
|
122
|
-
The standalone function version of this method:
|
|
123
|
-
|
|
124
|
-
```typescript
|
|
125
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
126
|
-
import { customerPortalOrdersGet } from "@polar-sh/sdk/funcs/customerPortalOrdersGet.js";
|
|
127
|
-
|
|
128
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
129
|
-
// You can create one instance of it to use across an application.
|
|
130
|
-
const polar = new PolarCore();
|
|
131
|
-
|
|
132
|
-
async function run() {
|
|
133
|
-
const res = await customerPortalOrdersGet(polar, {
|
|
134
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
135
|
-
}, {
|
|
136
|
-
id: "<value>",
|
|
137
|
-
});
|
|
138
|
-
if (res.ok) {
|
|
139
|
-
const { value: result } = res;
|
|
140
|
-
console.log(result);
|
|
141
|
-
} else {
|
|
142
|
-
console.log("customerPortalOrdersGet failed:", res.error);
|
|
143
|
-
}
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
run();
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
### Parameters
|
|
150
|
-
|
|
151
|
-
| Parameter | Type | Required | Description |
|
|
152
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
153
|
-
| `request` | [operations.CustomerPortalOrdersGetRequest](../../models/operations/customerportalordersgetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
154
|
-
| `security` | [operations.CustomerPortalOrdersGetSecurity](../../models/operations/customerportalordersgetsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
155
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
156
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
157
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
158
|
-
|
|
159
|
-
### Response
|
|
160
|
-
|
|
161
|
-
**Promise\<[components.CustomerOrder](../../models/components/customerorder.md)\>**
|
|
162
|
-
|
|
163
|
-
### Errors
|
|
164
|
-
|
|
165
|
-
| Error Type | Status Code | Content Type |
|
|
166
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
167
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
168
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
169
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
170
|
-
|
|
171
|
-
## update
|
|
172
|
-
|
|
173
|
-
Update an order for the authenticated customer.
|
|
174
|
-
|
|
175
|
-
**Scopes**: `customer_portal:write`
|
|
176
|
-
|
|
177
|
-
### Example Usage
|
|
178
|
-
|
|
179
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:orders:update" method="patch" path="/v1/customer-portal/orders/{id}" -->
|
|
180
|
-
```typescript
|
|
181
|
-
import { Polar } from "@polar-sh/sdk";
|
|
182
|
-
|
|
183
|
-
const polar = new Polar();
|
|
184
|
-
|
|
185
|
-
async function run() {
|
|
186
|
-
const result = await polar.customerPortal.orders.update({
|
|
187
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
188
|
-
}, {
|
|
189
|
-
id: "<value>",
|
|
190
|
-
customerOrderUpdate: {
|
|
191
|
-
billingName: "<value>",
|
|
192
|
-
billingAddress: {
|
|
193
|
-
country: "US",
|
|
194
|
-
},
|
|
195
|
-
},
|
|
196
|
-
});
|
|
197
|
-
|
|
198
|
-
console.log(result);
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
run();
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
### Standalone function
|
|
205
|
-
|
|
206
|
-
The standalone function version of this method:
|
|
207
|
-
|
|
208
|
-
```typescript
|
|
209
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
210
|
-
import { customerPortalOrdersUpdate } from "@polar-sh/sdk/funcs/customerPortalOrdersUpdate.js";
|
|
211
|
-
|
|
212
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
213
|
-
// You can create one instance of it to use across an application.
|
|
214
|
-
const polar = new PolarCore();
|
|
215
|
-
|
|
216
|
-
async function run() {
|
|
217
|
-
const res = await customerPortalOrdersUpdate(polar, {
|
|
218
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
219
|
-
}, {
|
|
220
|
-
id: "<value>",
|
|
221
|
-
customerOrderUpdate: {
|
|
222
|
-
billingName: "<value>",
|
|
223
|
-
billingAddress: {
|
|
224
|
-
country: "US",
|
|
225
|
-
},
|
|
226
|
-
},
|
|
227
|
-
});
|
|
228
|
-
if (res.ok) {
|
|
229
|
-
const { value: result } = res;
|
|
230
|
-
console.log(result);
|
|
231
|
-
} else {
|
|
232
|
-
console.log("customerPortalOrdersUpdate failed:", res.error);
|
|
233
|
-
}
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
run();
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
### Parameters
|
|
240
|
-
|
|
241
|
-
| Parameter | Type | Required | Description |
|
|
242
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
243
|
-
| `request` | [operations.CustomerPortalOrdersUpdateRequest](../../models/operations/customerportalordersupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
244
|
-
| `security` | [operations.CustomerPortalOrdersUpdateSecurity](../../models/operations/customerportalordersupdatesecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
245
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
246
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
247
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
248
|
-
|
|
249
|
-
### Response
|
|
250
|
-
|
|
251
|
-
**Promise\<[components.CustomerOrder](../../models/components/customerorder.md)\>**
|
|
252
|
-
|
|
253
|
-
### Errors
|
|
254
|
-
|
|
255
|
-
| Error Type | Status Code | Content Type |
|
|
256
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
257
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
258
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
259
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
260
|
-
|
|
261
|
-
## generateInvoice
|
|
262
|
-
|
|
263
|
-
Trigger generation of an order's invoice.
|
|
264
|
-
|
|
265
|
-
**Scopes**: `customer_portal:read` `customer_portal:write`
|
|
266
|
-
|
|
267
|
-
### Example Usage
|
|
268
|
-
|
|
269
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:orders:generate_invoice" method="post" path="/v1/customer-portal/orders/{id}/invoice" -->
|
|
270
|
-
```typescript
|
|
271
|
-
import { Polar } from "@polar-sh/sdk";
|
|
272
|
-
|
|
273
|
-
const polar = new Polar();
|
|
274
|
-
|
|
275
|
-
async function run() {
|
|
276
|
-
const result = await polar.customerPortal.orders.generateInvoice({
|
|
277
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
278
|
-
}, {
|
|
279
|
-
id: "<value>",
|
|
280
|
-
});
|
|
281
|
-
|
|
282
|
-
console.log(result);
|
|
283
|
-
}
|
|
284
|
-
|
|
285
|
-
run();
|
|
286
|
-
```
|
|
287
|
-
|
|
288
|
-
### Standalone function
|
|
289
|
-
|
|
290
|
-
The standalone function version of this method:
|
|
291
|
-
|
|
292
|
-
```typescript
|
|
293
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
294
|
-
import { customerPortalOrdersGenerateInvoice } from "@polar-sh/sdk/funcs/customerPortalOrdersGenerateInvoice.js";
|
|
295
|
-
|
|
296
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
297
|
-
// You can create one instance of it to use across an application.
|
|
298
|
-
const polar = new PolarCore();
|
|
299
|
-
|
|
300
|
-
async function run() {
|
|
301
|
-
const res = await customerPortalOrdersGenerateInvoice(polar, {
|
|
302
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
303
|
-
}, {
|
|
304
|
-
id: "<value>",
|
|
305
|
-
});
|
|
306
|
-
if (res.ok) {
|
|
307
|
-
const { value: result } = res;
|
|
308
|
-
console.log(result);
|
|
309
|
-
} else {
|
|
310
|
-
console.log("customerPortalOrdersGenerateInvoice failed:", res.error);
|
|
311
|
-
}
|
|
312
|
-
}
|
|
313
|
-
|
|
314
|
-
run();
|
|
315
|
-
```
|
|
316
|
-
|
|
317
|
-
### Parameters
|
|
318
|
-
|
|
319
|
-
| Parameter | Type | Required | Description |
|
|
320
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
321
|
-
| `request` | [operations.CustomerPortalOrdersGenerateInvoiceRequest](../../models/operations/customerportalordersgenerateinvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
322
|
-
| `security` | [operations.CustomerPortalOrdersGenerateInvoiceSecurity](../../models/operations/customerportalordersgenerateinvoicesecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
323
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
324
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
325
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
326
|
-
|
|
327
|
-
### Response
|
|
328
|
-
|
|
329
|
-
**Promise\<[any](../../models/.md)\>**
|
|
330
|
-
|
|
331
|
-
### Errors
|
|
332
|
-
|
|
333
|
-
| Error Type | Status Code | Content Type |
|
|
334
|
-
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
|
335
|
-
| errors.MissingInvoiceBillingDetails | 422 | application/json |
|
|
336
|
-
| errors.NotPaidOrder | 422 | application/json |
|
|
337
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
338
|
-
|
|
339
|
-
## invoice
|
|
340
|
-
|
|
341
|
-
Get an order's invoice data.
|
|
342
|
-
|
|
343
|
-
**Scopes**: `customer_portal:read` `customer_portal:write`
|
|
344
|
-
|
|
345
|
-
### Example Usage
|
|
346
|
-
|
|
347
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:orders:invoice" method="get" path="/v1/customer-portal/orders/{id}/invoice" -->
|
|
348
|
-
```typescript
|
|
349
|
-
import { Polar } from "@polar-sh/sdk";
|
|
350
|
-
|
|
351
|
-
const polar = new Polar();
|
|
352
|
-
|
|
353
|
-
async function run() {
|
|
354
|
-
const result = await polar.customerPortal.orders.invoice({
|
|
355
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
356
|
-
}, {
|
|
357
|
-
id: "<value>",
|
|
358
|
-
});
|
|
359
|
-
|
|
360
|
-
console.log(result);
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
run();
|
|
364
|
-
```
|
|
365
|
-
|
|
366
|
-
### Standalone function
|
|
367
|
-
|
|
368
|
-
The standalone function version of this method:
|
|
369
|
-
|
|
370
|
-
```typescript
|
|
371
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
372
|
-
import { customerPortalOrdersInvoice } from "@polar-sh/sdk/funcs/customerPortalOrdersInvoice.js";
|
|
373
|
-
|
|
374
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
375
|
-
// You can create one instance of it to use across an application.
|
|
376
|
-
const polar = new PolarCore();
|
|
377
|
-
|
|
378
|
-
async function run() {
|
|
379
|
-
const res = await customerPortalOrdersInvoice(polar, {
|
|
380
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
381
|
-
}, {
|
|
382
|
-
id: "<value>",
|
|
383
|
-
});
|
|
384
|
-
if (res.ok) {
|
|
385
|
-
const { value: result } = res;
|
|
386
|
-
console.log(result);
|
|
387
|
-
} else {
|
|
388
|
-
console.log("customerPortalOrdersInvoice failed:", res.error);
|
|
389
|
-
}
|
|
390
|
-
}
|
|
391
|
-
|
|
392
|
-
run();
|
|
393
|
-
```
|
|
394
|
-
|
|
395
|
-
### Parameters
|
|
396
|
-
|
|
397
|
-
| Parameter | Type | Required | Description |
|
|
398
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
399
|
-
| `request` | [operations.CustomerPortalOrdersInvoiceRequest](../../models/operations/customerportalordersinvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
400
|
-
| `security` | [operations.CustomerPortalOrdersInvoiceSecurity](../../models/operations/customerportalordersinvoicesecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
401
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
402
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
403
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
404
|
-
|
|
405
|
-
### Response
|
|
406
|
-
|
|
407
|
-
**Promise\<[components.CustomerOrderInvoice](../../models/components/customerorderinvoice.md)\>**
|
|
408
|
-
|
|
409
|
-
### Errors
|
|
410
|
-
|
|
411
|
-
| Error Type | Status Code | Content Type |
|
|
412
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
413
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
414
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
415
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
416
|
-
|
|
417
|
-
## getPaymentStatus
|
|
418
|
-
|
|
419
|
-
Get the current payment status for an order.
|
|
420
|
-
|
|
421
|
-
**Scopes**: `customer_portal:read` `customer_portal:write`
|
|
422
|
-
|
|
423
|
-
### Example Usage
|
|
424
|
-
|
|
425
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:orders:get_payment_status" method="get" path="/v1/customer-portal/orders/{id}/payment-status" -->
|
|
426
|
-
```typescript
|
|
427
|
-
import { Polar } from "@polar-sh/sdk";
|
|
428
|
-
|
|
429
|
-
const polar = new Polar();
|
|
430
|
-
|
|
431
|
-
async function run() {
|
|
432
|
-
const result = await polar.customerPortal.orders.getPaymentStatus({
|
|
433
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
434
|
-
}, {
|
|
435
|
-
id: "<value>",
|
|
436
|
-
});
|
|
437
|
-
|
|
438
|
-
console.log(result);
|
|
439
|
-
}
|
|
440
|
-
|
|
441
|
-
run();
|
|
442
|
-
```
|
|
443
|
-
|
|
444
|
-
### Standalone function
|
|
445
|
-
|
|
446
|
-
The standalone function version of this method:
|
|
447
|
-
|
|
448
|
-
```typescript
|
|
449
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
450
|
-
import { customerPortalOrdersGetPaymentStatus } from "@polar-sh/sdk/funcs/customerPortalOrdersGetPaymentStatus.js";
|
|
451
|
-
|
|
452
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
453
|
-
// You can create one instance of it to use across an application.
|
|
454
|
-
const polar = new PolarCore();
|
|
455
|
-
|
|
456
|
-
async function run() {
|
|
457
|
-
const res = await customerPortalOrdersGetPaymentStatus(polar, {
|
|
458
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
459
|
-
}, {
|
|
460
|
-
id: "<value>",
|
|
461
|
-
});
|
|
462
|
-
if (res.ok) {
|
|
463
|
-
const { value: result } = res;
|
|
464
|
-
console.log(result);
|
|
465
|
-
} else {
|
|
466
|
-
console.log("customerPortalOrdersGetPaymentStatus failed:", res.error);
|
|
467
|
-
}
|
|
468
|
-
}
|
|
469
|
-
|
|
470
|
-
run();
|
|
471
|
-
```
|
|
472
|
-
|
|
473
|
-
### Parameters
|
|
474
|
-
|
|
475
|
-
| Parameter | Type | Required | Description |
|
|
476
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
477
|
-
| `request` | [operations.CustomerPortalOrdersGetPaymentStatusRequest](../../models/operations/customerportalordersgetpaymentstatusrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
478
|
-
| `security` | [operations.CustomerPortalOrdersGetPaymentStatusSecurity](../../models/operations/customerportalordersgetpaymentstatussecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
479
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
480
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
481
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
482
|
-
|
|
483
|
-
### Response
|
|
484
|
-
|
|
485
|
-
**Promise\<[components.CustomerOrderPaymentStatus](../../models/components/customerorderpaymentstatus.md)\>**
|
|
486
|
-
|
|
487
|
-
### Errors
|
|
488
|
-
|
|
489
|
-
| Error Type | Status Code | Content Type |
|
|
490
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
491
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
492
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
493
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
494
|
-
|
|
495
|
-
## confirmRetryPayment
|
|
496
|
-
|
|
497
|
-
Confirm a retry payment using a Stripe confirmation token.
|
|
498
|
-
|
|
499
|
-
**Scopes**: `customer_portal:write`
|
|
500
|
-
|
|
501
|
-
### Example Usage
|
|
502
|
-
|
|
503
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:orders:confirm_retry_payment" method="post" path="/v1/customer-portal/orders/{id}/confirm-payment" -->
|
|
504
|
-
```typescript
|
|
505
|
-
import { Polar } from "@polar-sh/sdk";
|
|
506
|
-
|
|
507
|
-
const polar = new Polar();
|
|
508
|
-
|
|
509
|
-
async function run() {
|
|
510
|
-
const result = await polar.customerPortal.orders.confirmRetryPayment({
|
|
511
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
512
|
-
}, {
|
|
513
|
-
id: "<value>",
|
|
514
|
-
customerOrderConfirmPayment: {},
|
|
515
|
-
});
|
|
516
|
-
|
|
517
|
-
console.log(result);
|
|
518
|
-
}
|
|
519
|
-
|
|
520
|
-
run();
|
|
521
|
-
```
|
|
522
|
-
|
|
523
|
-
### Standalone function
|
|
524
|
-
|
|
525
|
-
The standalone function version of this method:
|
|
526
|
-
|
|
527
|
-
```typescript
|
|
528
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
529
|
-
import { customerPortalOrdersConfirmRetryPayment } from "@polar-sh/sdk/funcs/customerPortalOrdersConfirmRetryPayment.js";
|
|
530
|
-
|
|
531
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
532
|
-
// You can create one instance of it to use across an application.
|
|
533
|
-
const polar = new PolarCore();
|
|
534
|
-
|
|
535
|
-
async function run() {
|
|
536
|
-
const res = await customerPortalOrdersConfirmRetryPayment(polar, {
|
|
537
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
538
|
-
}, {
|
|
539
|
-
id: "<value>",
|
|
540
|
-
customerOrderConfirmPayment: {},
|
|
541
|
-
});
|
|
542
|
-
if (res.ok) {
|
|
543
|
-
const { value: result } = res;
|
|
544
|
-
console.log(result);
|
|
545
|
-
} else {
|
|
546
|
-
console.log("customerPortalOrdersConfirmRetryPayment failed:", res.error);
|
|
547
|
-
}
|
|
548
|
-
}
|
|
549
|
-
|
|
550
|
-
run();
|
|
551
|
-
```
|
|
552
|
-
|
|
553
|
-
### Parameters
|
|
554
|
-
|
|
555
|
-
| Parameter | Type | Required | Description |
|
|
556
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
557
|
-
| `request` | [operations.CustomerPortalOrdersConfirmRetryPaymentRequest](../../models/operations/customerportalordersconfirmretrypaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
558
|
-
| `security` | [operations.CustomerPortalOrdersConfirmRetryPaymentSecurity](../../models/operations/customerportalordersconfirmretrypaymentsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
559
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
560
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
561
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
562
|
-
|
|
563
|
-
### Response
|
|
564
|
-
|
|
565
|
-
**Promise\<[components.CustomerOrderPaymentConfirmation](../../models/components/customerorderpaymentconfirmation.md)\>**
|
|
566
|
-
|
|
567
|
-
### Errors
|
|
568
|
-
|
|
569
|
-
| Error Type | Status Code | Content Type |
|
|
570
|
-
| ------------------------------- | ------------------------------- | ------------------------------- |
|
|
571
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
572
|
-
| errors.PaymentAlreadyInProgress | 409 | application/json |
|
|
573
|
-
| errors.OrderNotEligibleForRetry | 422 | application/json |
|
|
574
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|