@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,79 +0,0 @@
|
|
|
1
|
-
# PolarOrganizations
|
|
2
|
-
(*customerPortal.organizations*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [get](#get) - Get Organization
|
|
9
|
-
|
|
10
|
-
## get
|
|
11
|
-
|
|
12
|
-
Get a customer portal's organization by slug.
|
|
13
|
-
|
|
14
|
-
### Example Usage
|
|
15
|
-
|
|
16
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:organizations:get" method="get" path="/v1/customer-portal/organizations/{slug}" -->
|
|
17
|
-
```typescript
|
|
18
|
-
import { Polar } from "@polar-sh/sdk";
|
|
19
|
-
|
|
20
|
-
const polar = new Polar();
|
|
21
|
-
|
|
22
|
-
async function run() {
|
|
23
|
-
const result = await polar.customerPortal.organizations.get({
|
|
24
|
-
slug: "<value>",
|
|
25
|
-
});
|
|
26
|
-
|
|
27
|
-
console.log(result);
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
run();
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
### Standalone function
|
|
34
|
-
|
|
35
|
-
The standalone function version of this method:
|
|
36
|
-
|
|
37
|
-
```typescript
|
|
38
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
39
|
-
import { customerPortalOrganizationsGet } from "@polar-sh/sdk/funcs/customerPortalOrganizationsGet.js";
|
|
40
|
-
|
|
41
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
42
|
-
// You can create one instance of it to use across an application.
|
|
43
|
-
const polar = new PolarCore();
|
|
44
|
-
|
|
45
|
-
async function run() {
|
|
46
|
-
const res = await customerPortalOrganizationsGet(polar, {
|
|
47
|
-
slug: "<value>",
|
|
48
|
-
});
|
|
49
|
-
if (res.ok) {
|
|
50
|
-
const { value: result } = res;
|
|
51
|
-
console.log(result);
|
|
52
|
-
} else {
|
|
53
|
-
console.log("customerPortalOrganizationsGet failed:", res.error);
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
run();
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
### Parameters
|
|
61
|
-
|
|
62
|
-
| Parameter | Type | Required | Description |
|
|
63
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
64
|
-
| `request` | [operations.CustomerPortalOrganizationsGetRequest](../../models/operations/customerportalorganizationsgetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
65
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
66
|
-
| `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. |
|
|
67
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
68
|
-
|
|
69
|
-
### Response
|
|
70
|
-
|
|
71
|
-
**Promise\<[components.CustomerOrganization](../../models/components/customerorganization.md)\>**
|
|
72
|
-
|
|
73
|
-
### Errors
|
|
74
|
-
|
|
75
|
-
| Error Type | Status Code | Content Type |
|
|
76
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
77
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
78
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
79
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -1,326 +0,0 @@
|
|
|
1
|
-
# PolarSubscriptions
|
|
2
|
-
(*customerPortal.subscriptions*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [list](#list) - List Subscriptions
|
|
9
|
-
* [get](#get) - Get Subscription
|
|
10
|
-
* [update](#update) - Update Subscription
|
|
11
|
-
* [cancel](#cancel) - Cancel Subscription
|
|
12
|
-
|
|
13
|
-
## list
|
|
14
|
-
|
|
15
|
-
List subscriptions of the authenticated customer.
|
|
16
|
-
|
|
17
|
-
**Scopes**: `customer_portal:read` `customer_portal:write`
|
|
18
|
-
|
|
19
|
-
### Example Usage
|
|
20
|
-
|
|
21
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:subscriptions:list" method="get" path="/v1/customer-portal/subscriptions/" -->
|
|
22
|
-
```typescript
|
|
23
|
-
import { Polar } from "@polar-sh/sdk";
|
|
24
|
-
|
|
25
|
-
const polar = new Polar();
|
|
26
|
-
|
|
27
|
-
async function run() {
|
|
28
|
-
const result = await polar.customerPortal.subscriptions.list({
|
|
29
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
30
|
-
}, {});
|
|
31
|
-
|
|
32
|
-
for await (const page of result) {
|
|
33
|
-
console.log(page);
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
run();
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
### Standalone function
|
|
41
|
-
|
|
42
|
-
The standalone function version of this method:
|
|
43
|
-
|
|
44
|
-
```typescript
|
|
45
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
46
|
-
import { customerPortalSubscriptionsList } from "@polar-sh/sdk/funcs/customerPortalSubscriptionsList.js";
|
|
47
|
-
|
|
48
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
49
|
-
// You can create one instance of it to use across an application.
|
|
50
|
-
const polar = new PolarCore();
|
|
51
|
-
|
|
52
|
-
async function run() {
|
|
53
|
-
const res = await customerPortalSubscriptionsList(polar, {
|
|
54
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
55
|
-
}, {});
|
|
56
|
-
if (res.ok) {
|
|
57
|
-
const { value: result } = res;
|
|
58
|
-
for await (const page of result) {
|
|
59
|
-
console.log(page);
|
|
60
|
-
}
|
|
61
|
-
} else {
|
|
62
|
-
console.log("customerPortalSubscriptionsList failed:", res.error);
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
run();
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
### Parameters
|
|
70
|
-
|
|
71
|
-
| Parameter | Type | Required | Description |
|
|
72
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
73
|
-
| `request` | [operations.CustomerPortalSubscriptionsListRequest](../../models/operations/customerportalsubscriptionslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
74
|
-
| `security` | [operations.CustomerPortalSubscriptionsListSecurity](../../models/operations/customerportalsubscriptionslistsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
75
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
76
|
-
| `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. |
|
|
77
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
78
|
-
|
|
79
|
-
### Response
|
|
80
|
-
|
|
81
|
-
**Promise\<[operations.CustomerPortalSubscriptionsListResponse](../../models/operations/customerportalsubscriptionslistresponse.md)\>**
|
|
82
|
-
|
|
83
|
-
### Errors
|
|
84
|
-
|
|
85
|
-
| Error Type | Status Code | Content Type |
|
|
86
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
87
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
88
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
89
|
-
|
|
90
|
-
## get
|
|
91
|
-
|
|
92
|
-
Get a subscription for the authenticated customer.
|
|
93
|
-
|
|
94
|
-
**Scopes**: `customer_portal:read` `customer_portal:write`
|
|
95
|
-
|
|
96
|
-
### Example Usage
|
|
97
|
-
|
|
98
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:subscriptions:get" method="get" path="/v1/customer-portal/subscriptions/{id}" -->
|
|
99
|
-
```typescript
|
|
100
|
-
import { Polar } from "@polar-sh/sdk";
|
|
101
|
-
|
|
102
|
-
const polar = new Polar();
|
|
103
|
-
|
|
104
|
-
async function run() {
|
|
105
|
-
const result = await polar.customerPortal.subscriptions.get({
|
|
106
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
107
|
-
}, {
|
|
108
|
-
id: "<value>",
|
|
109
|
-
});
|
|
110
|
-
|
|
111
|
-
console.log(result);
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
run();
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
### Standalone function
|
|
118
|
-
|
|
119
|
-
The standalone function version of this method:
|
|
120
|
-
|
|
121
|
-
```typescript
|
|
122
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
123
|
-
import { customerPortalSubscriptionsGet } from "@polar-sh/sdk/funcs/customerPortalSubscriptionsGet.js";
|
|
124
|
-
|
|
125
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
126
|
-
// You can create one instance of it to use across an application.
|
|
127
|
-
const polar = new PolarCore();
|
|
128
|
-
|
|
129
|
-
async function run() {
|
|
130
|
-
const res = await customerPortalSubscriptionsGet(polar, {
|
|
131
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
132
|
-
}, {
|
|
133
|
-
id: "<value>",
|
|
134
|
-
});
|
|
135
|
-
if (res.ok) {
|
|
136
|
-
const { value: result } = res;
|
|
137
|
-
console.log(result);
|
|
138
|
-
} else {
|
|
139
|
-
console.log("customerPortalSubscriptionsGet failed:", res.error);
|
|
140
|
-
}
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
run();
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
### Parameters
|
|
147
|
-
|
|
148
|
-
| Parameter | Type | Required | Description |
|
|
149
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
150
|
-
| `request` | [operations.CustomerPortalSubscriptionsGetRequest](../../models/operations/customerportalsubscriptionsgetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
151
|
-
| `security` | [operations.CustomerPortalSubscriptionsGetSecurity](../../models/operations/customerportalsubscriptionsgetsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
152
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
153
|
-
| `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. |
|
|
154
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
155
|
-
|
|
156
|
-
### Response
|
|
157
|
-
|
|
158
|
-
**Promise\<[components.CustomerSubscription](../../models/components/customersubscription.md)\>**
|
|
159
|
-
|
|
160
|
-
### Errors
|
|
161
|
-
|
|
162
|
-
| Error Type | Status Code | Content Type |
|
|
163
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
164
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
165
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
166
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
167
|
-
|
|
168
|
-
## update
|
|
169
|
-
|
|
170
|
-
Update a subscription of the authenticated customer.
|
|
171
|
-
|
|
172
|
-
**Scopes**: `customer_portal:write`
|
|
173
|
-
|
|
174
|
-
### Example Usage
|
|
175
|
-
|
|
176
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:subscriptions:update" method="patch" path="/v1/customer-portal/subscriptions/{id}" -->
|
|
177
|
-
```typescript
|
|
178
|
-
import { Polar } from "@polar-sh/sdk";
|
|
179
|
-
|
|
180
|
-
const polar = new Polar();
|
|
181
|
-
|
|
182
|
-
async function run() {
|
|
183
|
-
const result = await polar.customerPortal.subscriptions.update({
|
|
184
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
185
|
-
}, {
|
|
186
|
-
id: "<value>",
|
|
187
|
-
customerSubscriptionUpdate: {},
|
|
188
|
-
});
|
|
189
|
-
|
|
190
|
-
console.log(result);
|
|
191
|
-
}
|
|
192
|
-
|
|
193
|
-
run();
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
### Standalone function
|
|
197
|
-
|
|
198
|
-
The standalone function version of this method:
|
|
199
|
-
|
|
200
|
-
```typescript
|
|
201
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
202
|
-
import { customerPortalSubscriptionsUpdate } from "@polar-sh/sdk/funcs/customerPortalSubscriptionsUpdate.js";
|
|
203
|
-
|
|
204
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
205
|
-
// You can create one instance of it to use across an application.
|
|
206
|
-
const polar = new PolarCore();
|
|
207
|
-
|
|
208
|
-
async function run() {
|
|
209
|
-
const res = await customerPortalSubscriptionsUpdate(polar, {
|
|
210
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
211
|
-
}, {
|
|
212
|
-
id: "<value>",
|
|
213
|
-
customerSubscriptionUpdate: {},
|
|
214
|
-
});
|
|
215
|
-
if (res.ok) {
|
|
216
|
-
const { value: result } = res;
|
|
217
|
-
console.log(result);
|
|
218
|
-
} else {
|
|
219
|
-
console.log("customerPortalSubscriptionsUpdate failed:", res.error);
|
|
220
|
-
}
|
|
221
|
-
}
|
|
222
|
-
|
|
223
|
-
run();
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
### Parameters
|
|
227
|
-
|
|
228
|
-
| Parameter | Type | Required | Description |
|
|
229
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
230
|
-
| `request` | [operations.CustomerPortalSubscriptionsUpdateRequest](../../models/operations/customerportalsubscriptionsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
231
|
-
| `security` | [operations.CustomerPortalSubscriptionsUpdateSecurity](../../models/operations/customerportalsubscriptionsupdatesecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
232
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
233
|
-
| `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. |
|
|
234
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
235
|
-
|
|
236
|
-
### Response
|
|
237
|
-
|
|
238
|
-
**Promise\<[components.CustomerSubscription](../../models/components/customersubscription.md)\>**
|
|
239
|
-
|
|
240
|
-
### Errors
|
|
241
|
-
|
|
242
|
-
| Error Type | Status Code | Content Type |
|
|
243
|
-
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
|
244
|
-
| errors.AlreadyCanceledSubscription | 403 | application/json |
|
|
245
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
246
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
247
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
248
|
-
|
|
249
|
-
## cancel
|
|
250
|
-
|
|
251
|
-
Cancel a subscription of the authenticated customer.
|
|
252
|
-
|
|
253
|
-
**Scopes**: `customer_portal:write`
|
|
254
|
-
|
|
255
|
-
### Example Usage
|
|
256
|
-
|
|
257
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:subscriptions:cancel" method="delete" path="/v1/customer-portal/subscriptions/{id}" -->
|
|
258
|
-
```typescript
|
|
259
|
-
import { Polar } from "@polar-sh/sdk";
|
|
260
|
-
|
|
261
|
-
const polar = new Polar();
|
|
262
|
-
|
|
263
|
-
async function run() {
|
|
264
|
-
const result = await polar.customerPortal.subscriptions.cancel({
|
|
265
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
266
|
-
}, {
|
|
267
|
-
id: "<value>",
|
|
268
|
-
});
|
|
269
|
-
|
|
270
|
-
console.log(result);
|
|
271
|
-
}
|
|
272
|
-
|
|
273
|
-
run();
|
|
274
|
-
```
|
|
275
|
-
|
|
276
|
-
### Standalone function
|
|
277
|
-
|
|
278
|
-
The standalone function version of this method:
|
|
279
|
-
|
|
280
|
-
```typescript
|
|
281
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
282
|
-
import { customerPortalSubscriptionsCancel } from "@polar-sh/sdk/funcs/customerPortalSubscriptionsCancel.js";
|
|
283
|
-
|
|
284
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
285
|
-
// You can create one instance of it to use across an application.
|
|
286
|
-
const polar = new PolarCore();
|
|
287
|
-
|
|
288
|
-
async function run() {
|
|
289
|
-
const res = await customerPortalSubscriptionsCancel(polar, {
|
|
290
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
291
|
-
}, {
|
|
292
|
-
id: "<value>",
|
|
293
|
-
});
|
|
294
|
-
if (res.ok) {
|
|
295
|
-
const { value: result } = res;
|
|
296
|
-
console.log(result);
|
|
297
|
-
} else {
|
|
298
|
-
console.log("customerPortalSubscriptionsCancel failed:", res.error);
|
|
299
|
-
}
|
|
300
|
-
}
|
|
301
|
-
|
|
302
|
-
run();
|
|
303
|
-
```
|
|
304
|
-
|
|
305
|
-
### Parameters
|
|
306
|
-
|
|
307
|
-
| Parameter | Type | Required | Description |
|
|
308
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
309
|
-
| `request` | [operations.CustomerPortalSubscriptionsCancelRequest](../../models/operations/customerportalsubscriptionscancelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
310
|
-
| `security` | [operations.CustomerPortalSubscriptionsCancelSecurity](../../models/operations/customerportalsubscriptionscancelsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
311
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
312
|
-
| `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. |
|
|
313
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
314
|
-
|
|
315
|
-
### Response
|
|
316
|
-
|
|
317
|
-
**Promise\<[components.CustomerSubscription](../../models/components/customersubscription.md)\>**
|
|
318
|
-
|
|
319
|
-
### Errors
|
|
320
|
-
|
|
321
|
-
| Error Type | Status Code | Content Type |
|
|
322
|
-
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
|
323
|
-
| errors.AlreadyCanceledSubscription | 403 | application/json |
|
|
324
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
325
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
326
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -1,164 +0,0 @@
|
|
|
1
|
-
# PolarWallets
|
|
2
|
-
(*customerPortal.wallets*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [list](#list) - List Wallets
|
|
9
|
-
* [get](#get) - Get Wallet
|
|
10
|
-
|
|
11
|
-
## list
|
|
12
|
-
|
|
13
|
-
List wallets of the authenticated customer.
|
|
14
|
-
|
|
15
|
-
**Scopes**: `customer_portal:read` `customer_portal:write`
|
|
16
|
-
|
|
17
|
-
### Example Usage
|
|
18
|
-
|
|
19
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:wallets:list" method="get" path="/v1/customer-portal/wallets/" -->
|
|
20
|
-
```typescript
|
|
21
|
-
import { Polar } from "@polar-sh/sdk";
|
|
22
|
-
|
|
23
|
-
const polar = new Polar();
|
|
24
|
-
|
|
25
|
-
async function run() {
|
|
26
|
-
const result = await polar.customerPortal.wallets.list({
|
|
27
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
28
|
-
}, {});
|
|
29
|
-
|
|
30
|
-
for await (const page of result) {
|
|
31
|
-
console.log(page);
|
|
32
|
-
}
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
run();
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### Standalone function
|
|
39
|
-
|
|
40
|
-
The standalone function version of this method:
|
|
41
|
-
|
|
42
|
-
```typescript
|
|
43
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
44
|
-
import { customerPortalWalletsList } from "@polar-sh/sdk/funcs/customerPortalWalletsList.js";
|
|
45
|
-
|
|
46
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
47
|
-
// You can create one instance of it to use across an application.
|
|
48
|
-
const polar = new PolarCore();
|
|
49
|
-
|
|
50
|
-
async function run() {
|
|
51
|
-
const res = await customerPortalWalletsList(polar, {
|
|
52
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
53
|
-
}, {});
|
|
54
|
-
if (res.ok) {
|
|
55
|
-
const { value: result } = res;
|
|
56
|
-
for await (const page of result) {
|
|
57
|
-
console.log(page);
|
|
58
|
-
}
|
|
59
|
-
} else {
|
|
60
|
-
console.log("customerPortalWalletsList failed:", res.error);
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
run();
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
### Parameters
|
|
68
|
-
|
|
69
|
-
| Parameter | Type | Required | Description |
|
|
70
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
71
|
-
| `request` | [operations.CustomerPortalWalletsListRequest](../../models/operations/customerportalwalletslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
72
|
-
| `security` | [operations.CustomerPortalWalletsListSecurity](../../models/operations/customerportalwalletslistsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
73
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
74
|
-
| `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. |
|
|
75
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
76
|
-
|
|
77
|
-
### Response
|
|
78
|
-
|
|
79
|
-
**Promise\<[operations.CustomerPortalWalletsListResponse](../../models/operations/customerportalwalletslistresponse.md)\>**
|
|
80
|
-
|
|
81
|
-
### Errors
|
|
82
|
-
|
|
83
|
-
| Error Type | Status Code | Content Type |
|
|
84
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
85
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
86
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
87
|
-
|
|
88
|
-
## get
|
|
89
|
-
|
|
90
|
-
Get a wallet by ID for the authenticated customer.
|
|
91
|
-
|
|
92
|
-
**Scopes**: `customer_portal:read` `customer_portal:write`
|
|
93
|
-
|
|
94
|
-
### Example Usage
|
|
95
|
-
|
|
96
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:wallets:get" method="get" path="/v1/customer-portal/wallets/{id}" -->
|
|
97
|
-
```typescript
|
|
98
|
-
import { Polar } from "@polar-sh/sdk";
|
|
99
|
-
|
|
100
|
-
const polar = new Polar();
|
|
101
|
-
|
|
102
|
-
async function run() {
|
|
103
|
-
const result = await polar.customerPortal.wallets.get({
|
|
104
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
105
|
-
}, {
|
|
106
|
-
id: "<value>",
|
|
107
|
-
});
|
|
108
|
-
|
|
109
|
-
console.log(result);
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
run();
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
### Standalone function
|
|
116
|
-
|
|
117
|
-
The standalone function version of this method:
|
|
118
|
-
|
|
119
|
-
```typescript
|
|
120
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
121
|
-
import { customerPortalWalletsGet } from "@polar-sh/sdk/funcs/customerPortalWalletsGet.js";
|
|
122
|
-
|
|
123
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
124
|
-
// You can create one instance of it to use across an application.
|
|
125
|
-
const polar = new PolarCore();
|
|
126
|
-
|
|
127
|
-
async function run() {
|
|
128
|
-
const res = await customerPortalWalletsGet(polar, {
|
|
129
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
130
|
-
}, {
|
|
131
|
-
id: "<value>",
|
|
132
|
-
});
|
|
133
|
-
if (res.ok) {
|
|
134
|
-
const { value: result } = res;
|
|
135
|
-
console.log(result);
|
|
136
|
-
} else {
|
|
137
|
-
console.log("customerPortalWalletsGet failed:", res.error);
|
|
138
|
-
}
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
run();
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
### Parameters
|
|
145
|
-
|
|
146
|
-
| Parameter | Type | Required | Description |
|
|
147
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
148
|
-
| `request` | [operations.CustomerPortalWalletsGetRequest](../../models/operations/customerportalwalletsgetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
149
|
-
| `security` | [operations.CustomerPortalWalletsGetSecurity](../../models/operations/customerportalwalletsgetsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
150
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
151
|
-
| `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. |
|
|
152
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
153
|
-
|
|
154
|
-
### Response
|
|
155
|
-
|
|
156
|
-
**Promise\<[components.CustomerWallet](../../models/components/customerwallet.md)\>**
|
|
157
|
-
|
|
158
|
-
### Errors
|
|
159
|
-
|
|
160
|
-
| Error Type | Status Code | Content Type |
|
|
161
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
162
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
163
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
164
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|