@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,650 +0,0 @@
|
|
|
1
|
-
# Webhooks
|
|
2
|
-
(*webhooks*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [listWebhookEndpoints](#listwebhookendpoints) - List Webhook Endpoints
|
|
9
|
-
* [createWebhookEndpoint](#createwebhookendpoint) - Create Webhook Endpoint
|
|
10
|
-
* [getWebhookEndpoint](#getwebhookendpoint) - Get Webhook Endpoint
|
|
11
|
-
* [updateWebhookEndpoint](#updatewebhookendpoint) - Update Webhook Endpoint
|
|
12
|
-
* [deleteWebhookEndpoint](#deletewebhookendpoint) - Delete Webhook Endpoint
|
|
13
|
-
* [resetWebhookEndpointSecret](#resetwebhookendpointsecret) - Reset Webhook Endpoint Secret
|
|
14
|
-
* [listWebhookDeliveries](#listwebhookdeliveries) - List Webhook Deliveries
|
|
15
|
-
* [redeliverWebhookEvent](#redeliverwebhookevent) - Redeliver Webhook Event
|
|
16
|
-
|
|
17
|
-
## listWebhookEndpoints
|
|
18
|
-
|
|
19
|
-
List webhook endpoints.
|
|
20
|
-
|
|
21
|
-
**Scopes**: `webhooks:read` `webhooks:write`
|
|
22
|
-
|
|
23
|
-
### Example Usage
|
|
24
|
-
|
|
25
|
-
<!-- UsageSnippet language="typescript" operationID="webhooks:list_webhook_endpoints" method="get" path="/v1/webhooks/endpoints" -->
|
|
26
|
-
```typescript
|
|
27
|
-
import { Polar } from "@polar-sh/sdk";
|
|
28
|
-
|
|
29
|
-
const polar = new Polar({
|
|
30
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
31
|
-
});
|
|
32
|
-
|
|
33
|
-
async function run() {
|
|
34
|
-
const result = await polar.webhooks.listWebhookEndpoints({
|
|
35
|
-
organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
|
|
36
|
-
});
|
|
37
|
-
|
|
38
|
-
for await (const page of result) {
|
|
39
|
-
console.log(page);
|
|
40
|
-
}
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
run();
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### Standalone function
|
|
47
|
-
|
|
48
|
-
The standalone function version of this method:
|
|
49
|
-
|
|
50
|
-
```typescript
|
|
51
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
52
|
-
import { webhooksListWebhookEndpoints } from "@polar-sh/sdk/funcs/webhooksListWebhookEndpoints.js";
|
|
53
|
-
|
|
54
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
55
|
-
// You can create one instance of it to use across an application.
|
|
56
|
-
const polar = new PolarCore({
|
|
57
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
58
|
-
});
|
|
59
|
-
|
|
60
|
-
async function run() {
|
|
61
|
-
const res = await webhooksListWebhookEndpoints(polar, {
|
|
62
|
-
organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
|
|
63
|
-
});
|
|
64
|
-
if (res.ok) {
|
|
65
|
-
const { value: result } = res;
|
|
66
|
-
for await (const page of result) {
|
|
67
|
-
console.log(page);
|
|
68
|
-
}
|
|
69
|
-
} else {
|
|
70
|
-
console.log("webhooksListWebhookEndpoints failed:", res.error);
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
run();
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Parameters
|
|
78
|
-
|
|
79
|
-
| Parameter | Type | Required | Description |
|
|
80
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
81
|
-
| `request` | [operations.WebhooksListWebhookEndpointsRequest](../../models/operations/webhookslistwebhookendpointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
82
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
83
|
-
| `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. |
|
|
84
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
85
|
-
|
|
86
|
-
### Response
|
|
87
|
-
|
|
88
|
-
**Promise\<[operations.WebhooksListWebhookEndpointsResponse](../../models/operations/webhookslistwebhookendpointsresponse.md)\>**
|
|
89
|
-
|
|
90
|
-
### Errors
|
|
91
|
-
|
|
92
|
-
| Error Type | Status Code | Content Type |
|
|
93
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
94
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
95
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
96
|
-
|
|
97
|
-
## createWebhookEndpoint
|
|
98
|
-
|
|
99
|
-
Create a webhook endpoint.
|
|
100
|
-
|
|
101
|
-
**Scopes**: `webhooks:write`
|
|
102
|
-
|
|
103
|
-
### Example Usage
|
|
104
|
-
|
|
105
|
-
<!-- UsageSnippet language="typescript" operationID="webhooks:create_webhook_endpoint" method="post" path="/v1/webhooks/endpoints" -->
|
|
106
|
-
```typescript
|
|
107
|
-
import { Polar } from "@polar-sh/sdk";
|
|
108
|
-
|
|
109
|
-
const polar = new Polar({
|
|
110
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
111
|
-
});
|
|
112
|
-
|
|
113
|
-
async function run() {
|
|
114
|
-
const result = await polar.webhooks.createWebhookEndpoint({
|
|
115
|
-
url: "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
|
|
116
|
-
format: "slack",
|
|
117
|
-
events: [
|
|
118
|
-
"subscription.uncanceled",
|
|
119
|
-
],
|
|
120
|
-
organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
|
|
121
|
-
});
|
|
122
|
-
|
|
123
|
-
console.log(result);
|
|
124
|
-
}
|
|
125
|
-
|
|
126
|
-
run();
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
### Standalone function
|
|
130
|
-
|
|
131
|
-
The standalone function version of this method:
|
|
132
|
-
|
|
133
|
-
```typescript
|
|
134
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
135
|
-
import { webhooksCreateWebhookEndpoint } from "@polar-sh/sdk/funcs/webhooksCreateWebhookEndpoint.js";
|
|
136
|
-
|
|
137
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
138
|
-
// You can create one instance of it to use across an application.
|
|
139
|
-
const polar = new PolarCore({
|
|
140
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
141
|
-
});
|
|
142
|
-
|
|
143
|
-
async function run() {
|
|
144
|
-
const res = await webhooksCreateWebhookEndpoint(polar, {
|
|
145
|
-
url: "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
|
|
146
|
-
format: "slack",
|
|
147
|
-
events: [
|
|
148
|
-
"subscription.uncanceled",
|
|
149
|
-
],
|
|
150
|
-
organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
|
|
151
|
-
});
|
|
152
|
-
if (res.ok) {
|
|
153
|
-
const { value: result } = res;
|
|
154
|
-
console.log(result);
|
|
155
|
-
} else {
|
|
156
|
-
console.log("webhooksCreateWebhookEndpoint failed:", res.error);
|
|
157
|
-
}
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
run();
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
### Parameters
|
|
164
|
-
|
|
165
|
-
| Parameter | Type | Required | Description |
|
|
166
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
167
|
-
| `request` | [components.WebhookEndpointCreate](../../models/components/webhookendpointcreate.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
168
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
169
|
-
| `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. |
|
|
170
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
171
|
-
|
|
172
|
-
### Response
|
|
173
|
-
|
|
174
|
-
**Promise\<[components.WebhookEndpoint](../../models/components/webhookendpoint.md)\>**
|
|
175
|
-
|
|
176
|
-
### Errors
|
|
177
|
-
|
|
178
|
-
| Error Type | Status Code | Content Type |
|
|
179
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
180
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
181
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
182
|
-
|
|
183
|
-
## getWebhookEndpoint
|
|
184
|
-
|
|
185
|
-
Get a webhook endpoint by ID.
|
|
186
|
-
|
|
187
|
-
**Scopes**: `webhooks:read` `webhooks:write`
|
|
188
|
-
|
|
189
|
-
### Example Usage
|
|
190
|
-
|
|
191
|
-
<!-- UsageSnippet language="typescript" operationID="webhooks:get_webhook_endpoint" method="get" path="/v1/webhooks/endpoints/{id}" -->
|
|
192
|
-
```typescript
|
|
193
|
-
import { Polar } from "@polar-sh/sdk";
|
|
194
|
-
|
|
195
|
-
const polar = new Polar({
|
|
196
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
197
|
-
});
|
|
198
|
-
|
|
199
|
-
async function run() {
|
|
200
|
-
const result = await polar.webhooks.getWebhookEndpoint({
|
|
201
|
-
id: "<value>",
|
|
202
|
-
});
|
|
203
|
-
|
|
204
|
-
console.log(result);
|
|
205
|
-
}
|
|
206
|
-
|
|
207
|
-
run();
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
### Standalone function
|
|
211
|
-
|
|
212
|
-
The standalone function version of this method:
|
|
213
|
-
|
|
214
|
-
```typescript
|
|
215
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
216
|
-
import { webhooksGetWebhookEndpoint } from "@polar-sh/sdk/funcs/webhooksGetWebhookEndpoint.js";
|
|
217
|
-
|
|
218
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
219
|
-
// You can create one instance of it to use across an application.
|
|
220
|
-
const polar = new PolarCore({
|
|
221
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
222
|
-
});
|
|
223
|
-
|
|
224
|
-
async function run() {
|
|
225
|
-
const res = await webhooksGetWebhookEndpoint(polar, {
|
|
226
|
-
id: "<value>",
|
|
227
|
-
});
|
|
228
|
-
if (res.ok) {
|
|
229
|
-
const { value: result } = res;
|
|
230
|
-
console.log(result);
|
|
231
|
-
} else {
|
|
232
|
-
console.log("webhooksGetWebhookEndpoint failed:", res.error);
|
|
233
|
-
}
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
run();
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
### Parameters
|
|
240
|
-
|
|
241
|
-
| Parameter | Type | Required | Description |
|
|
242
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
243
|
-
| `request` | [operations.WebhooksGetWebhookEndpointRequest](../../models/operations/webhooksgetwebhookendpointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
244
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
245
|
-
| `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. |
|
|
246
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
247
|
-
|
|
248
|
-
### Response
|
|
249
|
-
|
|
250
|
-
**Promise\<[components.WebhookEndpoint](../../models/components/webhookendpoint.md)\>**
|
|
251
|
-
|
|
252
|
-
### Errors
|
|
253
|
-
|
|
254
|
-
| Error Type | Status Code | Content Type |
|
|
255
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
256
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
257
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
258
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
259
|
-
|
|
260
|
-
## updateWebhookEndpoint
|
|
261
|
-
|
|
262
|
-
Update a webhook endpoint.
|
|
263
|
-
|
|
264
|
-
**Scopes**: `webhooks:write`
|
|
265
|
-
|
|
266
|
-
### Example Usage
|
|
267
|
-
|
|
268
|
-
<!-- UsageSnippet language="typescript" operationID="webhooks:update_webhook_endpoint" method="patch" path="/v1/webhooks/endpoints/{id}" -->
|
|
269
|
-
```typescript
|
|
270
|
-
import { Polar } from "@polar-sh/sdk";
|
|
271
|
-
|
|
272
|
-
const polar = new Polar({
|
|
273
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
274
|
-
});
|
|
275
|
-
|
|
276
|
-
async function run() {
|
|
277
|
-
const result = await polar.webhooks.updateWebhookEndpoint({
|
|
278
|
-
id: "<value>",
|
|
279
|
-
webhookEndpointUpdate: {
|
|
280
|
-
url: "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
|
|
281
|
-
},
|
|
282
|
-
});
|
|
283
|
-
|
|
284
|
-
console.log(result);
|
|
285
|
-
}
|
|
286
|
-
|
|
287
|
-
run();
|
|
288
|
-
```
|
|
289
|
-
|
|
290
|
-
### Standalone function
|
|
291
|
-
|
|
292
|
-
The standalone function version of this method:
|
|
293
|
-
|
|
294
|
-
```typescript
|
|
295
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
296
|
-
import { webhooksUpdateWebhookEndpoint } from "@polar-sh/sdk/funcs/webhooksUpdateWebhookEndpoint.js";
|
|
297
|
-
|
|
298
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
299
|
-
// You can create one instance of it to use across an application.
|
|
300
|
-
const polar = new PolarCore({
|
|
301
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
302
|
-
});
|
|
303
|
-
|
|
304
|
-
async function run() {
|
|
305
|
-
const res = await webhooksUpdateWebhookEndpoint(polar, {
|
|
306
|
-
id: "<value>",
|
|
307
|
-
webhookEndpointUpdate: {
|
|
308
|
-
url: "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
|
|
309
|
-
},
|
|
310
|
-
});
|
|
311
|
-
if (res.ok) {
|
|
312
|
-
const { value: result } = res;
|
|
313
|
-
console.log(result);
|
|
314
|
-
} else {
|
|
315
|
-
console.log("webhooksUpdateWebhookEndpoint failed:", res.error);
|
|
316
|
-
}
|
|
317
|
-
}
|
|
318
|
-
|
|
319
|
-
run();
|
|
320
|
-
```
|
|
321
|
-
|
|
322
|
-
### Parameters
|
|
323
|
-
|
|
324
|
-
| Parameter | Type | Required | Description |
|
|
325
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
326
|
-
| `request` | [operations.WebhooksUpdateWebhookEndpointRequest](../../models/operations/webhooksupdatewebhookendpointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
327
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
328
|
-
| `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. |
|
|
329
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
330
|
-
|
|
331
|
-
### Response
|
|
332
|
-
|
|
333
|
-
**Promise\<[components.WebhookEndpoint](../../models/components/webhookendpoint.md)\>**
|
|
334
|
-
|
|
335
|
-
### Errors
|
|
336
|
-
|
|
337
|
-
| Error Type | Status Code | Content Type |
|
|
338
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
339
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
340
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
341
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
342
|
-
|
|
343
|
-
## deleteWebhookEndpoint
|
|
344
|
-
|
|
345
|
-
Delete a webhook endpoint.
|
|
346
|
-
|
|
347
|
-
**Scopes**: `webhooks:write`
|
|
348
|
-
|
|
349
|
-
### Example Usage
|
|
350
|
-
|
|
351
|
-
<!-- UsageSnippet language="typescript" operationID="webhooks:delete_webhook_endpoint" method="delete" path="/v1/webhooks/endpoints/{id}" -->
|
|
352
|
-
```typescript
|
|
353
|
-
import { Polar } from "@polar-sh/sdk";
|
|
354
|
-
|
|
355
|
-
const polar = new Polar({
|
|
356
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
357
|
-
});
|
|
358
|
-
|
|
359
|
-
async function run() {
|
|
360
|
-
await polar.webhooks.deleteWebhookEndpoint({
|
|
361
|
-
id: "<value>",
|
|
362
|
-
});
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
}
|
|
366
|
-
|
|
367
|
-
run();
|
|
368
|
-
```
|
|
369
|
-
|
|
370
|
-
### Standalone function
|
|
371
|
-
|
|
372
|
-
The standalone function version of this method:
|
|
373
|
-
|
|
374
|
-
```typescript
|
|
375
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
376
|
-
import { webhooksDeleteWebhookEndpoint } from "@polar-sh/sdk/funcs/webhooksDeleteWebhookEndpoint.js";
|
|
377
|
-
|
|
378
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
379
|
-
// You can create one instance of it to use across an application.
|
|
380
|
-
const polar = new PolarCore({
|
|
381
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
382
|
-
});
|
|
383
|
-
|
|
384
|
-
async function run() {
|
|
385
|
-
const res = await webhooksDeleteWebhookEndpoint(polar, {
|
|
386
|
-
id: "<value>",
|
|
387
|
-
});
|
|
388
|
-
if (res.ok) {
|
|
389
|
-
const { value: result } = res;
|
|
390
|
-
|
|
391
|
-
} else {
|
|
392
|
-
console.log("webhooksDeleteWebhookEndpoint failed:", res.error);
|
|
393
|
-
}
|
|
394
|
-
}
|
|
395
|
-
|
|
396
|
-
run();
|
|
397
|
-
```
|
|
398
|
-
|
|
399
|
-
### Parameters
|
|
400
|
-
|
|
401
|
-
| Parameter | Type | Required | Description |
|
|
402
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
403
|
-
| `request` | [operations.WebhooksDeleteWebhookEndpointRequest](../../models/operations/webhooksdeletewebhookendpointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
404
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
405
|
-
| `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. |
|
|
406
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
407
|
-
|
|
408
|
-
### Response
|
|
409
|
-
|
|
410
|
-
**Promise\<void\>**
|
|
411
|
-
|
|
412
|
-
### Errors
|
|
413
|
-
|
|
414
|
-
| Error Type | Status Code | Content Type |
|
|
415
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
416
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
417
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
418
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
419
|
-
|
|
420
|
-
## resetWebhookEndpointSecret
|
|
421
|
-
|
|
422
|
-
Regenerate a webhook endpoint secret.
|
|
423
|
-
|
|
424
|
-
**Scopes**: `webhooks:write`
|
|
425
|
-
|
|
426
|
-
### Example Usage
|
|
427
|
-
|
|
428
|
-
<!-- UsageSnippet language="typescript" operationID="webhooks:reset_webhook_endpoint_secret" method="patch" path="/v1/webhooks/endpoints/{id}/secret" -->
|
|
429
|
-
```typescript
|
|
430
|
-
import { Polar } from "@polar-sh/sdk";
|
|
431
|
-
|
|
432
|
-
const polar = new Polar({
|
|
433
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
434
|
-
});
|
|
435
|
-
|
|
436
|
-
async function run() {
|
|
437
|
-
const result = await polar.webhooks.resetWebhookEndpointSecret({
|
|
438
|
-
id: "<value>",
|
|
439
|
-
});
|
|
440
|
-
|
|
441
|
-
console.log(result);
|
|
442
|
-
}
|
|
443
|
-
|
|
444
|
-
run();
|
|
445
|
-
```
|
|
446
|
-
|
|
447
|
-
### Standalone function
|
|
448
|
-
|
|
449
|
-
The standalone function version of this method:
|
|
450
|
-
|
|
451
|
-
```typescript
|
|
452
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
453
|
-
import { webhooksResetWebhookEndpointSecret } from "@polar-sh/sdk/funcs/webhooksResetWebhookEndpointSecret.js";
|
|
454
|
-
|
|
455
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
456
|
-
// You can create one instance of it to use across an application.
|
|
457
|
-
const polar = new PolarCore({
|
|
458
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
459
|
-
});
|
|
460
|
-
|
|
461
|
-
async function run() {
|
|
462
|
-
const res = await webhooksResetWebhookEndpointSecret(polar, {
|
|
463
|
-
id: "<value>",
|
|
464
|
-
});
|
|
465
|
-
if (res.ok) {
|
|
466
|
-
const { value: result } = res;
|
|
467
|
-
console.log(result);
|
|
468
|
-
} else {
|
|
469
|
-
console.log("webhooksResetWebhookEndpointSecret failed:", res.error);
|
|
470
|
-
}
|
|
471
|
-
}
|
|
472
|
-
|
|
473
|
-
run();
|
|
474
|
-
```
|
|
475
|
-
|
|
476
|
-
### Parameters
|
|
477
|
-
|
|
478
|
-
| Parameter | Type | Required | Description |
|
|
479
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
480
|
-
| `request` | [operations.WebhooksResetWebhookEndpointSecretRequest](../../models/operations/webhooksresetwebhookendpointsecretrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
481
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
482
|
-
| `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. |
|
|
483
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
484
|
-
|
|
485
|
-
### Response
|
|
486
|
-
|
|
487
|
-
**Promise\<[components.WebhookEndpoint](../../models/components/webhookendpoint.md)\>**
|
|
488
|
-
|
|
489
|
-
### Errors
|
|
490
|
-
|
|
491
|
-
| Error Type | Status Code | Content Type |
|
|
492
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
493
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
494
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
495
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
496
|
-
|
|
497
|
-
## listWebhookDeliveries
|
|
498
|
-
|
|
499
|
-
List webhook deliveries.
|
|
500
|
-
|
|
501
|
-
Deliveries are all the attempts to deliver a webhook event to an endpoint.
|
|
502
|
-
|
|
503
|
-
**Scopes**: `webhooks:read` `webhooks:write`
|
|
504
|
-
|
|
505
|
-
### Example Usage
|
|
506
|
-
|
|
507
|
-
<!-- UsageSnippet language="typescript" operationID="webhooks:list_webhook_deliveries" method="get" path="/v1/webhooks/deliveries" -->
|
|
508
|
-
```typescript
|
|
509
|
-
import { Polar } from "@polar-sh/sdk";
|
|
510
|
-
|
|
511
|
-
const polar = new Polar({
|
|
512
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
513
|
-
});
|
|
514
|
-
|
|
515
|
-
async function run() {
|
|
516
|
-
const result = await polar.webhooks.listWebhookDeliveries({});
|
|
517
|
-
|
|
518
|
-
for await (const page of result) {
|
|
519
|
-
console.log(page);
|
|
520
|
-
}
|
|
521
|
-
}
|
|
522
|
-
|
|
523
|
-
run();
|
|
524
|
-
```
|
|
525
|
-
|
|
526
|
-
### Standalone function
|
|
527
|
-
|
|
528
|
-
The standalone function version of this method:
|
|
529
|
-
|
|
530
|
-
```typescript
|
|
531
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
532
|
-
import { webhooksListWebhookDeliveries } from "@polar-sh/sdk/funcs/webhooksListWebhookDeliveries.js";
|
|
533
|
-
|
|
534
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
535
|
-
// You can create one instance of it to use across an application.
|
|
536
|
-
const polar = new PolarCore({
|
|
537
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
538
|
-
});
|
|
539
|
-
|
|
540
|
-
async function run() {
|
|
541
|
-
const res = await webhooksListWebhookDeliveries(polar, {});
|
|
542
|
-
if (res.ok) {
|
|
543
|
-
const { value: result } = res;
|
|
544
|
-
for await (const page of result) {
|
|
545
|
-
console.log(page);
|
|
546
|
-
}
|
|
547
|
-
} else {
|
|
548
|
-
console.log("webhooksListWebhookDeliveries failed:", res.error);
|
|
549
|
-
}
|
|
550
|
-
}
|
|
551
|
-
|
|
552
|
-
run();
|
|
553
|
-
```
|
|
554
|
-
|
|
555
|
-
### Parameters
|
|
556
|
-
|
|
557
|
-
| Parameter | Type | Required | Description |
|
|
558
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
559
|
-
| `request` | [operations.WebhooksListWebhookDeliveriesRequest](../../models/operations/webhookslistwebhookdeliveriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
560
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
561
|
-
| `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. |
|
|
562
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
563
|
-
|
|
564
|
-
### Response
|
|
565
|
-
|
|
566
|
-
**Promise\<[operations.WebhooksListWebhookDeliveriesResponse](../../models/operations/webhookslistwebhookdeliveriesresponse.md)\>**
|
|
567
|
-
|
|
568
|
-
### Errors
|
|
569
|
-
|
|
570
|
-
| Error Type | Status Code | Content Type |
|
|
571
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
572
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
573
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
574
|
-
|
|
575
|
-
## redeliverWebhookEvent
|
|
576
|
-
|
|
577
|
-
Schedule the re-delivery of a webhook event.
|
|
578
|
-
|
|
579
|
-
**Scopes**: `webhooks:write`
|
|
580
|
-
|
|
581
|
-
### Example Usage
|
|
582
|
-
|
|
583
|
-
<!-- UsageSnippet language="typescript" operationID="webhooks:redeliver_webhook_event" method="post" path="/v1/webhooks/events/{id}/redeliver" -->
|
|
584
|
-
```typescript
|
|
585
|
-
import { Polar } from "@polar-sh/sdk";
|
|
586
|
-
|
|
587
|
-
const polar = new Polar({
|
|
588
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
589
|
-
});
|
|
590
|
-
|
|
591
|
-
async function run() {
|
|
592
|
-
const result = await polar.webhooks.redeliverWebhookEvent({
|
|
593
|
-
id: "<value>",
|
|
594
|
-
});
|
|
595
|
-
|
|
596
|
-
console.log(result);
|
|
597
|
-
}
|
|
598
|
-
|
|
599
|
-
run();
|
|
600
|
-
```
|
|
601
|
-
|
|
602
|
-
### Standalone function
|
|
603
|
-
|
|
604
|
-
The standalone function version of this method:
|
|
605
|
-
|
|
606
|
-
```typescript
|
|
607
|
-
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
608
|
-
import { webhooksRedeliverWebhookEvent } from "@polar-sh/sdk/funcs/webhooksRedeliverWebhookEvent.js";
|
|
609
|
-
|
|
610
|
-
// Use `PolarCore` for best tree-shaking performance.
|
|
611
|
-
// You can create one instance of it to use across an application.
|
|
612
|
-
const polar = new PolarCore({
|
|
613
|
-
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
|
|
614
|
-
});
|
|
615
|
-
|
|
616
|
-
async function run() {
|
|
617
|
-
const res = await webhooksRedeliverWebhookEvent(polar, {
|
|
618
|
-
id: "<value>",
|
|
619
|
-
});
|
|
620
|
-
if (res.ok) {
|
|
621
|
-
const { value: result } = res;
|
|
622
|
-
console.log(result);
|
|
623
|
-
} else {
|
|
624
|
-
console.log("webhooksRedeliverWebhookEvent failed:", res.error);
|
|
625
|
-
}
|
|
626
|
-
}
|
|
627
|
-
|
|
628
|
-
run();
|
|
629
|
-
```
|
|
630
|
-
|
|
631
|
-
### Parameters
|
|
632
|
-
|
|
633
|
-
| Parameter | Type | Required | Description |
|
|
634
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
635
|
-
| `request` | [operations.WebhooksRedeliverWebhookEventRequest](../../models/operations/webhooksredeliverwebhookeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
636
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
637
|
-
| `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. |
|
|
638
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
639
|
-
|
|
640
|
-
### Response
|
|
641
|
-
|
|
642
|
-
**Promise\<[any](../../models/.md)\>**
|
|
643
|
-
|
|
644
|
-
### Errors
|
|
645
|
-
|
|
646
|
-
| Error Type | Status Code | Content Type |
|
|
647
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
648
|
-
| errors.ResourceNotFound | 404 | application/json |
|
|
649
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
650
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|