@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,441 +0,0 @@
|
|
|
1
|
-
# CustomerSeats
|
|
2
|
-
(*customerSeats*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [assignSeat](#assignseat) - Assign Seat
|
|
9
|
-
* [listSeats](#listseats) - List Seats
|
|
10
|
-
* [revokeSeat](#revokeseat) - Revoke Seat
|
|
11
|
-
* [resendInvitation](#resendinvitation) - Resend Invitation
|
|
12
|
-
* [getClaimInfo](#getclaiminfo) - Get Claim Info
|
|
13
|
-
* [claimSeat](#claimseat) - Claim Seat
|
|
14
|
-
|
|
15
|
-
## assignSeat
|
|
16
|
-
|
|
17
|
-
**Scopes**: `customer_seats:write`
|
|
18
|
-
|
|
19
|
-
### Example Usage
|
|
20
|
-
|
|
21
|
-
<!-- UsageSnippet language="typescript" operationID="customer-seats:assign_seat" method="post" path="/v1/customer-seats" -->
|
|
22
|
-
```typescript
|
|
23
|
-
import { Polar } from "@polar-sh/sdk";
|
|
24
|
-
|
|
25
|
-
const polar = new Polar({
|
|
26
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
27
|
-
});
|
|
28
|
-
|
|
29
|
-
async function run() {
|
|
30
|
-
const result = await polar.customerSeats.assignSeat({});
|
|
31
|
-
|
|
32
|
-
console.log(result);
|
|
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 { customerSeatsAssignSeat } from "@polar-sh/sdk/funcs/customerSeatsAssignSeat.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
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
50
|
-
});
|
|
51
|
-
|
|
52
|
-
async function run() {
|
|
53
|
-
const res = await customerSeatsAssignSeat(polar, {});
|
|
54
|
-
if (res.ok) {
|
|
55
|
-
const { value: result } = res;
|
|
56
|
-
console.log(result);
|
|
57
|
-
} else {
|
|
58
|
-
console.log("customerSeatsAssignSeat failed:", res.error);
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
run();
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
### Parameters
|
|
66
|
-
|
|
67
|
-
| Parameter | Type | Required | Description |
|
|
68
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
69
|
-
| `request` | [components.SeatAssign](../../models/components/seatassign.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
70
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
71
|
-
| `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. |
|
|
72
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
73
|
-
|
|
74
|
-
### Response
|
|
75
|
-
|
|
76
|
-
**Promise\<[components.CustomerSeat](../../models/components/customerseat.md)\>**
|
|
77
|
-
|
|
78
|
-
### Errors
|
|
79
|
-
|
|
80
|
-
| Error Type | Status Code | Content Type |
|
|
81
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
82
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
83
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
84
|
-
|
|
85
|
-
## listSeats
|
|
86
|
-
|
|
87
|
-
**Scopes**: `customer_seats:write`
|
|
88
|
-
|
|
89
|
-
### Example Usage
|
|
90
|
-
|
|
91
|
-
<!-- UsageSnippet language="typescript" operationID="customer-seats:list_seats" method="get" path="/v1/customer-seats" -->
|
|
92
|
-
```typescript
|
|
93
|
-
import { Polar } from "@polar-sh/sdk";
|
|
94
|
-
|
|
95
|
-
const polar = new Polar({
|
|
96
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
97
|
-
});
|
|
98
|
-
|
|
99
|
-
async function run() {
|
|
100
|
-
const result = await polar.customerSeats.listSeats({});
|
|
101
|
-
|
|
102
|
-
console.log(result);
|
|
103
|
-
}
|
|
104
|
-
|
|
105
|
-
run();
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
### Standalone function
|
|
109
|
-
|
|
110
|
-
The standalone function version of this method:
|
|
111
|
-
|
|
112
|
-
```typescript
|
|
113
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
114
|
-
import { customerSeatsListSeats } from "@polar-sh/sdk/funcs/customerSeatsListSeats.js";
|
|
115
|
-
|
|
116
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
117
|
-
// You can create one instance of it to use across an application.
|
|
118
|
-
const polar = new PolarCore({
|
|
119
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
120
|
-
});
|
|
121
|
-
|
|
122
|
-
async function run() {
|
|
123
|
-
const res = await customerSeatsListSeats(polar, {});
|
|
124
|
-
if (res.ok) {
|
|
125
|
-
const { value: result } = res;
|
|
126
|
-
console.log(result);
|
|
127
|
-
} else {
|
|
128
|
-
console.log("customerSeatsListSeats failed:", res.error);
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
|
|
132
|
-
run();
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
### Parameters
|
|
136
|
-
|
|
137
|
-
| Parameter | Type | Required | Description |
|
|
138
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
139
|
-
| `request` | [operations.CustomerSeatsListSeatsRequest](../../models/operations/customerseatslistseatsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
140
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
141
|
-
| `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. |
|
|
142
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
143
|
-
|
|
144
|
-
### Response
|
|
145
|
-
|
|
146
|
-
**Promise\<[components.SeatsList](../../models/components/seatslist.md)\>**
|
|
147
|
-
|
|
148
|
-
### Errors
|
|
149
|
-
|
|
150
|
-
| Error Type | Status Code | Content Type |
|
|
151
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
152
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
153
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
154
|
-
|
|
155
|
-
## revokeSeat
|
|
156
|
-
|
|
157
|
-
**Scopes**: `customer_seats:write`
|
|
158
|
-
|
|
159
|
-
### Example Usage
|
|
160
|
-
|
|
161
|
-
<!-- UsageSnippet language="typescript" operationID="customer-seats:revoke_seat" method="delete" path="/v1/customer-seats/{seat_id}" -->
|
|
162
|
-
```typescript
|
|
163
|
-
import { Polar } from "@polar-sh/sdk";
|
|
164
|
-
|
|
165
|
-
const polar = new Polar({
|
|
166
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
167
|
-
});
|
|
168
|
-
|
|
169
|
-
async function run() {
|
|
170
|
-
const result = await polar.customerSeats.revokeSeat({
|
|
171
|
-
seatId: "<id>",
|
|
172
|
-
});
|
|
173
|
-
|
|
174
|
-
console.log(result);
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
run();
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
### Standalone function
|
|
181
|
-
|
|
182
|
-
The standalone function version of this method:
|
|
183
|
-
|
|
184
|
-
```typescript
|
|
185
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
186
|
-
import { customerSeatsRevokeSeat } from "@polar-sh/sdk/funcs/customerSeatsRevokeSeat.js";
|
|
187
|
-
|
|
188
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
189
|
-
// You can create one instance of it to use across an application.
|
|
190
|
-
const polar = new PolarCore({
|
|
191
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
192
|
-
});
|
|
193
|
-
|
|
194
|
-
async function run() {
|
|
195
|
-
const res = await customerSeatsRevokeSeat(polar, {
|
|
196
|
-
seatId: "<id>",
|
|
197
|
-
});
|
|
198
|
-
if (res.ok) {
|
|
199
|
-
const { value: result } = res;
|
|
200
|
-
console.log(result);
|
|
201
|
-
} else {
|
|
202
|
-
console.log("customerSeatsRevokeSeat failed:", res.error);
|
|
203
|
-
}
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
run();
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
### Parameters
|
|
210
|
-
|
|
211
|
-
| Parameter | Type | Required | Description |
|
|
212
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
213
|
-
| `request` | [operations.CustomerSeatsRevokeSeatRequest](../../models/operations/customerseatsrevokeseatrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
214
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
215
|
-
| `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. |
|
|
216
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
217
|
-
|
|
218
|
-
### Response
|
|
219
|
-
|
|
220
|
-
**Promise\<[components.CustomerSeat](../../models/components/customerseat.md)\>**
|
|
221
|
-
|
|
222
|
-
### Errors
|
|
223
|
-
|
|
224
|
-
| Error Type | Status Code | Content Type |
|
|
225
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
226
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
227
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
228
|
-
|
|
229
|
-
## resendInvitation
|
|
230
|
-
|
|
231
|
-
**Scopes**: `customer_seats:write`
|
|
232
|
-
|
|
233
|
-
### Example Usage
|
|
234
|
-
|
|
235
|
-
<!-- UsageSnippet language="typescript" operationID="customer-seats:resend_invitation" method="post" path="/v1/customer-seats/{seat_id}/resend" -->
|
|
236
|
-
```typescript
|
|
237
|
-
import { Polar } from "@polar-sh/sdk";
|
|
238
|
-
|
|
239
|
-
const polar = new Polar({
|
|
240
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
241
|
-
});
|
|
242
|
-
|
|
243
|
-
async function run() {
|
|
244
|
-
const result = await polar.customerSeats.resendInvitation({
|
|
245
|
-
seatId: "<id>",
|
|
246
|
-
});
|
|
247
|
-
|
|
248
|
-
console.log(result);
|
|
249
|
-
}
|
|
250
|
-
|
|
251
|
-
run();
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
### Standalone function
|
|
255
|
-
|
|
256
|
-
The standalone function version of this method:
|
|
257
|
-
|
|
258
|
-
```typescript
|
|
259
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
260
|
-
import { customerSeatsResendInvitation } from "@polar-sh/sdk/funcs/customerSeatsResendInvitation.js";
|
|
261
|
-
|
|
262
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
263
|
-
// You can create one instance of it to use across an application.
|
|
264
|
-
const polar = new PolarCore({
|
|
265
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
266
|
-
});
|
|
267
|
-
|
|
268
|
-
async function run() {
|
|
269
|
-
const res = await customerSeatsResendInvitation(polar, {
|
|
270
|
-
seatId: "<id>",
|
|
271
|
-
});
|
|
272
|
-
if (res.ok) {
|
|
273
|
-
const { value: result } = res;
|
|
274
|
-
console.log(result);
|
|
275
|
-
} else {
|
|
276
|
-
console.log("customerSeatsResendInvitation failed:", res.error);
|
|
277
|
-
}
|
|
278
|
-
}
|
|
279
|
-
|
|
280
|
-
run();
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
### Parameters
|
|
284
|
-
|
|
285
|
-
| Parameter | Type | Required | Description |
|
|
286
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
287
|
-
| `request` | [operations.CustomerSeatsResendInvitationRequest](../../models/operations/customerseatsresendinvitationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
288
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
289
|
-
| `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. |
|
|
290
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
291
|
-
|
|
292
|
-
### Response
|
|
293
|
-
|
|
294
|
-
**Promise\<[components.CustomerSeat](../../models/components/customerseat.md)\>**
|
|
295
|
-
|
|
296
|
-
### Errors
|
|
297
|
-
|
|
298
|
-
| Error Type | Status Code | Content Type |
|
|
299
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
300
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
301
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
302
|
-
|
|
303
|
-
## getClaimInfo
|
|
304
|
-
|
|
305
|
-
Get Claim Info
|
|
306
|
-
|
|
307
|
-
### Example Usage
|
|
308
|
-
|
|
309
|
-
<!-- UsageSnippet language="typescript" operationID="customer-seats:get_claim_info" method="get" path="/v1/customer-seats/claim/{invitation_token}" -->
|
|
310
|
-
```typescript
|
|
311
|
-
import { Polar } from "@polar-sh/sdk";
|
|
312
|
-
|
|
313
|
-
const polar = new Polar();
|
|
314
|
-
|
|
315
|
-
async function run() {
|
|
316
|
-
const result = await polar.customerSeats.getClaimInfo({
|
|
317
|
-
invitationToken: "<value>",
|
|
318
|
-
});
|
|
319
|
-
|
|
320
|
-
console.log(result);
|
|
321
|
-
}
|
|
322
|
-
|
|
323
|
-
run();
|
|
324
|
-
```
|
|
325
|
-
|
|
326
|
-
### Standalone function
|
|
327
|
-
|
|
328
|
-
The standalone function version of this method:
|
|
329
|
-
|
|
330
|
-
```typescript
|
|
331
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
332
|
-
import { customerSeatsGetClaimInfo } from "@polar-sh/sdk/funcs/customerSeatsGetClaimInfo.js";
|
|
333
|
-
|
|
334
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
335
|
-
// You can create one instance of it to use across an application.
|
|
336
|
-
const polar = new PolarCore();
|
|
337
|
-
|
|
338
|
-
async function run() {
|
|
339
|
-
const res = await customerSeatsGetClaimInfo(polar, {
|
|
340
|
-
invitationToken: "<value>",
|
|
341
|
-
});
|
|
342
|
-
if (res.ok) {
|
|
343
|
-
const { value: result } = res;
|
|
344
|
-
console.log(result);
|
|
345
|
-
} else {
|
|
346
|
-
console.log("customerSeatsGetClaimInfo failed:", res.error);
|
|
347
|
-
}
|
|
348
|
-
}
|
|
349
|
-
|
|
350
|
-
run();
|
|
351
|
-
```
|
|
352
|
-
|
|
353
|
-
### Parameters
|
|
354
|
-
|
|
355
|
-
| Parameter | Type | Required | Description |
|
|
356
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
357
|
-
| `request` | [operations.CustomerSeatsGetClaimInfoRequest](../../models/operations/customerseatsgetclaiminforequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
358
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
359
|
-
| `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. |
|
|
360
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
361
|
-
|
|
362
|
-
### Response
|
|
363
|
-
|
|
364
|
-
**Promise\<[components.SeatClaimInfo](../../models/components/seatclaiminfo.md)\>**
|
|
365
|
-
|
|
366
|
-
### Errors
|
|
367
|
-
|
|
368
|
-
| Error Type | Status Code | Content Type |
|
|
369
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
370
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
371
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
372
|
-
|
|
373
|
-
## claimSeat
|
|
374
|
-
|
|
375
|
-
Claim Seat
|
|
376
|
-
|
|
377
|
-
### Example Usage
|
|
378
|
-
|
|
379
|
-
<!-- UsageSnippet language="typescript" operationID="customer-seats:claim_seat" method="post" path="/v1/customer-seats/claim" -->
|
|
380
|
-
```typescript
|
|
381
|
-
import { Polar } from "@polar-sh/sdk";
|
|
382
|
-
|
|
383
|
-
const polar = new Polar();
|
|
384
|
-
|
|
385
|
-
async function run() {
|
|
386
|
-
const result = await polar.customerSeats.claimSeat({
|
|
387
|
-
invitationToken: "<value>",
|
|
388
|
-
});
|
|
389
|
-
|
|
390
|
-
console.log(result);
|
|
391
|
-
}
|
|
392
|
-
|
|
393
|
-
run();
|
|
394
|
-
```
|
|
395
|
-
|
|
396
|
-
### Standalone function
|
|
397
|
-
|
|
398
|
-
The standalone function version of this method:
|
|
399
|
-
|
|
400
|
-
```typescript
|
|
401
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
402
|
-
import { customerSeatsClaimSeat } from "@polar-sh/sdk/funcs/customerSeatsClaimSeat.js";
|
|
403
|
-
|
|
404
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
405
|
-
// You can create one instance of it to use across an application.
|
|
406
|
-
const polar = new PolarCore();
|
|
407
|
-
|
|
408
|
-
async function run() {
|
|
409
|
-
const res = await customerSeatsClaimSeat(polar, {
|
|
410
|
-
invitationToken: "<value>",
|
|
411
|
-
});
|
|
412
|
-
if (res.ok) {
|
|
413
|
-
const { value: result } = res;
|
|
414
|
-
console.log(result);
|
|
415
|
-
} else {
|
|
416
|
-
console.log("customerSeatsClaimSeat failed:", res.error);
|
|
417
|
-
}
|
|
418
|
-
}
|
|
419
|
-
|
|
420
|
-
run();
|
|
421
|
-
```
|
|
422
|
-
|
|
423
|
-
### Parameters
|
|
424
|
-
|
|
425
|
-
| Parameter | Type | Required | Description |
|
|
426
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
427
|
-
| `request` | [components.SeatClaim](../../models/components/seatclaim.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
428
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
429
|
-
| `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. |
|
|
430
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
431
|
-
|
|
432
|
-
### Response
|
|
433
|
-
|
|
434
|
-
**Promise\<[components.CustomerSeatClaimResponse](../../models/components/customerseatclaimresponse.md)\>**
|
|
435
|
-
|
|
436
|
-
### Errors
|
|
437
|
-
|
|
438
|
-
| Error Type | Status Code | Content Type |
|
|
439
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
440
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
441
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
# CustomerSession
|
|
2
|
-
(*customerPortal.customerSession*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [introspect](#introspect) - Introspect Customer Session
|
|
9
|
-
|
|
10
|
-
## introspect
|
|
11
|
-
|
|
12
|
-
Introspect the current session and return its information.
|
|
13
|
-
|
|
14
|
-
**Scopes**: `customer_portal:read` `customer_portal:write`
|
|
15
|
-
|
|
16
|
-
### Example Usage
|
|
17
|
-
|
|
18
|
-
<!-- UsageSnippet language="typescript" operationID="customer_portal:customer-session:introspect" method="get" path="/v1/customer-portal/customer-session/introspect" -->
|
|
19
|
-
```typescript
|
|
20
|
-
import { Polar } from "@polar-sh/sdk";
|
|
21
|
-
|
|
22
|
-
const polar = new Polar();
|
|
23
|
-
|
|
24
|
-
async function run() {
|
|
25
|
-
const result = await polar.customerPortal.customerSession.introspect({
|
|
26
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
27
|
-
});
|
|
28
|
-
|
|
29
|
-
console.log(result);
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
run();
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
### Standalone function
|
|
36
|
-
|
|
37
|
-
The standalone function version of this method:
|
|
38
|
-
|
|
39
|
-
```typescript
|
|
40
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
41
|
-
import { customerPortalCustomerSessionIntrospect } from "@polar-sh/sdk/funcs/customerPortalCustomerSessionIntrospect.js";
|
|
42
|
-
|
|
43
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
44
|
-
// You can create one instance of it to use across an application.
|
|
45
|
-
const polar = new PolarCore();
|
|
46
|
-
|
|
47
|
-
async function run() {
|
|
48
|
-
const res = await customerPortalCustomerSessionIntrospect(polar, {
|
|
49
|
-
customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
|
|
50
|
-
});
|
|
51
|
-
if (res.ok) {
|
|
52
|
-
const { value: result } = res;
|
|
53
|
-
console.log(result);
|
|
54
|
-
} else {
|
|
55
|
-
console.log("customerPortalCustomerSessionIntrospect failed:", res.error);
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
run();
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### Parameters
|
|
63
|
-
|
|
64
|
-
| Parameter | Type | Required | Description |
|
|
65
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
66
|
-
| `security` | [operations.CustomerPortalCustomerSessionIntrospectSecurity](../../models/operations/customerportalcustomersessionintrospectsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
67
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
68
|
-
| `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. |
|
|
69
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
70
|
-
|
|
71
|
-
### Response
|
|
72
|
-
|
|
73
|
-
**Promise\<[components.CustomerCustomerSession](../../models/components/customercustomersession.md)\>**
|
|
74
|
-
|
|
75
|
-
### Errors
|
|
76
|
-
|
|
77
|
-
| Error Type | Status Code | Content Type |
|
|
78
|
-
| --------------- | --------------- | --------------- |
|
|
79
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
# CustomerSessions
|
|
2
|
-
(*customerSessions*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [create](#create) - Create Customer Session
|
|
9
|
-
|
|
10
|
-
## create
|
|
11
|
-
|
|
12
|
-
Create a customer session.
|
|
13
|
-
|
|
14
|
-
**Scopes**: `customer_sessions:write`
|
|
15
|
-
|
|
16
|
-
### Example Usage
|
|
17
|
-
|
|
18
|
-
<!-- UsageSnippet language="typescript" operationID="customer-sessions:create" method="post" path="/v1/customer-sessions/" -->
|
|
19
|
-
```typescript
|
|
20
|
-
import { Polar } from "@polar-sh/sdk";
|
|
21
|
-
|
|
22
|
-
const polar = new Polar({
|
|
23
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
24
|
-
});
|
|
25
|
-
|
|
26
|
-
async function run() {
|
|
27
|
-
const result = await polar.customerSessions.create({
|
|
28
|
-
externalCustomerId: "<id>",
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
console.log(result);
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
run();
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
### Standalone function
|
|
38
|
-
|
|
39
|
-
The standalone function version of this method:
|
|
40
|
-
|
|
41
|
-
```typescript
|
|
42
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
43
|
-
import { customerSessionsCreate } from "@polar-sh/sdk/funcs/customerSessionsCreate.js";
|
|
44
|
-
|
|
45
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
46
|
-
// You can create one instance of it to use across an application.
|
|
47
|
-
const polar = new PolarCore({
|
|
48
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
49
|
-
});
|
|
50
|
-
|
|
51
|
-
async function run() {
|
|
52
|
-
const res = await customerSessionsCreate(polar, {
|
|
53
|
-
externalCustomerId: "<id>",
|
|
54
|
-
});
|
|
55
|
-
if (res.ok) {
|
|
56
|
-
const { value: result } = res;
|
|
57
|
-
console.log(result);
|
|
58
|
-
} else {
|
|
59
|
-
console.log("customerSessionsCreate failed:", res.error);
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
run();
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
### Parameters
|
|
67
|
-
|
|
68
|
-
| Parameter | Type | Required | Description |
|
|
69
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
70
|
-
| `request` | [operations.CustomerSessionsCreateCustomerSessionCreate](../../models/operations/customersessionscreatecustomersessioncreate.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
71
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
72
|
-
| `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. |
|
|
73
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
74
|
-
|
|
75
|
-
### Response
|
|
76
|
-
|
|
77
|
-
**Promise\<[components.CustomerSession](../../models/components/customersession.md)\>**
|
|
78
|
-
|
|
79
|
-
### Errors
|
|
80
|
-
|
|
81
|
-
| Error Type | Status Code | Content Type |
|
|
82
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
83
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
84
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|