@polar-sh/sdk 0.6.1 → 0.7.1
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 +39 -39
- package/docs/sdks/advertisements/README.md +7 -7
- package/docs/sdks/articles/README.md +12 -14
- package/docs/sdks/benefits/README.md +10 -12
- package/docs/sdks/checkouts/README.md +7 -7
- package/docs/sdks/clients/README.md +10 -10
- package/docs/sdks/downloadables/README.md +7 -7
- package/docs/sdks/externalorganizations/README.md +1 -1
- package/docs/sdks/files/README.md +4 -6
- package/docs/sdks/licensekeys/README.md +9 -9
- package/docs/sdks/metrics/README.md +13 -13
- package/docs/sdks/oauth2/README.md +4 -4
- package/docs/sdks/orders/README.md +8 -8
- package/docs/sdks/organizations/README.md +9 -9
- package/docs/sdks/polaradvertisements/README.md +10 -12
- package/docs/sdks/polarbenefits/README.md +7 -7
- package/docs/sdks/polarlicensekeys/README.md +9 -11
- package/docs/sdks/polarorders/README.md +8 -8
- package/docs/sdks/polarsubscriptions/README.md +10 -10
- package/docs/sdks/products/README.md +10 -10
- package/docs/sdks/repositories/README.md +8 -8
- package/docs/sdks/subscriptions/README.md +4 -4
- package/funcs/{organizationsRetrieve.d.ts → advertisementsGet.d.ts} +4 -4
- package/funcs/{checkoutsRetrieve.d.ts.map → advertisementsGet.d.ts.map} +1 -1
- package/funcs/{advertisementsRetrieve.js → advertisementsGet.js} +3 -3
- package/funcs/advertisementsGet.js.map +1 -0
- package/funcs/{articlesRetrieve.d.ts → articlesGet.d.ts} +2 -2
- package/funcs/articlesGet.d.ts.map +1 -0
- package/funcs/{articlesRetrieve.js → articlesGet.js} +3 -3
- package/funcs/articlesGet.js.map +1 -0
- package/funcs/{benefitsRetrieve.d.ts → benefitsGet.d.ts} +2 -2
- package/funcs/benefitsGet.d.ts.map +1 -0
- package/funcs/{benefitsRetrieve.js → benefitsGet.js} +3 -3
- package/funcs/benefitsGet.js.map +1 -0
- package/funcs/checkoutsGet.d.ts +17 -0
- package/funcs/checkoutsGet.d.ts.map +1 -0
- package/funcs/{checkoutsRetrieve.js → checkoutsGet.js} +3 -3
- package/funcs/checkoutsGet.js.map +1 -0
- package/funcs/{checkoutsRetrieve.d.ts → licenseKeysGet.d.ts} +4 -4
- package/funcs/licenseKeysGet.d.ts.map +1 -0
- package/funcs/{licenseKeysRetrieve.js → licenseKeysGet.js} +3 -3
- package/funcs/licenseKeysGet.js.map +1 -0
- package/funcs/{metricsRetrieve.d.ts → metricsGet.d.ts} +2 -2
- package/funcs/metricsGet.d.ts.map +1 -0
- package/funcs/{metricsRetrieve.js → metricsGet.js} +3 -3
- package/funcs/metricsGet.js.map +1 -0
- package/funcs/{usersAdvertisementsRetrieve.d.ts → oauth2ClientsGet.d.ts} +4 -5
- package/funcs/oauth2ClientsGet.d.ts.map +1 -0
- package/funcs/{oauth2ClientsRetrieve.js → oauth2ClientsGet.js} +3 -3
- package/funcs/oauth2ClientsGet.js.map +1 -0
- package/funcs/{ordersRetrieve.d.ts → ordersGet.d.ts} +2 -2
- package/funcs/ordersGet.d.ts.map +1 -0
- package/funcs/{ordersRetrieve.js → ordersGet.js} +3 -3
- package/funcs/ordersGet.js.map +1 -0
- package/funcs/organizationsGet.d.ts +17 -0
- package/funcs/{articlesRetrieve.d.ts.map → organizationsGet.d.ts.map} +1 -1
- package/funcs/{organizationsRetrieve.js → organizationsGet.js} +3 -3
- package/funcs/organizationsGet.js.map +1 -0
- package/funcs/{productsRetrieve.d.ts → productsGet.d.ts} +2 -2
- package/funcs/productsGet.d.ts.map +1 -0
- package/funcs/{productsRetrieve.js → productsGet.js} +3 -3
- package/funcs/productsGet.js.map +1 -0
- package/funcs/{repositoriesRetrieve.d.ts → repositoriesGet.d.ts} +2 -2
- package/funcs/{metricsRetrieve.d.ts.map → repositoriesGet.d.ts.map} +1 -1
- package/funcs/{repositoriesRetrieve.js → repositoriesGet.js} +3 -3
- package/funcs/repositoriesGet.js.map +1 -0
- package/funcs/subscriptionsImportSubscriptions.d.ts.map +1 -1
- package/funcs/subscriptionsImportSubscriptions.js +7 -0
- package/funcs/subscriptionsImportSubscriptions.js.map +1 -1
- package/funcs/{advertisementsRetrieve.d.ts → usersAdvertisementsGet.d.ts} +3 -3
- package/funcs/{advertisementsRetrieve.d.ts.map → usersAdvertisementsGet.d.ts.map} +1 -1
- package/funcs/{usersAdvertisementsRetrieve.js → usersAdvertisementsGet.js} +3 -3
- package/funcs/{advertisementsRetrieve.js.map → usersAdvertisementsGet.js.map} +1 -1
- package/funcs/{usersBenefitsRetrieve.d.ts → usersBenefitsGet.d.ts} +2 -2
- package/funcs/{benefitsRetrieve.d.ts.map → usersBenefitsGet.d.ts.map} +1 -1
- package/funcs/{usersBenefitsRetrieve.js → usersBenefitsGet.js} +3 -3
- package/funcs/usersBenefitsGet.js.map +1 -0
- package/funcs/{usersDownloadablesRetrieve.d.ts → usersDownloadablesGet.d.ts} +2 -2
- package/funcs/usersDownloadablesGet.d.ts.map +1 -0
- package/funcs/{usersDownloadablesRetrieve.js → usersDownloadablesGet.js} +3 -3
- package/funcs/usersDownloadablesGet.js.map +1 -0
- package/funcs/{licenseKeysRetrieve.d.ts → usersLicenseKeysGet.d.ts} +2 -2
- package/funcs/{licenseKeysRetrieve.d.ts.map → usersLicenseKeysGet.d.ts.map} +1 -1
- package/funcs/{usersLicenseKeysRetrieve.js → usersLicenseKeysGet.js} +3 -3
- package/funcs/{licenseKeysRetrieve.js.map → usersLicenseKeysGet.js.map} +1 -1
- package/funcs/{usersOrdersRetrieve.d.ts → usersOrdersGet.d.ts} +2 -2
- package/funcs/{ordersRetrieve.d.ts.map → usersOrdersGet.d.ts.map} +1 -1
- package/funcs/{usersOrdersRetrieve.js → usersOrdersGet.js} +3 -3
- package/funcs/usersOrdersGet.js.map +1 -0
- package/funcs/{usersSubscriptionsRetrieve.d.ts → usersSubscriptionsGet.d.ts} +2 -2
- package/funcs/{organizationsRetrieve.d.ts.map → usersSubscriptionsGet.d.ts.map} +1 -1
- package/funcs/{usersSubscriptionsRetrieve.js → usersSubscriptionsGet.js} +3 -3
- package/funcs/{organizationsRetrieve.js.map → usersSubscriptionsGet.js.map} +1 -1
- package/index.d.ts +1 -0
- package/index.d.ts.map +1 -1
- package/index.js +14 -0
- package/index.js.map +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/files.d.ts +8 -0
- package/lib/files.d.ts.map +1 -0
- package/lib/files.js +36 -0
- package/lib/files.js.map +1 -0
- package/lib/sdks.d.ts.map +1 -1
- package/lib/sdks.js +12 -0
- package/lib/sdks.js.map +1 -1
- package/models/components/bodysubscriptionsimport.d.ts +2 -2
- package/models/components/bodysubscriptionsimport.d.ts.map +1 -1
- package/models/components/bodysubscriptionsimport.js +12 -3
- package/models/components/bodysubscriptionsimport.js.map +1 -1
- package/package.json +2 -1
- package/sdk/advertisements.d.ts +1 -1
- package/sdk/advertisements.d.ts.map +1 -1
- package/sdk/advertisements.js +3 -3
- package/sdk/advertisements.js.map +1 -1
- package/sdk/articles.d.ts +1 -1
- package/sdk/articles.d.ts.map +1 -1
- package/sdk/articles.js +3 -3
- package/sdk/articles.js.map +1 -1
- package/sdk/benefits.d.ts +1 -1
- package/sdk/benefits.d.ts.map +1 -1
- package/sdk/benefits.js +3 -3
- package/sdk/benefits.js.map +1 -1
- package/sdk/checkouts.d.ts +1 -1
- package/sdk/checkouts.d.ts.map +1 -1
- package/sdk/checkouts.js +3 -3
- package/sdk/checkouts.js.map +1 -1
- package/sdk/clients.d.ts +1 -1
- package/sdk/clients.d.ts.map +1 -1
- package/sdk/clients.js +3 -3
- package/sdk/clients.js.map +1 -1
- package/sdk/downloadables.d.ts +1 -1
- package/sdk/downloadables.d.ts.map +1 -1
- package/sdk/downloadables.js +3 -3
- package/sdk/downloadables.js.map +1 -1
- package/sdk/licensekeys.d.ts +1 -1
- package/sdk/licensekeys.d.ts.map +1 -1
- package/sdk/licensekeys.js +3 -3
- package/sdk/licensekeys.js.map +1 -1
- package/sdk/metrics.d.ts +1 -1
- package/sdk/metrics.d.ts.map +1 -1
- package/sdk/metrics.js +3 -3
- package/sdk/metrics.js.map +1 -1
- package/sdk/orders.d.ts +1 -1
- package/sdk/orders.d.ts.map +1 -1
- package/sdk/orders.js +3 -3
- package/sdk/orders.js.map +1 -1
- package/sdk/organizations.d.ts +1 -1
- package/sdk/organizations.d.ts.map +1 -1
- package/sdk/organizations.js +3 -3
- package/sdk/organizations.js.map +1 -1
- package/sdk/polaradvertisements.d.ts +1 -1
- package/sdk/polaradvertisements.d.ts.map +1 -1
- package/sdk/polaradvertisements.js +3 -3
- package/sdk/polaradvertisements.js.map +1 -1
- package/sdk/polarbenefits.d.ts +1 -1
- package/sdk/polarbenefits.d.ts.map +1 -1
- package/sdk/polarbenefits.js +3 -3
- package/sdk/polarbenefits.js.map +1 -1
- package/sdk/polarlicensekeys.d.ts +1 -1
- package/sdk/polarlicensekeys.d.ts.map +1 -1
- package/sdk/polarlicensekeys.js +3 -3
- package/sdk/polarlicensekeys.js.map +1 -1
- package/sdk/polarorders.d.ts +1 -1
- package/sdk/polarorders.d.ts.map +1 -1
- package/sdk/polarorders.js +3 -3
- package/sdk/polarorders.js.map +1 -1
- package/sdk/polarsubscriptions.d.ts +1 -1
- package/sdk/polarsubscriptions.d.ts.map +1 -1
- package/sdk/polarsubscriptions.js +3 -3
- package/sdk/polarsubscriptions.js.map +1 -1
- package/sdk/products.d.ts +1 -1
- package/sdk/products.d.ts.map +1 -1
- package/sdk/products.js +3 -3
- package/sdk/products.js.map +1 -1
- package/sdk/repositories.d.ts +1 -1
- package/sdk/repositories.d.ts.map +1 -1
- package/sdk/repositories.js +3 -3
- package/sdk/repositories.js.map +1 -1
- package/src/funcs/{advertisementsRetrieve.ts → advertisementsGet.ts} +1 -1
- package/src/funcs/{articlesRetrieve.ts → articlesGet.ts} +1 -1
- package/src/funcs/{benefitsRetrieve.ts → benefitsGet.ts} +1 -1
- package/src/funcs/{checkoutsRetrieve.ts → checkoutsGet.ts} +1 -1
- package/src/funcs/{licenseKeysRetrieve.ts → licenseKeysGet.ts} +1 -1
- package/src/funcs/{metricsRetrieve.ts → metricsGet.ts} +1 -1
- package/src/funcs/{oauth2ClientsRetrieve.ts → oauth2ClientsGet.ts} +1 -1
- package/src/funcs/{ordersRetrieve.ts → ordersGet.ts} +1 -1
- package/src/funcs/{organizationsRetrieve.ts → organizationsGet.ts} +1 -1
- package/src/funcs/{productsRetrieve.ts → productsGet.ts} +1 -1
- package/src/funcs/{repositoriesRetrieve.ts → repositoriesGet.ts} +1 -1
- package/src/funcs/subscriptionsImportSubscriptions.ts +6 -0
- package/src/funcs/{usersAdvertisementsRetrieve.ts → usersAdvertisementsGet.ts} +1 -1
- package/src/funcs/{usersBenefitsRetrieve.ts → usersBenefitsGet.ts} +1 -1
- package/src/funcs/{usersDownloadablesRetrieve.ts → usersDownloadablesGet.ts} +1 -1
- package/src/funcs/{usersLicenseKeysRetrieve.ts → usersLicenseKeysGet.ts} +1 -1
- package/src/funcs/{usersOrdersRetrieve.ts → usersOrdersGet.ts} +1 -1
- package/src/funcs/{usersSubscriptionsRetrieve.ts → usersSubscriptionsGet.ts} +1 -1
- package/src/index.ts +1 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/files.ts +40 -0
- package/src/lib/sdks.ts +12 -0
- package/src/models/components/bodysubscriptionsimport.ts +14 -5
- package/src/sdk/advertisements.ts +3 -3
- package/src/sdk/articles.ts +3 -3
- package/src/sdk/benefits.ts +3 -3
- package/src/sdk/checkouts.ts +3 -3
- package/src/sdk/clients.ts +3 -3
- package/src/sdk/downloadables.ts +3 -3
- package/src/sdk/licensekeys.ts +3 -3
- package/src/sdk/metrics.ts +3 -3
- package/src/sdk/orders.ts +3 -3
- package/src/sdk/organizations.ts +3 -3
- package/src/sdk/polaradvertisements.ts +3 -3
- package/src/sdk/polarbenefits.ts +3 -3
- package/src/sdk/polarlicensekeys.ts +3 -3
- package/src/sdk/polarorders.ts +3 -3
- package/src/sdk/polarsubscriptions.ts +3 -3
- package/src/sdk/products.ts +3 -3
- package/src/sdk/repositories.ts +3 -3
- package/src/types/streams.ts +21 -0
- package/types/streams.d.ts +2 -0
- package/types/streams.d.ts.map +1 -0
- package/types/streams.js +18 -0
- package/types/streams.js.map +1 -0
- package/funcs/articlesRetrieve.js.map +0 -1
- package/funcs/benefitsRetrieve.js.map +0 -1
- package/funcs/checkoutsRetrieve.js.map +0 -1
- package/funcs/metricsRetrieve.js.map +0 -1
- package/funcs/oauth2ClientsRetrieve.d.ts +0 -16
- package/funcs/oauth2ClientsRetrieve.d.ts.map +0 -1
- package/funcs/oauth2ClientsRetrieve.js.map +0 -1
- package/funcs/ordersRetrieve.js.map +0 -1
- package/funcs/productsRetrieve.d.ts.map +0 -1
- package/funcs/productsRetrieve.js.map +0 -1
- package/funcs/repositoriesRetrieve.d.ts.map +0 -1
- package/funcs/repositoriesRetrieve.js.map +0 -1
- package/funcs/usersAdvertisementsRetrieve.d.ts.map +0 -1
- package/funcs/usersAdvertisementsRetrieve.js.map +0 -1
- package/funcs/usersBenefitsRetrieve.d.ts.map +0 -1
- package/funcs/usersBenefitsRetrieve.js.map +0 -1
- package/funcs/usersDownloadablesRetrieve.d.ts.map +0 -1
- package/funcs/usersDownloadablesRetrieve.js.map +0 -1
- package/funcs/usersLicenseKeysRetrieve.d.ts +0 -17
- package/funcs/usersLicenseKeysRetrieve.d.ts.map +0 -1
- package/funcs/usersLicenseKeysRetrieve.js.map +0 -1
- package/funcs/usersOrdersRetrieve.d.ts.map +0 -1
- package/funcs/usersOrdersRetrieve.js.map +0 -1
- package/funcs/usersSubscriptionsRetrieve.d.ts.map +0 -1
- package/funcs/usersSubscriptionsRetrieve.js.map +0 -1
package/README.md
CHANGED
|
@@ -109,19 +109,19 @@ run();
|
|
|
109
109
|
### [users.benefits](docs/sdks/polarbenefits/README.md)
|
|
110
110
|
|
|
111
111
|
* [list](docs/sdks/polarbenefits/README.md#list) - List Benefits
|
|
112
|
-
* [
|
|
112
|
+
* [get](docs/sdks/polarbenefits/README.md#get) - Get Benefit
|
|
113
113
|
|
|
114
114
|
### [users.orders](docs/sdks/polarorders/README.md)
|
|
115
115
|
|
|
116
116
|
* [list](docs/sdks/polarorders/README.md#list) - List Orders
|
|
117
|
-
* [
|
|
117
|
+
* [get](docs/sdks/polarorders/README.md#get) - Get Order
|
|
118
118
|
* [invoice](docs/sdks/polarorders/README.md#invoice) - Get Order Invoice
|
|
119
119
|
|
|
120
120
|
### [users.subscriptions](docs/sdks/polarsubscriptions/README.md)
|
|
121
121
|
|
|
122
122
|
* [list](docs/sdks/polarsubscriptions/README.md#list) - List Subscriptions
|
|
123
123
|
* [create](docs/sdks/polarsubscriptions/README.md#create) - Create Free Subscription
|
|
124
|
-
* [
|
|
124
|
+
* [get](docs/sdks/polarsubscriptions/README.md#get) - Get Subscription
|
|
125
125
|
* [update](docs/sdks/polarsubscriptions/README.md#update) - Update Subscription
|
|
126
126
|
* [cancel](docs/sdks/polarsubscriptions/README.md#cancel) - Cancel Subscription
|
|
127
127
|
|
|
@@ -129,7 +129,7 @@ run();
|
|
|
129
129
|
|
|
130
130
|
* [list](docs/sdks/polaradvertisements/README.md#list) - List Advertisements
|
|
131
131
|
* [create](docs/sdks/polaradvertisements/README.md#create) - Create Advertisement
|
|
132
|
-
* [
|
|
132
|
+
* [get](docs/sdks/polaradvertisements/README.md#get) - Get Advertisement
|
|
133
133
|
* [update](docs/sdks/polaradvertisements/README.md#update) - Update Advertisement
|
|
134
134
|
* [delete](docs/sdks/polaradvertisements/README.md#delete) - Delete Advertisement
|
|
135
135
|
* [enable](docs/sdks/polaradvertisements/README.md#enable) - Enable Advertisement
|
|
@@ -137,12 +137,12 @@ run();
|
|
|
137
137
|
### [users.downloadables](docs/sdks/downloadables/README.md)
|
|
138
138
|
|
|
139
139
|
* [list](docs/sdks/downloadables/README.md#list) - List Downloadables
|
|
140
|
-
* [
|
|
140
|
+
* [get](docs/sdks/downloadables/README.md#get) - Get Downloadable
|
|
141
141
|
|
|
142
142
|
### [users.licenseKeys](docs/sdks/polarlicensekeys/README.md)
|
|
143
143
|
|
|
144
144
|
* [list](docs/sdks/polarlicensekeys/README.md#list) - List License Keys
|
|
145
|
-
* [
|
|
145
|
+
* [get](docs/sdks/polarlicensekeys/README.md#get) - Get License Key
|
|
146
146
|
* [validate](docs/sdks/polarlicensekeys/README.md#validate) - Validate License Key
|
|
147
147
|
* [activate](docs/sdks/polarlicensekeys/README.md#activate) - Activate License Key
|
|
148
148
|
* [deactivate](docs/sdks/polarlicensekeys/README.md#deactivate) - Deactivate License Key
|
|
@@ -154,14 +154,14 @@ run();
|
|
|
154
154
|
### [repositories](docs/sdks/repositories/README.md)
|
|
155
155
|
|
|
156
156
|
* [list](docs/sdks/repositories/README.md#list) - List Repositories
|
|
157
|
-
* [
|
|
157
|
+
* [get](docs/sdks/repositories/README.md#get) - Get Repository
|
|
158
158
|
* [update](docs/sdks/repositories/README.md#update) - Update Repository
|
|
159
159
|
|
|
160
160
|
### [organizations](docs/sdks/organizations/README.md)
|
|
161
161
|
|
|
162
162
|
* [list](docs/sdks/organizations/README.md#list) - List Organizations
|
|
163
163
|
* [create](docs/sdks/organizations/README.md#create) - Create Organization
|
|
164
|
-
* [
|
|
164
|
+
* [get](docs/sdks/organizations/README.md#get) - Get Organization
|
|
165
165
|
* [update](docs/sdks/organizations/README.md#update) - Update Organization
|
|
166
166
|
|
|
167
167
|
### [subscriptions](docs/sdks/subscriptions/README.md)
|
|
@@ -175,7 +175,7 @@ run();
|
|
|
175
175
|
|
|
176
176
|
* [list](docs/sdks/articles/README.md#list) - List Articles
|
|
177
177
|
* [create](docs/sdks/articles/README.md#create) - Create Article
|
|
178
|
-
* [
|
|
178
|
+
* [get](docs/sdks/articles/README.md#get) - Get Article
|
|
179
179
|
* [update](docs/sdks/articles/README.md#update) - Update Article
|
|
180
180
|
* [delete](docs/sdks/articles/README.md#delete) - Delete Article
|
|
181
181
|
* [receivers](docs/sdks/articles/README.md#receivers) - Get Article Receivers Count
|
|
@@ -185,7 +185,7 @@ run();
|
|
|
185
185
|
### [advertisements](docs/sdks/advertisements/README.md)
|
|
186
186
|
|
|
187
187
|
* [list](docs/sdks/advertisements/README.md#list) - List Campaigns
|
|
188
|
-
* [
|
|
188
|
+
* [get](docs/sdks/advertisements/README.md#get) - Get Campaign
|
|
189
189
|
|
|
190
190
|
### [oauth2](docs/sdks/oauth2/README.md)
|
|
191
191
|
|
|
@@ -198,7 +198,7 @@ run();
|
|
|
198
198
|
|
|
199
199
|
* [list](docs/sdks/clients/README.md#list) - List Clients
|
|
200
200
|
* [create](docs/sdks/clients/README.md#create) - Create Client
|
|
201
|
-
* [
|
|
201
|
+
* [get](docs/sdks/clients/README.md#get) - Get Client
|
|
202
202
|
* [update](docs/sdks/clients/README.md#update) - Update Client
|
|
203
203
|
* [delete](docs/sdks/clients/README.md#delete) - Delete Client
|
|
204
204
|
|
|
@@ -206,7 +206,7 @@ run();
|
|
|
206
206
|
|
|
207
207
|
* [list](docs/sdks/benefits/README.md#list) - List Benefits
|
|
208
208
|
* [create](docs/sdks/benefits/README.md#create) - Create Benefit
|
|
209
|
-
* [
|
|
209
|
+
* [get](docs/sdks/benefits/README.md#get) - Get Benefit
|
|
210
210
|
* [update](docs/sdks/benefits/README.md#update) - Update Benefit
|
|
211
211
|
* [delete](docs/sdks/benefits/README.md#delete) - Delete Benefit
|
|
212
212
|
* [grants](docs/sdks/benefits/README.md#grants) - List Benefit Grants
|
|
@@ -215,20 +215,20 @@ run();
|
|
|
215
215
|
|
|
216
216
|
* [list](docs/sdks/products/README.md#list) - List Products
|
|
217
217
|
* [create](docs/sdks/products/README.md#create) - Create Product
|
|
218
|
-
* [
|
|
218
|
+
* [get](docs/sdks/products/README.md#get) - Get Product
|
|
219
219
|
* [update](docs/sdks/products/README.md#update) - Update Product
|
|
220
220
|
* [updateBenefits](docs/sdks/products/README.md#updatebenefits) - Update Product Benefits
|
|
221
221
|
|
|
222
222
|
### [orders](docs/sdks/orders/README.md)
|
|
223
223
|
|
|
224
224
|
* [list](docs/sdks/orders/README.md#list) - List Orders
|
|
225
|
-
* [
|
|
225
|
+
* [get](docs/sdks/orders/README.md#get) - Get Order
|
|
226
226
|
* [invoice](docs/sdks/orders/README.md#invoice) - Get Order Invoice
|
|
227
227
|
|
|
228
228
|
### [checkouts](docs/sdks/checkouts/README.md)
|
|
229
229
|
|
|
230
230
|
* [create](docs/sdks/checkouts/README.md#create) - Create Checkout
|
|
231
|
-
* [
|
|
231
|
+
* [get](docs/sdks/checkouts/README.md#get) - Get Checkout
|
|
232
232
|
|
|
233
233
|
### [files](docs/sdks/files/README.md)
|
|
234
234
|
|
|
@@ -240,13 +240,13 @@ run();
|
|
|
240
240
|
|
|
241
241
|
### [metrics](docs/sdks/metrics/README.md)
|
|
242
242
|
|
|
243
|
-
* [
|
|
243
|
+
* [get](docs/sdks/metrics/README.md#get) - Get Metrics
|
|
244
244
|
* [limits](docs/sdks/metrics/README.md#limits) - Get Metrics Limits
|
|
245
245
|
|
|
246
246
|
### [licenseKeys](docs/sdks/licensekeys/README.md)
|
|
247
247
|
|
|
248
248
|
* [list](docs/sdks/licensekeys/README.md#list) - List License Keys
|
|
249
|
-
* [
|
|
249
|
+
* [get](docs/sdks/licensekeys/README.md#get) - Get License Key
|
|
250
250
|
* [update](docs/sdks/licensekeys/README.md#update) - Update License Key
|
|
251
251
|
* [getActivation](docs/sdks/licensekeys/README.md#getactivation) - Get Activation
|
|
252
252
|
<!-- End Available Resources and Operations [operations] -->
|
|
@@ -266,24 +266,24 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
266
266
|
|
|
267
267
|
<summary>Available standalone functions</summary>
|
|
268
268
|
|
|
269
|
+
- [advertisementsGet](docs/sdks/advertisements/README.md#get)
|
|
269
270
|
- [advertisementsList](docs/sdks/advertisements/README.md#list)
|
|
270
|
-
- [advertisementsRetrieve](docs/sdks/advertisements/README.md#retrieve)
|
|
271
271
|
- [articlesCreate](docs/sdks/articles/README.md#create)
|
|
272
272
|
- [articlesDelete](docs/sdks/articles/README.md#delete)
|
|
273
|
+
- [articlesGet](docs/sdks/articles/README.md#get)
|
|
273
274
|
- [articlesList](docs/sdks/articles/README.md#list)
|
|
274
275
|
- [articlesPreview](docs/sdks/articles/README.md#preview)
|
|
275
276
|
- [articlesReceivers](docs/sdks/articles/README.md#receivers)
|
|
276
|
-
- [articlesRetrieve](docs/sdks/articles/README.md#retrieve)
|
|
277
277
|
- [articlesSend](docs/sdks/articles/README.md#send)
|
|
278
278
|
- [articlesUpdate](docs/sdks/articles/README.md#update)
|
|
279
279
|
- [benefitsCreate](docs/sdks/benefits/README.md#create)
|
|
280
280
|
- [benefitsDelete](docs/sdks/benefits/README.md#delete)
|
|
281
|
+
- [benefitsGet](docs/sdks/benefits/README.md#get)
|
|
281
282
|
- [benefitsGrants](docs/sdks/benefits/README.md#grants)
|
|
282
283
|
- [benefitsList](docs/sdks/benefits/README.md#list)
|
|
283
|
-
- [benefitsRetrieve](docs/sdks/benefits/README.md#retrieve)
|
|
284
284
|
- [benefitsUpdate](docs/sdks/benefits/README.md#update)
|
|
285
285
|
- [checkoutsCreate](docs/sdks/checkouts/README.md#create)
|
|
286
|
-
- [
|
|
286
|
+
- [checkoutsGet](docs/sdks/checkouts/README.md#get)
|
|
287
287
|
- [externalOrganizationsList](docs/sdks/externalorganizations/README.md#list)
|
|
288
288
|
- [filesCreate](docs/sdks/files/README.md#create)
|
|
289
289
|
- [filesDelete](docs/sdks/files/README.md#delete)
|
|
@@ -291,34 +291,34 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
291
291
|
- [filesUpdate](docs/sdks/files/README.md#update)
|
|
292
292
|
- [filesUploaded](docs/sdks/files/README.md#uploaded)
|
|
293
293
|
- [licenseKeysGetActivation](docs/sdks/licensekeys/README.md#getactivation)
|
|
294
|
+
- [licenseKeysGet](docs/sdks/licensekeys/README.md#get)
|
|
294
295
|
- [licenseKeysList](docs/sdks/licensekeys/README.md#list)
|
|
295
|
-
- [licenseKeysRetrieve](docs/sdks/licensekeys/README.md#retrieve)
|
|
296
296
|
- [licenseKeysUpdate](docs/sdks/licensekeys/README.md#update)
|
|
297
|
+
- [metricsGet](docs/sdks/metrics/README.md#get)
|
|
297
298
|
- [metricsLimits](docs/sdks/metrics/README.md#limits)
|
|
298
|
-
- [metricsRetrieve](docs/sdks/metrics/README.md#retrieve)
|
|
299
299
|
- [oauth2ClientsCreate](docs/sdks/clients/README.md#create)
|
|
300
300
|
- [oauth2ClientsDelete](docs/sdks/clients/README.md#delete)
|
|
301
|
+
- [oauth2ClientsGet](docs/sdks/clients/README.md#get)
|
|
301
302
|
- [oauth2ClientsList](docs/sdks/clients/README.md#list)
|
|
302
|
-
- [oauth2ClientsRetrieve](docs/sdks/clients/README.md#retrieve)
|
|
303
303
|
- [oauth2ClientsUpdate](docs/sdks/clients/README.md#update)
|
|
304
304
|
- [oauth2Introspect](docs/sdks/oauth2/README.md#introspect)
|
|
305
305
|
- [oauth2Revoke](docs/sdks/oauth2/README.md#revoke)
|
|
306
306
|
- [oauth2Token](docs/sdks/oauth2/README.md#token)
|
|
307
307
|
- [oauth2Userinfo](docs/sdks/oauth2/README.md#userinfo)
|
|
308
|
+
- [ordersGet](docs/sdks/orders/README.md#get)
|
|
308
309
|
- [ordersInvoice](docs/sdks/orders/README.md#invoice)
|
|
309
310
|
- [ordersList](docs/sdks/orders/README.md#list)
|
|
310
|
-
- [ordersRetrieve](docs/sdks/orders/README.md#retrieve)
|
|
311
311
|
- [organizationsCreate](docs/sdks/organizations/README.md#create)
|
|
312
|
+
- [organizationsGet](docs/sdks/organizations/README.md#get)
|
|
312
313
|
- [organizationsList](docs/sdks/organizations/README.md#list)
|
|
313
|
-
- [organizationsRetrieve](docs/sdks/organizations/README.md#retrieve)
|
|
314
314
|
- [organizationsUpdate](docs/sdks/organizations/README.md#update)
|
|
315
315
|
- [productsCreate](docs/sdks/products/README.md#create)
|
|
316
|
+
- [productsGet](docs/sdks/products/README.md#get)
|
|
316
317
|
- [productsList](docs/sdks/products/README.md#list)
|
|
317
|
-
- [productsRetrieve](docs/sdks/products/README.md#retrieve)
|
|
318
318
|
- [productsUpdateBenefits](docs/sdks/products/README.md#updatebenefits)
|
|
319
319
|
- [productsUpdate](docs/sdks/products/README.md#update)
|
|
320
|
+
- [repositoriesGet](docs/sdks/repositories/README.md#get)
|
|
320
321
|
- [repositoriesList](docs/sdks/repositories/README.md#list)
|
|
321
|
-
- [repositoriesRetrieve](docs/sdks/repositories/README.md#retrieve)
|
|
322
322
|
- [repositoriesUpdate](docs/sdks/repositories/README.md#update)
|
|
323
323
|
- [subscriptionsCreate](docs/sdks/subscriptions/README.md#create)
|
|
324
324
|
- [subscriptionsExport](docs/sdks/subscriptions/README.md#export)
|
|
@@ -327,25 +327,25 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
327
327
|
- [usersAdvertisementsCreate](docs/sdks/polaradvertisements/README.md#create)
|
|
328
328
|
- [usersAdvertisementsDelete](docs/sdks/polaradvertisements/README.md#delete)
|
|
329
329
|
- [usersAdvertisementsEnable](docs/sdks/polaradvertisements/README.md#enable)
|
|
330
|
+
- [usersAdvertisementsGet](docs/sdks/polaradvertisements/README.md#get)
|
|
330
331
|
- [usersAdvertisementsList](docs/sdks/polaradvertisements/README.md#list)
|
|
331
|
-
- [usersAdvertisementsRetrieve](docs/sdks/polaradvertisements/README.md#retrieve)
|
|
332
332
|
- [usersAdvertisementsUpdate](docs/sdks/polaradvertisements/README.md#update)
|
|
333
|
+
- [usersBenefitsGet](docs/sdks/polarbenefits/README.md#get)
|
|
333
334
|
- [usersBenefitsList](docs/sdks/polarbenefits/README.md#list)
|
|
334
|
-
- [
|
|
335
|
+
- [usersDownloadablesGet](docs/sdks/downloadables/README.md#get)
|
|
335
336
|
- [usersDownloadablesList](docs/sdks/downloadables/README.md#list)
|
|
336
|
-
- [usersDownloadablesRetrieve](docs/sdks/downloadables/README.md#retrieve)
|
|
337
337
|
- [usersLicenseKeysActivate](docs/sdks/polarlicensekeys/README.md#activate)
|
|
338
338
|
- [usersLicenseKeysDeactivate](docs/sdks/polarlicensekeys/README.md#deactivate)
|
|
339
|
+
- [usersLicenseKeysGet](docs/sdks/polarlicensekeys/README.md#get)
|
|
339
340
|
- [usersLicenseKeysList](docs/sdks/polarlicensekeys/README.md#list)
|
|
340
|
-
- [usersLicenseKeysRetrieve](docs/sdks/polarlicensekeys/README.md#retrieve)
|
|
341
341
|
- [usersLicenseKeysValidate](docs/sdks/polarlicensekeys/README.md#validate)
|
|
342
|
+
- [usersOrdersGet](docs/sdks/polarorders/README.md#get)
|
|
342
343
|
- [usersOrdersInvoice](docs/sdks/polarorders/README.md#invoice)
|
|
343
344
|
- [usersOrdersList](docs/sdks/polarorders/README.md#list)
|
|
344
|
-
- [usersOrdersRetrieve](docs/sdks/polarorders/README.md#retrieve)
|
|
345
345
|
- [usersSubscriptionsCancel](docs/sdks/polarsubscriptions/README.md#cancel)
|
|
346
346
|
- [usersSubscriptionsCreate](docs/sdks/polarsubscriptions/README.md#create)
|
|
347
|
+
- [usersSubscriptionsGet](docs/sdks/polarsubscriptions/README.md#get)
|
|
347
348
|
- [usersSubscriptionsList](docs/sdks/polarsubscriptions/README.md#list)
|
|
348
|
-
- [usersSubscriptionsRetrieve](docs/sdks/polarsubscriptions/README.md#retrieve)
|
|
349
349
|
- [usersSubscriptionsUpdate](docs/sdks/polarsubscriptions/README.md#update)
|
|
350
350
|
|
|
351
351
|
|
|
@@ -519,6 +519,11 @@ async function run() {
|
|
|
519
519
|
let result;
|
|
520
520
|
try {
|
|
521
521
|
result = await polar.users.benefits.list({});
|
|
522
|
+
|
|
523
|
+
for await (const page of result) {
|
|
524
|
+
// Handle the page
|
|
525
|
+
console.log(page);
|
|
526
|
+
}
|
|
522
527
|
} catch (err) {
|
|
523
528
|
switch (true) {
|
|
524
529
|
case err instanceof SDKValidationError: {
|
|
@@ -538,11 +543,6 @@ async function run() {
|
|
|
538
543
|
}
|
|
539
544
|
}
|
|
540
545
|
}
|
|
541
|
-
|
|
542
|
-
for await (const page of result) {
|
|
543
|
-
// Handle the page
|
|
544
|
-
console.log(page);
|
|
545
|
-
}
|
|
546
546
|
}
|
|
547
547
|
|
|
548
548
|
run();
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
8
|
* [list](#list) - List Campaigns
|
|
9
|
-
* [
|
|
9
|
+
* [get](#get) - Get Campaign
|
|
10
10
|
|
|
11
11
|
## list
|
|
12
12
|
|
|
@@ -25,7 +25,7 @@ async function run() {
|
|
|
25
25
|
const result = await polar.advertisements.list({
|
|
26
26
|
benefitId: "<value>",
|
|
27
27
|
});
|
|
28
|
-
|
|
28
|
+
|
|
29
29
|
for await (const page of result) {
|
|
30
30
|
// Handle the page
|
|
31
31
|
console.log(page);
|
|
@@ -90,7 +90,7 @@ run();
|
|
|
90
90
|
| errors.SDKError | 4xx-5xx | */* |
|
|
91
91
|
|
|
92
92
|
|
|
93
|
-
##
|
|
93
|
+
## get
|
|
94
94
|
|
|
95
95
|
Get an advertisement campaign by ID.
|
|
96
96
|
|
|
@@ -104,10 +104,10 @@ const polar = new Polar({
|
|
|
104
104
|
});
|
|
105
105
|
|
|
106
106
|
async function run() {
|
|
107
|
-
const result = await polar.advertisements.
|
|
107
|
+
const result = await polar.advertisements.get({
|
|
108
108
|
id: "<value>",
|
|
109
109
|
});
|
|
110
|
-
|
|
110
|
+
|
|
111
111
|
// Handle the result
|
|
112
112
|
console.log(result)
|
|
113
113
|
}
|
|
@@ -121,7 +121,7 @@ The standalone function version of this method:
|
|
|
121
121
|
|
|
122
122
|
```typescript
|
|
123
123
|
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
124
|
-
import {
|
|
124
|
+
import { advertisementsGet } from "@polar-sh/sdk/funcs/advertisementsGet.js";
|
|
125
125
|
|
|
126
126
|
// Use `PolarCore` for best tree-shaking performance.
|
|
127
127
|
// You can create one instance of it to use across an application.
|
|
@@ -130,7 +130,7 @@ const polar = new PolarCore({
|
|
|
130
130
|
});
|
|
131
131
|
|
|
132
132
|
async function run() {
|
|
133
|
-
const res = await
|
|
133
|
+
const res = await advertisementsGet(polar, {
|
|
134
134
|
id: "<value>",
|
|
135
135
|
});
|
|
136
136
|
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
* [list](#list) - List Articles
|
|
9
9
|
* [create](#create) - Create Article
|
|
10
|
-
* [
|
|
10
|
+
* [get](#get) - Get Article
|
|
11
11
|
* [update](#update) - Update Article
|
|
12
12
|
* [delete](#delete) - Delete Article
|
|
13
13
|
* [receivers](#receivers) - Get Article Receivers Count
|
|
@@ -29,7 +29,7 @@ const polar = new Polar({
|
|
|
29
29
|
|
|
30
30
|
async function run() {
|
|
31
31
|
const result = await polar.articles.list({});
|
|
32
|
-
|
|
32
|
+
|
|
33
33
|
for await (const page of result) {
|
|
34
34
|
// Handle the page
|
|
35
35
|
console.log(page);
|
|
@@ -109,7 +109,7 @@ async function run() {
|
|
|
109
109
|
const result = await polar.articles.create({
|
|
110
110
|
title: "<value>",
|
|
111
111
|
});
|
|
112
|
-
|
|
112
|
+
|
|
113
113
|
// Handle the result
|
|
114
114
|
console.log(result)
|
|
115
115
|
}
|
|
@@ -170,7 +170,7 @@ run();
|
|
|
170
170
|
| errors.SDKError | 4xx-5xx | */* |
|
|
171
171
|
|
|
172
172
|
|
|
173
|
-
##
|
|
173
|
+
## get
|
|
174
174
|
|
|
175
175
|
Get an article by ID.
|
|
176
176
|
|
|
@@ -184,10 +184,10 @@ const polar = new Polar({
|
|
|
184
184
|
});
|
|
185
185
|
|
|
186
186
|
async function run() {
|
|
187
|
-
const result = await polar.articles.
|
|
187
|
+
const result = await polar.articles.get({
|
|
188
188
|
id: "<value>",
|
|
189
189
|
});
|
|
190
|
-
|
|
190
|
+
|
|
191
191
|
// Handle the result
|
|
192
192
|
console.log(result)
|
|
193
193
|
}
|
|
@@ -201,7 +201,7 @@ The standalone function version of this method:
|
|
|
201
201
|
|
|
202
202
|
```typescript
|
|
203
203
|
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
204
|
-
import {
|
|
204
|
+
import { articlesGet } from "@polar-sh/sdk/funcs/articlesGet.js";
|
|
205
205
|
|
|
206
206
|
// Use `PolarCore` for best tree-shaking performance.
|
|
207
207
|
// You can create one instance of it to use across an application.
|
|
@@ -210,7 +210,7 @@ const polar = new PolarCore({
|
|
|
210
210
|
});
|
|
211
211
|
|
|
212
212
|
async function run() {
|
|
213
|
-
const res = await
|
|
213
|
+
const res = await articlesGet(polar, {
|
|
214
214
|
id: "<value>",
|
|
215
215
|
});
|
|
216
216
|
|
|
@@ -267,7 +267,7 @@ async function run() {
|
|
|
267
267
|
id: "<value>",
|
|
268
268
|
articleUpdate: {},
|
|
269
269
|
});
|
|
270
|
-
|
|
270
|
+
|
|
271
271
|
// Handle the result
|
|
272
272
|
console.log(result)
|
|
273
273
|
}
|
|
@@ -348,8 +348,6 @@ async function run() {
|
|
|
348
348
|
await polar.articles.delete({
|
|
349
349
|
id: "<value>",
|
|
350
350
|
});
|
|
351
|
-
|
|
352
|
-
|
|
353
351
|
}
|
|
354
352
|
|
|
355
353
|
run();
|
|
@@ -426,7 +424,7 @@ async function run() {
|
|
|
426
424
|
const result = await polar.articles.receivers({
|
|
427
425
|
id: "<value>",
|
|
428
426
|
});
|
|
429
|
-
|
|
427
|
+
|
|
430
428
|
// Handle the result
|
|
431
429
|
console.log(result)
|
|
432
430
|
}
|
|
@@ -507,7 +505,7 @@ async function run() {
|
|
|
507
505
|
email: "Eileen56@yahoo.com",
|
|
508
506
|
},
|
|
509
507
|
});
|
|
510
|
-
|
|
508
|
+
|
|
511
509
|
// Handle the result
|
|
512
510
|
console.log(result)
|
|
513
511
|
}
|
|
@@ -590,7 +588,7 @@ async function run() {
|
|
|
590
588
|
const result = await polar.articles.send({
|
|
591
589
|
id: "<value>",
|
|
592
590
|
});
|
|
593
|
-
|
|
591
|
+
|
|
594
592
|
// Handle the result
|
|
595
593
|
console.log(result)
|
|
596
594
|
}
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
* [list](#list) - List Benefits
|
|
9
9
|
* [create](#create) - Create Benefit
|
|
10
|
-
* [
|
|
10
|
+
* [get](#get) - Get Benefit
|
|
11
11
|
* [update](#update) - Update Benefit
|
|
12
12
|
* [delete](#delete) - Delete Benefit
|
|
13
13
|
* [grants](#grants) - List Benefit Grants
|
|
@@ -27,7 +27,7 @@ const polar = new Polar({
|
|
|
27
27
|
|
|
28
28
|
async function run() {
|
|
29
29
|
const result = await polar.benefits.list({});
|
|
30
|
-
|
|
30
|
+
|
|
31
31
|
for await (const page of result) {
|
|
32
32
|
// Handle the page
|
|
33
33
|
console.log(page);
|
|
@@ -111,7 +111,7 @@ async function run() {
|
|
|
111
111
|
roleId: "<value>",
|
|
112
112
|
},
|
|
113
113
|
});
|
|
114
|
-
|
|
114
|
+
|
|
115
115
|
// Handle the result
|
|
116
116
|
console.log(result)
|
|
117
117
|
}
|
|
@@ -176,7 +176,7 @@ run();
|
|
|
176
176
|
| errors.SDKError | 4xx-5xx | */* |
|
|
177
177
|
|
|
178
178
|
|
|
179
|
-
##
|
|
179
|
+
## get
|
|
180
180
|
|
|
181
181
|
Get a benefit by ID.
|
|
182
182
|
|
|
@@ -190,10 +190,10 @@ const polar = new Polar({
|
|
|
190
190
|
});
|
|
191
191
|
|
|
192
192
|
async function run() {
|
|
193
|
-
const result = await polar.benefits.
|
|
193
|
+
const result = await polar.benefits.get({
|
|
194
194
|
id: "<value>",
|
|
195
195
|
});
|
|
196
|
-
|
|
196
|
+
|
|
197
197
|
// Handle the result
|
|
198
198
|
console.log(result)
|
|
199
199
|
}
|
|
@@ -207,7 +207,7 @@ The standalone function version of this method:
|
|
|
207
207
|
|
|
208
208
|
```typescript
|
|
209
209
|
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
210
|
-
import {
|
|
210
|
+
import { benefitsGet } from "@polar-sh/sdk/funcs/benefitsGet.js";
|
|
211
211
|
|
|
212
212
|
// Use `PolarCore` for best tree-shaking performance.
|
|
213
213
|
// You can create one instance of it to use across an application.
|
|
@@ -216,7 +216,7 @@ const polar = new PolarCore({
|
|
|
216
216
|
});
|
|
217
217
|
|
|
218
218
|
async function run() {
|
|
219
|
-
const res = await
|
|
219
|
+
const res = await benefitsGet(polar, {
|
|
220
220
|
id: "<value>",
|
|
221
221
|
});
|
|
222
222
|
|
|
@@ -273,7 +273,7 @@ async function run() {
|
|
|
273
273
|
id: "<value>",
|
|
274
274
|
requestBody: {},
|
|
275
275
|
});
|
|
276
|
-
|
|
276
|
+
|
|
277
277
|
// Handle the result
|
|
278
278
|
console.log(result)
|
|
279
279
|
}
|
|
@@ -364,8 +364,6 @@ async function run() {
|
|
|
364
364
|
await polar.benefits.delete({
|
|
365
365
|
id: "<value>",
|
|
366
366
|
});
|
|
367
|
-
|
|
368
|
-
|
|
369
367
|
}
|
|
370
368
|
|
|
371
369
|
run();
|
|
@@ -444,7 +442,7 @@ async function run() {
|
|
|
444
442
|
const result = await polar.benefits.grants({
|
|
445
443
|
id: "<value>",
|
|
446
444
|
});
|
|
447
|
-
|
|
445
|
+
|
|
448
446
|
for await (const page of result) {
|
|
449
447
|
// Handle the page
|
|
450
448
|
console.log(page);
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
8
|
* [create](#create) - Create Checkout
|
|
9
|
-
* [
|
|
9
|
+
* [get](#get) - Get Checkout
|
|
10
10
|
|
|
11
11
|
## create
|
|
12
12
|
|
|
@@ -26,7 +26,7 @@ async function run() {
|
|
|
26
26
|
productPriceId: "<value>",
|
|
27
27
|
successUrl: "http://limp-pastry.org",
|
|
28
28
|
});
|
|
29
|
-
|
|
29
|
+
|
|
30
30
|
// Handle the result
|
|
31
31
|
console.log(result)
|
|
32
32
|
}
|
|
@@ -88,7 +88,7 @@ run();
|
|
|
88
88
|
| errors.SDKError | 4xx-5xx | */* |
|
|
89
89
|
|
|
90
90
|
|
|
91
|
-
##
|
|
91
|
+
## get
|
|
92
92
|
|
|
93
93
|
Get an active checkout session by ID.
|
|
94
94
|
|
|
@@ -102,10 +102,10 @@ const polar = new Polar({
|
|
|
102
102
|
});
|
|
103
103
|
|
|
104
104
|
async function run() {
|
|
105
|
-
const result = await polar.checkouts.
|
|
105
|
+
const result = await polar.checkouts.get({
|
|
106
106
|
id: "<id>",
|
|
107
107
|
});
|
|
108
|
-
|
|
108
|
+
|
|
109
109
|
// Handle the result
|
|
110
110
|
console.log(result)
|
|
111
111
|
}
|
|
@@ -119,7 +119,7 @@ The standalone function version of this method:
|
|
|
119
119
|
|
|
120
120
|
```typescript
|
|
121
121
|
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
122
|
-
import {
|
|
122
|
+
import { checkoutsGet } from "@polar-sh/sdk/funcs/checkoutsGet.js";
|
|
123
123
|
|
|
124
124
|
// Use `PolarCore` for best tree-shaking performance.
|
|
125
125
|
// You can create one instance of it to use across an application.
|
|
@@ -128,7 +128,7 @@ const polar = new PolarCore({
|
|
|
128
128
|
});
|
|
129
129
|
|
|
130
130
|
async function run() {
|
|
131
|
-
const res = await
|
|
131
|
+
const res = await checkoutsGet(polar, {
|
|
132
132
|
id: "<id>",
|
|
133
133
|
});
|
|
134
134
|
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
* [list](#list) - List Clients
|
|
9
9
|
* [create](#create) - Create Client
|
|
10
|
-
* [
|
|
10
|
+
* [get](#get) - Get Client
|
|
11
11
|
* [update](#update) - Update Client
|
|
12
12
|
* [delete](#delete) - Delete Client
|
|
13
13
|
|
|
@@ -26,7 +26,7 @@ const polar = new Polar({
|
|
|
26
26
|
|
|
27
27
|
async function run() {
|
|
28
28
|
const result = await polar.oauth2.clients.list({});
|
|
29
|
-
|
|
29
|
+
|
|
30
30
|
for await (const page of result) {
|
|
31
31
|
// Handle the page
|
|
32
32
|
console.log(page);
|
|
@@ -109,7 +109,7 @@ async function run() {
|
|
|
109
109
|
],
|
|
110
110
|
clientName: "<value>",
|
|
111
111
|
});
|
|
112
|
-
|
|
112
|
+
|
|
113
113
|
// Handle the result
|
|
114
114
|
console.log(result)
|
|
115
115
|
}
|
|
@@ -173,7 +173,7 @@ run();
|
|
|
173
173
|
| errors.SDKError | 4xx-5xx | */* |
|
|
174
174
|
|
|
175
175
|
|
|
176
|
-
##
|
|
176
|
+
## get
|
|
177
177
|
|
|
178
178
|
Get an OAuth2 client by Client ID.
|
|
179
179
|
|
|
@@ -187,10 +187,10 @@ const polar = new Polar({
|
|
|
187
187
|
});
|
|
188
188
|
|
|
189
189
|
async function run() {
|
|
190
|
-
const result = await polar.oauth2.clients.
|
|
190
|
+
const result = await polar.oauth2.clients.get({
|
|
191
191
|
clientId: "<value>",
|
|
192
192
|
});
|
|
193
|
-
|
|
193
|
+
|
|
194
194
|
// Handle the result
|
|
195
195
|
console.log(result)
|
|
196
196
|
}
|
|
@@ -204,7 +204,7 @@ The standalone function version of this method:
|
|
|
204
204
|
|
|
205
205
|
```typescript
|
|
206
206
|
import { PolarCore } from "@polar-sh/sdk/core.js";
|
|
207
|
-
import {
|
|
207
|
+
import { oauth2ClientsGet } from "@polar-sh/sdk/funcs/oauth2ClientsGet.js";
|
|
208
208
|
|
|
209
209
|
// Use `PolarCore` for best tree-shaking performance.
|
|
210
210
|
// You can create one instance of it to use across an application.
|
|
@@ -213,7 +213,7 @@ const polar = new PolarCore({
|
|
|
213
213
|
});
|
|
214
214
|
|
|
215
215
|
async function run() {
|
|
216
|
-
const res = await
|
|
216
|
+
const res = await oauth2ClientsGet(polar, {
|
|
217
217
|
clientId: "<value>",
|
|
218
218
|
});
|
|
219
219
|
|
|
@@ -275,7 +275,7 @@ async function run() {
|
|
|
275
275
|
clientId: "<value>",
|
|
276
276
|
},
|
|
277
277
|
});
|
|
278
|
-
|
|
278
|
+
|
|
279
279
|
// Handle the result
|
|
280
280
|
console.log(result)
|
|
281
281
|
}
|
|
@@ -360,7 +360,7 @@ async function run() {
|
|
|
360
360
|
const result = await polar.oauth2.clients.delete({
|
|
361
361
|
clientId: "<value>",
|
|
362
362
|
});
|
|
363
|
-
|
|
363
|
+
|
|
364
364
|
// Handle the result
|
|
365
365
|
console.log(result)
|
|
366
366
|
}
|