@iblai/iblai-api 4.194.2-core → 4.195.0-core
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/dist/index.cjs.js +1163 -185
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +1163 -186
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +1163 -185
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +18 -1
- package/dist/types/models/CheckoutSessionCreate.d.ts +6 -0
- package/dist/types/models/CheckoutSessionResponse.d.ts +13 -0
- package/dist/types/models/GrandfatheringStrategyEnum.d.ts +8 -0
- package/dist/types/models/IntervalEnum.d.ts +10 -0
- package/dist/types/models/ItemAccessCheckResponse.d.ts +7 -2
- package/dist/types/models/ItemPaywallConfig.d.ts +52 -0
- package/dist/types/models/ItemPaywallConfigCreate.d.ts +8 -0
- package/dist/types/models/ItemPrice.d.ts +46 -0
- package/dist/types/models/ItemPriceCreate.d.ts +36 -0
- package/dist/types/models/ItemSubscription.d.ts +67 -0
- package/dist/types/models/ItemSubscriptionList.d.ts +34 -0
- package/dist/types/models/ItemType5d7Enum.d.ts +10 -0
- package/dist/types/models/{ItemAccessCheckResponseItemTypeEnum.d.ts → ItemTypeC6bEnum.d.ts} +1 -1
- package/dist/types/models/PaginatedItemSubscriptionList.d.ts +7 -0
- package/dist/types/models/PaginatedItemSubscriptionListList.d.ts +7 -0
- package/dist/types/models/PortalUrlResponse.d.ts +9 -0
- package/dist/types/models/PublicItemPricing.d.ts +11 -0
- package/dist/types/models/Status0e3Enum.d.ts +18 -0
- package/dist/types/services/BillingService.d.ts +271 -0
- package/dist/types/services/PlatformsService.d.ts +275 -0
- package/package.json +1 -1
- package/sdk_schema.yml +7861 -5691
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +18 -1
- package/src/models/CheckoutSessionCreate.ts +11 -0
- package/src/models/CheckoutSessionResponse.ts +18 -0
- package/src/models/GrandfatheringStrategyEnum.ts +12 -0
- package/src/models/IntervalEnum.ts +14 -0
- package/src/models/ItemAccessCheckResponse.ts +7 -2
- package/src/models/ItemPaywallConfig.ts +57 -0
- package/src/models/ItemPaywallConfigCreate.ts +13 -0
- package/src/models/ItemPrice.ts +51 -0
- package/src/models/ItemPriceCreate.ts +41 -0
- package/src/models/ItemSubscription.ts +72 -0
- package/src/models/ItemSubscriptionList.ts +39 -0
- package/src/models/ItemType5d7Enum.ts +14 -0
- package/src/models/{ItemAccessCheckResponseItemTypeEnum.ts → ItemTypeC6bEnum.ts} +1 -1
- package/src/models/PaginatedItemSubscriptionList.ts +12 -0
- package/src/models/PaginatedItemSubscriptionListList.ts +12 -0
- package/src/models/PortalUrlResponse.ts +14 -0
- package/src/models/PublicItemPricing.ts +16 -0
- package/src/models/Status0e3Enum.ts +22 -0
- package/src/services/BillingService.ts +591 -0
- package/src/services/PlatformsService.ts +601 -0
package/dist/index.cjs.js
CHANGED
|
@@ -110,7 +110,7 @@ class CancelablePromise {
|
|
|
110
110
|
|
|
111
111
|
const OpenAPI = {
|
|
112
112
|
BASE: 'https://base.manager.iblai.app',
|
|
113
|
-
VERSION: '4.
|
|
113
|
+
VERSION: '4.195.0-core',
|
|
114
114
|
WITH_CREDENTIALS: false,
|
|
115
115
|
CREDENTIALS: 'include',
|
|
116
116
|
TOKEN: undefined,
|
|
@@ -243,6 +243,20 @@ exports.GooglePayAccountResponseStatusEnum = void 0;
|
|
|
243
243
|
GooglePayAccountResponseStatusEnum["ACCOUNT_PENDING"] = "ACCOUNT_PENDING";
|
|
244
244
|
})(exports.GooglePayAccountResponseStatusEnum || (exports.GooglePayAccountResponseStatusEnum = {}));
|
|
245
245
|
|
|
246
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
247
|
+
/* istanbul ignore file */
|
|
248
|
+
/* tslint:disable */
|
|
249
|
+
/* eslint-disable */
|
|
250
|
+
/**
|
|
251
|
+
* * `free_forever` - Free Forever - Existing users get unlimited free access
|
|
252
|
+
* * `require_subscription` - Require Subscription - All users must subscribe (no grandfathering)
|
|
253
|
+
*/
|
|
254
|
+
exports.GrandfatheringStrategyEnum = void 0;
|
|
255
|
+
(function (GrandfatheringStrategyEnum) {
|
|
256
|
+
GrandfatheringStrategyEnum["FREE_FOREVER"] = "free_forever";
|
|
257
|
+
GrandfatheringStrategyEnum["REQUIRE_SUBSCRIPTION"] = "require_subscription";
|
|
258
|
+
})(exports.GrandfatheringStrategyEnum || (exports.GrandfatheringStrategyEnum = {}));
|
|
259
|
+
|
|
246
260
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
247
261
|
/* istanbul ignore file */
|
|
248
262
|
/* tslint:disable */
|
|
@@ -281,6 +295,38 @@ exports.InstitutionTypeEnum = void 0;
|
|
|
281
295
|
InstitutionTypeEnum["OTHER"] = "other";
|
|
282
296
|
})(exports.InstitutionTypeEnum || (exports.InstitutionTypeEnum = {}));
|
|
283
297
|
|
|
298
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
299
|
+
/* istanbul ignore file */
|
|
300
|
+
/* tslint:disable */
|
|
301
|
+
/* eslint-disable */
|
|
302
|
+
/**
|
|
303
|
+
* * `month` - Monthly
|
|
304
|
+
* * `year` - Yearly
|
|
305
|
+
* * `one_time` - One Time
|
|
306
|
+
*/
|
|
307
|
+
exports.IntervalEnum = void 0;
|
|
308
|
+
(function (IntervalEnum) {
|
|
309
|
+
IntervalEnum["MONTH"] = "month";
|
|
310
|
+
IntervalEnum["YEAR"] = "year";
|
|
311
|
+
IntervalEnum["ONE_TIME"] = "one_time";
|
|
312
|
+
})(exports.IntervalEnum || (exports.IntervalEnum = {}));
|
|
313
|
+
|
|
314
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
315
|
+
/* istanbul ignore file */
|
|
316
|
+
/* tslint:disable */
|
|
317
|
+
/* eslint-disable */
|
|
318
|
+
/**
|
|
319
|
+
* * `mentor` - Mentor
|
|
320
|
+
* * `course` - Course
|
|
321
|
+
* * `program` - Program
|
|
322
|
+
*/
|
|
323
|
+
exports.ItemType5d7Enum = void 0;
|
|
324
|
+
(function (ItemType5d7Enum) {
|
|
325
|
+
ItemType5d7Enum["MENTOR"] = "mentor";
|
|
326
|
+
ItemType5d7Enum["COURSE"] = "course";
|
|
327
|
+
ItemType5d7Enum["PROGRAM"] = "program";
|
|
328
|
+
})(exports.ItemType5d7Enum || (exports.ItemType5d7Enum = {}));
|
|
329
|
+
|
|
284
330
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
285
331
|
/* istanbul ignore file */
|
|
286
332
|
/* tslint:disable */
|
|
@@ -290,12 +336,12 @@ exports.InstitutionTypeEnum = void 0;
|
|
|
290
336
|
* * `course` - course
|
|
291
337
|
* * `program` - program
|
|
292
338
|
*/
|
|
293
|
-
exports.
|
|
294
|
-
(function (
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
})(exports.
|
|
339
|
+
exports.ItemTypeC6bEnum = void 0;
|
|
340
|
+
(function (ItemTypeC6bEnum) {
|
|
341
|
+
ItemTypeC6bEnum["MENTOR"] = "mentor";
|
|
342
|
+
ItemTypeC6bEnum["COURSE"] = "course";
|
|
343
|
+
ItemTypeC6bEnum["PROGRAM"] = "program";
|
|
344
|
+
})(exports.ItemTypeC6bEnum || (exports.ItemTypeC6bEnum = {}));
|
|
299
345
|
|
|
300
346
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
301
347
|
/* istanbul ignore file */
|
|
@@ -511,6 +557,30 @@ exports.StateEnum = void 0;
|
|
|
511
557
|
StateEnum["EXPIRED"] = "expired";
|
|
512
558
|
})(exports.StateEnum || (exports.StateEnum = {}));
|
|
513
559
|
|
|
560
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
561
|
+
/* istanbul ignore file */
|
|
562
|
+
/* tslint:disable */
|
|
563
|
+
/* eslint-disable */
|
|
564
|
+
/**
|
|
565
|
+
* * `active` - Active
|
|
566
|
+
* * `free` - Free Tier
|
|
567
|
+
* * `grandfathered` - Grandfathered
|
|
568
|
+
* * `trialing` - Trialing
|
|
569
|
+
* * `past_due` - Past Due
|
|
570
|
+
* * `canceled` - Canceled
|
|
571
|
+
* * `incomplete` - Incomplete
|
|
572
|
+
*/
|
|
573
|
+
exports.Status0e3Enum = void 0;
|
|
574
|
+
(function (Status0e3Enum) {
|
|
575
|
+
Status0e3Enum["ACTIVE"] = "active";
|
|
576
|
+
Status0e3Enum["FREE"] = "free";
|
|
577
|
+
Status0e3Enum["GRANDFATHERED"] = "grandfathered";
|
|
578
|
+
Status0e3Enum["TRIALING"] = "trialing";
|
|
579
|
+
Status0e3Enum["PAST_DUE"] = "past_due";
|
|
580
|
+
Status0e3Enum["CANCELED"] = "canceled";
|
|
581
|
+
Status0e3Enum["INCOMPLETE"] = "incomplete";
|
|
582
|
+
})(exports.Status0e3Enum || (exports.Status0e3Enum = {}));
|
|
583
|
+
|
|
514
584
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
515
585
|
/* istanbul ignore file */
|
|
516
586
|
/* tslint:disable */
|
|
@@ -4712,260 +4782,495 @@ class BillingService {
|
|
|
4712
4782
|
});
|
|
4713
4783
|
}
|
|
4714
4784
|
/**
|
|
4715
|
-
*
|
|
4716
|
-
*
|
|
4717
|
-
* @returns CreditTransactionHistory
|
|
4785
|
+
* Check whether the authenticated user has payment access to an item on a scoped platform.
|
|
4786
|
+
* @returns ItemAccessCheckResponse
|
|
4718
4787
|
* @throws ApiError
|
|
4719
4788
|
*/
|
|
4720
|
-
static
|
|
4721
|
-
|
|
4722
|
-
|
|
4723
|
-
|
|
4724
|
-
transactionType
|
|
4789
|
+
static billingPlatformsItemsAccessCheckRetrieve({
|
|
4790
|
+
itemId,
|
|
4791
|
+
itemType,
|
|
4792
|
+
platformKey
|
|
4725
4793
|
}) {
|
|
4726
4794
|
return request(OpenAPI, {
|
|
4727
4795
|
method: 'GET',
|
|
4728
|
-
url: '/api/billing/
|
|
4729
|
-
|
|
4730
|
-
'
|
|
4731
|
-
'
|
|
4732
|
-
'
|
|
4733
|
-
'transaction_type': transactionType
|
|
4796
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/access-check/',
|
|
4797
|
+
path: {
|
|
4798
|
+
'item_id': itemId,
|
|
4799
|
+
'item_type': itemType,
|
|
4800
|
+
'platform_key': platformKey
|
|
4734
4801
|
}
|
|
4735
4802
|
});
|
|
4736
4803
|
}
|
|
4737
|
-
}
|
|
4738
|
-
|
|
4739
|
-
class CareerService {
|
|
4740
4804
|
/**
|
|
4741
|
-
*
|
|
4742
|
-
*
|
|
4805
|
+
* Create checkout session
|
|
4806
|
+
* Create a Stripe checkout session for an authenticated user to purchase or subscribe to an item.
|
|
4807
|
+
* @returns CheckoutSessionResponse
|
|
4743
4808
|
* @throws ApiError
|
|
4744
4809
|
*/
|
|
4745
|
-
static
|
|
4746
|
-
|
|
4747
|
-
|
|
4810
|
+
static billingPlatformsItemsCheckoutCreate({
|
|
4811
|
+
itemId,
|
|
4812
|
+
itemType,
|
|
4813
|
+
platformKey,
|
|
4814
|
+
requestBody
|
|
4748
4815
|
}) {
|
|
4749
4816
|
return request(OpenAPI, {
|
|
4750
|
-
method: '
|
|
4751
|
-
url: '/api/
|
|
4817
|
+
method: 'POST',
|
|
4818
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/checkout/',
|
|
4752
4819
|
path: {
|
|
4753
|
-
'
|
|
4754
|
-
'
|
|
4755
|
-
|
|
4820
|
+
'item_id': itemId,
|
|
4821
|
+
'item_type': itemType,
|
|
4822
|
+
'platform_key': platformKey
|
|
4823
|
+
},
|
|
4824
|
+
body: requestBody,
|
|
4825
|
+
mediaType: 'application/json'
|
|
4756
4826
|
});
|
|
4757
4827
|
}
|
|
4758
4828
|
/**
|
|
4759
|
-
*
|
|
4760
|
-
*
|
|
4829
|
+
* Handle checkout callback
|
|
4830
|
+
* Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
|
|
4831
|
+
* @returns void
|
|
4761
4832
|
* @throws ApiError
|
|
4762
4833
|
*/
|
|
4763
|
-
static
|
|
4764
|
-
|
|
4765
|
-
|
|
4834
|
+
static billingPlatformsItemsCheckoutCallbackRetrieve({
|
|
4835
|
+
itemId,
|
|
4836
|
+
itemType,
|
|
4837
|
+
platformKey,
|
|
4838
|
+
returnUrl
|
|
4766
4839
|
}) {
|
|
4767
4840
|
return request(OpenAPI, {
|
|
4768
|
-
method: '
|
|
4769
|
-
url: '/api/
|
|
4841
|
+
method: 'GET',
|
|
4842
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/checkout-callback/',
|
|
4770
4843
|
path: {
|
|
4771
|
-
'
|
|
4772
|
-
'
|
|
4844
|
+
'item_id': itemId,
|
|
4845
|
+
'item_type': itemType,
|
|
4846
|
+
'platform_key': platformKey
|
|
4847
|
+
},
|
|
4848
|
+
query: {
|
|
4849
|
+
'return_url': returnUrl
|
|
4850
|
+
},
|
|
4851
|
+
errors: {
|
|
4852
|
+
302: `No response body`
|
|
4773
4853
|
}
|
|
4774
4854
|
});
|
|
4775
4855
|
}
|
|
4776
4856
|
/**
|
|
4777
|
-
*
|
|
4778
|
-
*
|
|
4857
|
+
* Handle checkout callback
|
|
4858
|
+
* Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
|
|
4859
|
+
* @returns void
|
|
4779
4860
|
* @throws ApiError
|
|
4780
4861
|
*/
|
|
4781
|
-
static
|
|
4782
|
-
|
|
4783
|
-
|
|
4862
|
+
static billingPlatformsItemsCheckoutCallbackRetrieve2({
|
|
4863
|
+
checkoutSessionId,
|
|
4864
|
+
itemId,
|
|
4865
|
+
itemType,
|
|
4866
|
+
platformKey,
|
|
4867
|
+
returnUrl
|
|
4784
4868
|
}) {
|
|
4785
4869
|
return request(OpenAPI, {
|
|
4786
|
-
method: '
|
|
4787
|
-
url: '/api/
|
|
4870
|
+
method: 'GET',
|
|
4871
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/checkout-callback/{checkout_session_id}/',
|
|
4788
4872
|
path: {
|
|
4789
|
-
'
|
|
4790
|
-
'
|
|
4873
|
+
'checkout_session_id': checkoutSessionId,
|
|
4874
|
+
'item_id': itemId,
|
|
4875
|
+
'item_type': itemType,
|
|
4876
|
+
'platform_key': platformKey
|
|
4877
|
+
},
|
|
4878
|
+
query: {
|
|
4879
|
+
'return_url': returnUrl
|
|
4880
|
+
},
|
|
4881
|
+
errors: {
|
|
4882
|
+
302: `No response body`
|
|
4791
4883
|
}
|
|
4792
4884
|
});
|
|
4793
4885
|
}
|
|
4794
4886
|
/**
|
|
4795
|
-
*
|
|
4796
|
-
*
|
|
4887
|
+
* Create guest checkout session
|
|
4888
|
+
* Create a Stripe checkout session for a guest user (email required).
|
|
4889
|
+
* @returns CheckoutSessionResponse
|
|
4797
4890
|
* @throws ApiError
|
|
4798
4891
|
*/
|
|
4799
|
-
static
|
|
4800
|
-
|
|
4892
|
+
static billingPlatformsItemsCheckoutGuestCreate({
|
|
4893
|
+
itemId,
|
|
4894
|
+
itemType,
|
|
4895
|
+
platformKey,
|
|
4896
|
+
requestBody
|
|
4801
4897
|
}) {
|
|
4802
4898
|
return request(OpenAPI, {
|
|
4803
|
-
method: '
|
|
4804
|
-
url: '/api/
|
|
4899
|
+
method: 'POST',
|
|
4900
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/checkout-guest/',
|
|
4805
4901
|
path: {
|
|
4806
|
-
'
|
|
4807
|
-
|
|
4902
|
+
'item_id': itemId,
|
|
4903
|
+
'item_type': itemType,
|
|
4904
|
+
'platform_key': platformKey
|
|
4905
|
+
},
|
|
4906
|
+
body: requestBody,
|
|
4907
|
+
mediaType: 'application/json'
|
|
4808
4908
|
});
|
|
4809
4909
|
}
|
|
4810
4910
|
/**
|
|
4811
|
-
*
|
|
4911
|
+
* Get paywall configuration
|
|
4912
|
+
* Retrieve the paywall configuration for an item. Returns default (disabled) config if none exists.
|
|
4913
|
+
* @returns ItemPaywallConfig
|
|
4812
4914
|
* @throws ApiError
|
|
4813
4915
|
*/
|
|
4814
|
-
static
|
|
4815
|
-
|
|
4816
|
-
|
|
4916
|
+
static billingPlatformsItemsPaywallRetrieve({
|
|
4917
|
+
itemId,
|
|
4918
|
+
itemType,
|
|
4919
|
+
platformKey
|
|
4817
4920
|
}) {
|
|
4818
4921
|
return request(OpenAPI, {
|
|
4819
4922
|
method: 'GET',
|
|
4820
|
-
url: '/api/
|
|
4923
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
|
|
4821
4924
|
path: {
|
|
4822
|
-
'
|
|
4823
|
-
'
|
|
4925
|
+
'item_id': itemId,
|
|
4926
|
+
'item_type': itemType,
|
|
4927
|
+
'platform_key': platformKey
|
|
4824
4928
|
}
|
|
4825
4929
|
});
|
|
4826
4930
|
}
|
|
4827
4931
|
/**
|
|
4828
|
-
*
|
|
4932
|
+
* Create or update paywall configuration
|
|
4933
|
+
* Enable or configure the paywall for an item. Creates a Stripe product on first enable.
|
|
4934
|
+
* @returns ItemPaywallConfig
|
|
4829
4935
|
* @throws ApiError
|
|
4830
4936
|
*/
|
|
4831
|
-
static
|
|
4832
|
-
|
|
4833
|
-
|
|
4937
|
+
static billingPlatformsItemsPaywallCreate({
|
|
4938
|
+
itemId,
|
|
4939
|
+
itemType,
|
|
4940
|
+
platformKey,
|
|
4834
4941
|
requestBody
|
|
4835
4942
|
}) {
|
|
4836
4943
|
return request(OpenAPI, {
|
|
4837
4944
|
method: 'POST',
|
|
4838
|
-
url: '/api/
|
|
4945
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
|
|
4839
4946
|
path: {
|
|
4840
|
-
'
|
|
4841
|
-
'
|
|
4947
|
+
'item_id': itemId,
|
|
4948
|
+
'item_type': itemType,
|
|
4949
|
+
'platform_key': platformKey
|
|
4842
4950
|
},
|
|
4843
4951
|
body: requestBody,
|
|
4844
4952
|
mediaType: 'application/json'
|
|
4845
4953
|
});
|
|
4846
4954
|
}
|
|
4847
4955
|
/**
|
|
4848
|
-
*
|
|
4956
|
+
* Update paywall configuration
|
|
4957
|
+
* Same as POST. Update the paywall configuration for an item.
|
|
4958
|
+
* @returns ItemPaywallConfig
|
|
4849
4959
|
* @throws ApiError
|
|
4850
4960
|
*/
|
|
4851
|
-
static
|
|
4852
|
-
|
|
4853
|
-
|
|
4961
|
+
static billingPlatformsItemsPaywallUpdate({
|
|
4962
|
+
itemId,
|
|
4963
|
+
itemType,
|
|
4964
|
+
platformKey,
|
|
4854
4965
|
requestBody
|
|
4855
4966
|
}) {
|
|
4856
4967
|
return request(OpenAPI, {
|
|
4857
4968
|
method: 'PUT',
|
|
4858
|
-
url: '/api/
|
|
4969
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
|
|
4859
4970
|
path: {
|
|
4860
|
-
'
|
|
4861
|
-
'
|
|
4971
|
+
'item_id': itemId,
|
|
4972
|
+
'item_type': itemType,
|
|
4973
|
+
'platform_key': platformKey
|
|
4862
4974
|
},
|
|
4863
4975
|
body: requestBody,
|
|
4864
4976
|
mediaType: 'application/json'
|
|
4865
4977
|
});
|
|
4866
4978
|
}
|
|
4867
4979
|
/**
|
|
4980
|
+
* Disable paywall configuration
|
|
4981
|
+
* Disable the paywall for an item. Does not delete the configuration.
|
|
4868
4982
|
* @returns void
|
|
4869
4983
|
* @throws ApiError
|
|
4870
4984
|
*/
|
|
4871
|
-
static
|
|
4872
|
-
|
|
4873
|
-
|
|
4985
|
+
static billingPlatformsItemsPaywallDestroy({
|
|
4986
|
+
itemId,
|
|
4987
|
+
itemType,
|
|
4988
|
+
platformKey
|
|
4874
4989
|
}) {
|
|
4875
4990
|
return request(OpenAPI, {
|
|
4876
4991
|
method: 'DELETE',
|
|
4877
|
-
url: '/api/
|
|
4992
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
|
|
4878
4993
|
path: {
|
|
4879
|
-
'
|
|
4880
|
-
'
|
|
4994
|
+
'item_id': itemId,
|
|
4995
|
+
'item_type': itemType,
|
|
4996
|
+
'platform_key': platformKey
|
|
4881
4997
|
}
|
|
4882
4998
|
});
|
|
4883
4999
|
}
|
|
4884
5000
|
/**
|
|
4885
|
-
*
|
|
5001
|
+
* List prices
|
|
5002
|
+
* List active prices for an item's paywall configuration.
|
|
5003
|
+
* @returns ItemPrice
|
|
4886
5004
|
* @throws ApiError
|
|
4887
5005
|
*/
|
|
4888
|
-
static
|
|
4889
|
-
|
|
4890
|
-
|
|
5006
|
+
static billingPlatformsItemsPaywallPricesList({
|
|
5007
|
+
itemId,
|
|
5008
|
+
itemType,
|
|
5009
|
+
platformKey
|
|
4891
5010
|
}) {
|
|
4892
5011
|
return request(OpenAPI, {
|
|
4893
5012
|
method: 'GET',
|
|
4894
|
-
url: '/api/
|
|
5013
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/',
|
|
4895
5014
|
path: {
|
|
4896
|
-
'
|
|
4897
|
-
'
|
|
5015
|
+
'item_id': itemId,
|
|
5016
|
+
'item_type': itemType,
|
|
5017
|
+
'platform_key': platformKey
|
|
4898
5018
|
}
|
|
4899
5019
|
});
|
|
4900
5020
|
}
|
|
4901
5021
|
/**
|
|
4902
|
-
*
|
|
5022
|
+
* Create a price
|
|
5023
|
+
* Create a new price tier for an item. Requires paywall to be enabled and Stripe Connect account ready.
|
|
5024
|
+
* @returns ItemPrice
|
|
4903
5025
|
* @throws ApiError
|
|
4904
5026
|
*/
|
|
4905
|
-
static
|
|
4906
|
-
|
|
4907
|
-
|
|
5027
|
+
static billingPlatformsItemsPaywallPricesCreate({
|
|
5028
|
+
itemId,
|
|
5029
|
+
itemType,
|
|
5030
|
+
platformKey,
|
|
4908
5031
|
requestBody
|
|
4909
5032
|
}) {
|
|
4910
5033
|
return request(OpenAPI, {
|
|
4911
5034
|
method: 'POST',
|
|
4912
|
-
url: '/api/
|
|
5035
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/',
|
|
4913
5036
|
path: {
|
|
4914
|
-
'
|
|
4915
|
-
'
|
|
5037
|
+
'item_id': itemId,
|
|
5038
|
+
'item_type': itemType,
|
|
5039
|
+
'platform_key': platformKey
|
|
4916
5040
|
},
|
|
4917
5041
|
body: requestBody,
|
|
4918
5042
|
mediaType: 'application/json'
|
|
4919
5043
|
});
|
|
4920
5044
|
}
|
|
4921
5045
|
/**
|
|
4922
|
-
*
|
|
5046
|
+
* Get price details
|
|
5047
|
+
* Retrieve a specific price by ID.
|
|
5048
|
+
* @returns ItemPrice
|
|
4923
5049
|
* @throws ApiError
|
|
4924
5050
|
*/
|
|
4925
|
-
static
|
|
4926
|
-
|
|
4927
|
-
|
|
5051
|
+
static billingPlatformsItemsPaywallPricesRetrieve({
|
|
5052
|
+
itemId,
|
|
5053
|
+
itemType,
|
|
5054
|
+
platformKey,
|
|
5055
|
+
priceId
|
|
5056
|
+
}) {
|
|
5057
|
+
return request(OpenAPI, {
|
|
5058
|
+
method: 'GET',
|
|
5059
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/{price_id}/',
|
|
5060
|
+
path: {
|
|
5061
|
+
'item_id': itemId,
|
|
5062
|
+
'item_type': itemType,
|
|
5063
|
+
'platform_key': platformKey,
|
|
5064
|
+
'price_id': priceId
|
|
5065
|
+
}
|
|
5066
|
+
});
|
|
5067
|
+
}
|
|
5068
|
+
/**
|
|
5069
|
+
* Update a price
|
|
5070
|
+
* Update a price tier. If pricing fields change and a Stripe price exists, a new Stripe price is created and the old one deactivated.
|
|
5071
|
+
* @returns ItemPrice
|
|
5072
|
+
* @throws ApiError
|
|
5073
|
+
*/
|
|
5074
|
+
static billingPlatformsItemsPaywallPricesUpdate({
|
|
5075
|
+
itemId,
|
|
5076
|
+
itemType,
|
|
5077
|
+
platformKey,
|
|
5078
|
+
priceId,
|
|
4928
5079
|
requestBody
|
|
4929
5080
|
}) {
|
|
4930
5081
|
return request(OpenAPI, {
|
|
4931
5082
|
method: 'PUT',
|
|
4932
|
-
url: '/api/
|
|
5083
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/{price_id}/',
|
|
4933
5084
|
path: {
|
|
4934
|
-
'
|
|
4935
|
-
'
|
|
5085
|
+
'item_id': itemId,
|
|
5086
|
+
'item_type': itemType,
|
|
5087
|
+
'platform_key': platformKey,
|
|
5088
|
+
'price_id': priceId
|
|
4936
5089
|
},
|
|
4937
5090
|
body: requestBody,
|
|
4938
5091
|
mediaType: 'application/json'
|
|
4939
5092
|
});
|
|
4940
5093
|
}
|
|
4941
5094
|
/**
|
|
5095
|
+
* Delete a price
|
|
5096
|
+
* Soft-delete a price tier and deactivate the corresponding Stripe price.
|
|
4942
5097
|
* @returns void
|
|
4943
5098
|
* @throws ApiError
|
|
4944
5099
|
*/
|
|
4945
|
-
static
|
|
4946
|
-
|
|
4947
|
-
|
|
5100
|
+
static billingPlatformsItemsPaywallPricesDestroy({
|
|
5101
|
+
itemId,
|
|
5102
|
+
itemType,
|
|
5103
|
+
platformKey,
|
|
5104
|
+
priceId
|
|
4948
5105
|
}) {
|
|
4949
5106
|
return request(OpenAPI, {
|
|
4950
5107
|
method: 'DELETE',
|
|
4951
|
-
url: '/api/
|
|
5108
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/{price_id}/',
|
|
4952
5109
|
path: {
|
|
4953
|
-
'
|
|
4954
|
-
'
|
|
5110
|
+
'item_id': itemId,
|
|
5111
|
+
'item_type': itemType,
|
|
5112
|
+
'platform_key': platformKey,
|
|
5113
|
+
'price_id': priceId
|
|
4955
5114
|
}
|
|
4956
5115
|
});
|
|
4957
5116
|
}
|
|
4958
5117
|
/**
|
|
4959
|
-
*
|
|
5118
|
+
* Get public pricing
|
|
5119
|
+
* Retrieve public pricing information for an item. No authentication required.
|
|
5120
|
+
* @returns PublicItemPricing
|
|
4960
5121
|
* @throws ApiError
|
|
4961
5122
|
*/
|
|
4962
|
-
static
|
|
5123
|
+
static billingPlatformsItemsPricingRetrieve({
|
|
5124
|
+
itemId,
|
|
5125
|
+
itemType,
|
|
5126
|
+
platformKey
|
|
5127
|
+
}) {
|
|
5128
|
+
return request(OpenAPI, {
|
|
5129
|
+
method: 'GET',
|
|
5130
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/pricing/',
|
|
5131
|
+
path: {
|
|
5132
|
+
'item_id': itemId,
|
|
5133
|
+
'item_type': itemType,
|
|
5134
|
+
'platform_key': platformKey
|
|
5135
|
+
}
|
|
5136
|
+
});
|
|
5137
|
+
}
|
|
5138
|
+
/**
|
|
5139
|
+
* List item subscribers
|
|
5140
|
+
* List all subscribers for an item. Optionally filter by subscription status.
|
|
5141
|
+
* @returns PaginatedItemSubscriptionList
|
|
5142
|
+
* @throws ApiError
|
|
5143
|
+
*/
|
|
5144
|
+
static billingPlatformsItemsSubscribersList({
|
|
5145
|
+
itemId,
|
|
5146
|
+
itemType,
|
|
5147
|
+
platformKey,
|
|
5148
|
+
page,
|
|
5149
|
+
pageSize,
|
|
5150
|
+
status
|
|
5151
|
+
}) {
|
|
5152
|
+
return request(OpenAPI, {
|
|
5153
|
+
method: 'GET',
|
|
5154
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/subscribers/',
|
|
5155
|
+
path: {
|
|
5156
|
+
'item_id': itemId,
|
|
5157
|
+
'item_type': itemType,
|
|
5158
|
+
'platform_key': platformKey
|
|
5159
|
+
},
|
|
5160
|
+
query: {
|
|
5161
|
+
'page': page,
|
|
5162
|
+
'page_size': pageSize,
|
|
5163
|
+
'status': status
|
|
5164
|
+
}
|
|
5165
|
+
});
|
|
5166
|
+
}
|
|
5167
|
+
/**
|
|
5168
|
+
* Get user subscription
|
|
5169
|
+
* Retrieve the current user's subscription to an item.
|
|
5170
|
+
* @returns ItemSubscription
|
|
5171
|
+
* @throws ApiError
|
|
5172
|
+
*/
|
|
5173
|
+
static billingPlatformsItemsSubscriptionRetrieve({
|
|
5174
|
+
itemId,
|
|
5175
|
+
itemType,
|
|
5176
|
+
platformKey
|
|
5177
|
+
}) {
|
|
5178
|
+
return request(OpenAPI, {
|
|
5179
|
+
method: 'GET',
|
|
5180
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/subscription/',
|
|
5181
|
+
path: {
|
|
5182
|
+
'item_id': itemId,
|
|
5183
|
+
'item_type': itemType,
|
|
5184
|
+
'platform_key': platformKey
|
|
5185
|
+
}
|
|
5186
|
+
});
|
|
5187
|
+
}
|
|
5188
|
+
/**
|
|
5189
|
+
* Cancel subscription
|
|
5190
|
+
* Cancel the current user's subscription. Returns a Stripe customer portal URL for recurring subscriptions, or cancels directly for one-time purchases.
|
|
5191
|
+
* @returns PortalUrlResponse
|
|
5192
|
+
* @throws ApiError
|
|
5193
|
+
*/
|
|
5194
|
+
static billingPlatformsItemsSubscriptionCancelCreate({
|
|
5195
|
+
itemId,
|
|
5196
|
+
itemType,
|
|
5197
|
+
platformKey
|
|
5198
|
+
}) {
|
|
5199
|
+
return request(OpenAPI, {
|
|
5200
|
+
method: 'POST',
|
|
5201
|
+
url: '/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/subscription/cancel/',
|
|
5202
|
+
path: {
|
|
5203
|
+
'item_id': itemId,
|
|
5204
|
+
'item_type': itemType,
|
|
5205
|
+
'platform_key': platformKey
|
|
5206
|
+
}
|
|
5207
|
+
});
|
|
5208
|
+
}
|
|
5209
|
+
/**
|
|
5210
|
+
* List user subscriptions
|
|
5211
|
+
* Paginated list of the current user's subscriptions on a platform. Optionally filter by status or item_type.
|
|
5212
|
+
* @returns PaginatedItemSubscriptionListList
|
|
5213
|
+
* @throws ApiError
|
|
5214
|
+
*/
|
|
5215
|
+
static billingPlatformsMySubscriptionsList({
|
|
5216
|
+
platformKey,
|
|
5217
|
+
itemType,
|
|
5218
|
+
page,
|
|
5219
|
+
pageSize,
|
|
5220
|
+
status
|
|
5221
|
+
}) {
|
|
5222
|
+
return request(OpenAPI, {
|
|
5223
|
+
method: 'GET',
|
|
5224
|
+
url: '/api/billing/platforms/{platform_key}/my-subscriptions/',
|
|
5225
|
+
path: {
|
|
5226
|
+
'platform_key': platformKey
|
|
5227
|
+
},
|
|
5228
|
+
query: {
|
|
5229
|
+
'item_type': itemType,
|
|
5230
|
+
'page': page,
|
|
5231
|
+
'page_size': pageSize,
|
|
5232
|
+
'status': status
|
|
5233
|
+
}
|
|
5234
|
+
});
|
|
5235
|
+
}
|
|
5236
|
+
/**
|
|
5237
|
+
* List transaction history
|
|
5238
|
+
* Paginated transaction history for the credit account. Use platform_key query param to list platform account transactions (if permitted). Filter by transaction_type, from_date (YYYY-MM-DD), to_date (YYYY-MM-DD).
|
|
5239
|
+
* @returns CreditTransactionHistory
|
|
5240
|
+
* @throws ApiError
|
|
5241
|
+
*/
|
|
5242
|
+
static billingTransactionsRetrieve({
|
|
5243
|
+
fromDate,
|
|
5244
|
+
platformKey,
|
|
5245
|
+
toDate,
|
|
5246
|
+
transactionType
|
|
5247
|
+
}) {
|
|
5248
|
+
return request(OpenAPI, {
|
|
5249
|
+
method: 'GET',
|
|
5250
|
+
url: '/api/billing/transactions/',
|
|
5251
|
+
query: {
|
|
5252
|
+
'from_date': fromDate,
|
|
5253
|
+
'platform_key': platformKey,
|
|
5254
|
+
'to_date': toDate,
|
|
5255
|
+
'transaction_type': transactionType
|
|
5256
|
+
}
|
|
5257
|
+
});
|
|
5258
|
+
}
|
|
5259
|
+
}
|
|
5260
|
+
|
|
5261
|
+
class CareerService {
|
|
5262
|
+
/**
|
|
5263
|
+
* API endpoint for managing user base locations
|
|
5264
|
+
* @returns any No response body
|
|
5265
|
+
* @throws ApiError
|
|
5266
|
+
*/
|
|
5267
|
+
static careerLocationOrgsUsersRetrieve({
|
|
4963
5268
|
org,
|
|
4964
5269
|
username
|
|
4965
5270
|
}) {
|
|
4966
5271
|
return request(OpenAPI, {
|
|
4967
5272
|
method: 'GET',
|
|
4968
|
-
url: '/api/career/orgs/{org}/
|
|
5273
|
+
url: '/api/career/location/orgs/{org}/users/{username}/',
|
|
4969
5274
|
path: {
|
|
4970
5275
|
'org': org,
|
|
4971
5276
|
'username': username
|
|
@@ -4973,73 +5278,68 @@ class CareerService {
|
|
|
4973
5278
|
});
|
|
4974
5279
|
}
|
|
4975
5280
|
/**
|
|
4976
|
-
*
|
|
5281
|
+
* API endpoint for managing user base locations
|
|
5282
|
+
* @returns any No response body
|
|
4977
5283
|
* @throws ApiError
|
|
4978
5284
|
*/
|
|
4979
|
-
static
|
|
5285
|
+
static careerLocationOrgsUsersCreate({
|
|
4980
5286
|
org,
|
|
4981
|
-
username
|
|
4982
|
-
requestBody
|
|
5287
|
+
username
|
|
4983
5288
|
}) {
|
|
4984
5289
|
return request(OpenAPI, {
|
|
4985
5290
|
method: 'POST',
|
|
4986
|
-
url: '/api/career/orgs/{org}/
|
|
5291
|
+
url: '/api/career/location/orgs/{org}/users/{username}/',
|
|
4987
5292
|
path: {
|
|
4988
5293
|
'org': org,
|
|
4989
5294
|
'username': username
|
|
4990
|
-
}
|
|
4991
|
-
body: requestBody,
|
|
4992
|
-
mediaType: 'application/json'
|
|
5295
|
+
}
|
|
4993
5296
|
});
|
|
4994
5297
|
}
|
|
4995
5298
|
/**
|
|
4996
|
-
*
|
|
5299
|
+
* API endpoint for managing user base locations
|
|
5300
|
+
* @returns any No response body
|
|
4997
5301
|
* @throws ApiError
|
|
4998
5302
|
*/
|
|
4999
|
-
static
|
|
5303
|
+
static careerLocationOrgsUsersUpdate({
|
|
5000
5304
|
org,
|
|
5001
|
-
username
|
|
5002
|
-
requestBody
|
|
5305
|
+
username
|
|
5003
5306
|
}) {
|
|
5004
5307
|
return request(OpenAPI, {
|
|
5005
5308
|
method: 'PUT',
|
|
5006
|
-
url: '/api/career/orgs/{org}/
|
|
5309
|
+
url: '/api/career/location/orgs/{org}/users/{username}/',
|
|
5007
5310
|
path: {
|
|
5008
5311
|
'org': org,
|
|
5009
5312
|
'username': username
|
|
5010
|
-
}
|
|
5011
|
-
body: requestBody,
|
|
5012
|
-
mediaType: 'application/json'
|
|
5313
|
+
}
|
|
5013
5314
|
});
|
|
5014
5315
|
}
|
|
5015
5316
|
/**
|
|
5016
|
-
*
|
|
5317
|
+
* Platform-wide location statistics (GET only)
|
|
5318
|
+
* @returns any No response body
|
|
5017
5319
|
* @throws ApiError
|
|
5018
5320
|
*/
|
|
5019
|
-
static
|
|
5020
|
-
org
|
|
5021
|
-
username
|
|
5321
|
+
static careerLocationsOrgsRetrieve({
|
|
5322
|
+
org
|
|
5022
5323
|
}) {
|
|
5023
5324
|
return request(OpenAPI, {
|
|
5024
|
-
method: '
|
|
5025
|
-
url: '/api/career/orgs/{org}/
|
|
5325
|
+
method: 'GET',
|
|
5326
|
+
url: '/api/career/locations/orgs/{org}/',
|
|
5026
5327
|
path: {
|
|
5027
|
-
'org': org
|
|
5028
|
-
'username': username
|
|
5328
|
+
'org': org
|
|
5029
5329
|
}
|
|
5030
5330
|
});
|
|
5031
5331
|
}
|
|
5032
5332
|
/**
|
|
5033
|
-
* @returns
|
|
5333
|
+
* @returns Company
|
|
5034
5334
|
* @throws ApiError
|
|
5035
5335
|
*/
|
|
5036
|
-
static
|
|
5336
|
+
static careerOrgsCompaniesUsersRetrieve({
|
|
5037
5337
|
org,
|
|
5038
5338
|
username
|
|
5039
5339
|
}) {
|
|
5040
5340
|
return request(OpenAPI, {
|
|
5041
5341
|
method: 'GET',
|
|
5042
|
-
url: '/api/career/orgs/{org}/
|
|
5342
|
+
url: '/api/career/orgs/{org}/companies/users/{username}/',
|
|
5043
5343
|
path: {
|
|
5044
5344
|
'org': org,
|
|
5045
5345
|
'username': username
|
|
@@ -5047,17 +5347,17 @@ class CareerService {
|
|
|
5047
5347
|
});
|
|
5048
5348
|
}
|
|
5049
5349
|
/**
|
|
5050
|
-
* @returns
|
|
5350
|
+
* @returns Company
|
|
5051
5351
|
* @throws ApiError
|
|
5052
5352
|
*/
|
|
5053
|
-
static
|
|
5353
|
+
static careerOrgsCompaniesUsersCreate({
|
|
5054
5354
|
org,
|
|
5055
5355
|
username,
|
|
5056
5356
|
requestBody
|
|
5057
5357
|
}) {
|
|
5058
5358
|
return request(OpenAPI, {
|
|
5059
5359
|
method: 'POST',
|
|
5060
|
-
url: '/api/career/orgs/{org}/
|
|
5360
|
+
url: '/api/career/orgs/{org}/companies/users/{username}/',
|
|
5061
5361
|
path: {
|
|
5062
5362
|
'org': org,
|
|
5063
5363
|
'username': username
|
|
@@ -5067,17 +5367,17 @@ class CareerService {
|
|
|
5067
5367
|
});
|
|
5068
5368
|
}
|
|
5069
5369
|
/**
|
|
5070
|
-
* @returns
|
|
5370
|
+
* @returns Company
|
|
5071
5371
|
* @throws ApiError
|
|
5072
5372
|
*/
|
|
5073
|
-
static
|
|
5373
|
+
static careerOrgsCompaniesUsersUpdate({
|
|
5074
5374
|
org,
|
|
5075
5375
|
username,
|
|
5076
5376
|
requestBody
|
|
5077
5377
|
}) {
|
|
5078
5378
|
return request(OpenAPI, {
|
|
5079
5379
|
method: 'PUT',
|
|
5080
|
-
url: '/api/career/orgs/{org}/
|
|
5380
|
+
url: '/api/career/orgs/{org}/companies/users/{username}/',
|
|
5081
5381
|
path: {
|
|
5082
5382
|
'org': org,
|
|
5083
5383
|
'username': username
|
|
@@ -5090,13 +5390,13 @@ class CareerService {
|
|
|
5090
5390
|
* @returns void
|
|
5091
5391
|
* @throws ApiError
|
|
5092
5392
|
*/
|
|
5093
|
-
static
|
|
5393
|
+
static careerOrgsCompaniesUsersDestroy({
|
|
5094
5394
|
org,
|
|
5095
5395
|
username
|
|
5096
5396
|
}) {
|
|
5097
5397
|
return request(OpenAPI, {
|
|
5098
5398
|
method: 'DELETE',
|
|
5099
|
-
url: '/api/career/orgs/{org}/
|
|
5399
|
+
url: '/api/career/orgs/{org}/companies/users/{username}/',
|
|
5100
5400
|
path: {
|
|
5101
5401
|
'org': org,
|
|
5102
5402
|
'username': username
|
|
@@ -5104,16 +5404,16 @@ class CareerService {
|
|
|
5104
5404
|
});
|
|
5105
5405
|
}
|
|
5106
5406
|
/**
|
|
5107
|
-
* @returns
|
|
5407
|
+
* @returns Education
|
|
5108
5408
|
* @throws ApiError
|
|
5109
5409
|
*/
|
|
5110
|
-
static
|
|
5410
|
+
static careerOrgsEducationUsersRetrieve({
|
|
5111
5411
|
org,
|
|
5112
5412
|
username
|
|
5113
5413
|
}) {
|
|
5114
5414
|
return request(OpenAPI, {
|
|
5115
5415
|
method: 'GET',
|
|
5116
|
-
url: '/api/career/orgs/{org}/
|
|
5416
|
+
url: '/api/career/orgs/{org}/education/users/{username}/',
|
|
5117
5417
|
path: {
|
|
5118
5418
|
'org': org,
|
|
5119
5419
|
'username': username
|
|
@@ -5121,17 +5421,17 @@ class CareerService {
|
|
|
5121
5421
|
});
|
|
5122
5422
|
}
|
|
5123
5423
|
/**
|
|
5124
|
-
* @returns
|
|
5424
|
+
* @returns Education
|
|
5125
5425
|
* @throws ApiError
|
|
5126
5426
|
*/
|
|
5127
|
-
static
|
|
5427
|
+
static careerOrgsEducationUsersCreate({
|
|
5128
5428
|
org,
|
|
5129
5429
|
username,
|
|
5130
5430
|
requestBody
|
|
5131
5431
|
}) {
|
|
5132
5432
|
return request(OpenAPI, {
|
|
5133
5433
|
method: 'POST',
|
|
5134
|
-
url: '/api/career/orgs/{org}/
|
|
5434
|
+
url: '/api/career/orgs/{org}/education/users/{username}/',
|
|
5135
5435
|
path: {
|
|
5136
5436
|
'org': org,
|
|
5137
5437
|
'username': username
|
|
@@ -5141,17 +5441,17 @@ class CareerService {
|
|
|
5141
5441
|
});
|
|
5142
5442
|
}
|
|
5143
5443
|
/**
|
|
5144
|
-
* @returns
|
|
5444
|
+
* @returns Education
|
|
5145
5445
|
* @throws ApiError
|
|
5146
5446
|
*/
|
|
5147
|
-
static
|
|
5447
|
+
static careerOrgsEducationUsersUpdate({
|
|
5148
5448
|
org,
|
|
5149
5449
|
username,
|
|
5150
5450
|
requestBody
|
|
5151
5451
|
}) {
|
|
5152
5452
|
return request(OpenAPI, {
|
|
5153
5453
|
method: 'PUT',
|
|
5154
|
-
url: '/api/career/orgs/{org}/
|
|
5454
|
+
url: '/api/career/orgs/{org}/education/users/{username}/',
|
|
5155
5455
|
path: {
|
|
5156
5456
|
'org': org,
|
|
5157
5457
|
'username': username
|
|
@@ -5164,13 +5464,13 @@ class CareerService {
|
|
|
5164
5464
|
* @returns void
|
|
5165
5465
|
* @throws ApiError
|
|
5166
5466
|
*/
|
|
5167
|
-
static
|
|
5467
|
+
static careerOrgsEducationUsersDestroy({
|
|
5168
5468
|
org,
|
|
5169
5469
|
username
|
|
5170
5470
|
}) {
|
|
5171
5471
|
return request(OpenAPI, {
|
|
5172
5472
|
method: 'DELETE',
|
|
5173
|
-
url: '/api/career/orgs/{org}/
|
|
5473
|
+
url: '/api/career/orgs/{org}/education/users/{username}/',
|
|
5174
5474
|
path: {
|
|
5175
5475
|
'org': org,
|
|
5176
5476
|
'username': username
|
|
@@ -5178,16 +5478,16 @@ class CareerService {
|
|
|
5178
5478
|
});
|
|
5179
5479
|
}
|
|
5180
5480
|
/**
|
|
5181
|
-
* @returns
|
|
5481
|
+
* @returns Experience
|
|
5182
5482
|
* @throws ApiError
|
|
5183
5483
|
*/
|
|
5184
|
-
static
|
|
5484
|
+
static careerOrgsExperienceUsersRetrieve({
|
|
5185
5485
|
org,
|
|
5186
5486
|
username
|
|
5187
5487
|
}) {
|
|
5188
5488
|
return request(OpenAPI, {
|
|
5189
5489
|
method: 'GET',
|
|
5190
|
-
url: '/api/career/
|
|
5490
|
+
url: '/api/career/orgs/{org}/experience/users/{username}/',
|
|
5191
5491
|
path: {
|
|
5192
5492
|
'org': org,
|
|
5193
5493
|
'username': username
|
|
@@ -5195,51 +5495,273 @@ class CareerService {
|
|
|
5195
5495
|
});
|
|
5196
5496
|
}
|
|
5197
5497
|
/**
|
|
5198
|
-
* @returns
|
|
5498
|
+
* @returns Experience
|
|
5199
5499
|
* @throws ApiError
|
|
5200
5500
|
*/
|
|
5201
|
-
static
|
|
5501
|
+
static careerOrgsExperienceUsersCreate({
|
|
5202
5502
|
org,
|
|
5203
|
-
username
|
|
5503
|
+
username,
|
|
5504
|
+
requestBody
|
|
5204
5505
|
}) {
|
|
5205
5506
|
return request(OpenAPI, {
|
|
5206
5507
|
method: 'POST',
|
|
5207
|
-
url: '/api/career/
|
|
5508
|
+
url: '/api/career/orgs/{org}/experience/users/{username}/',
|
|
5208
5509
|
path: {
|
|
5209
5510
|
'org': org,
|
|
5210
5511
|
'username': username
|
|
5211
|
-
}
|
|
5512
|
+
},
|
|
5513
|
+
body: requestBody,
|
|
5514
|
+
mediaType: 'application/json'
|
|
5212
5515
|
});
|
|
5213
5516
|
}
|
|
5214
5517
|
/**
|
|
5215
|
-
* @returns
|
|
5518
|
+
* @returns Experience
|
|
5216
5519
|
* @throws ApiError
|
|
5217
5520
|
*/
|
|
5218
|
-
static
|
|
5521
|
+
static careerOrgsExperienceUsersUpdate({
|
|
5219
5522
|
org,
|
|
5220
|
-
username
|
|
5523
|
+
username,
|
|
5524
|
+
requestBody
|
|
5221
5525
|
}) {
|
|
5222
5526
|
return request(OpenAPI, {
|
|
5223
5527
|
method: 'PUT',
|
|
5224
|
-
url: '/api/career/
|
|
5528
|
+
url: '/api/career/orgs/{org}/experience/users/{username}/',
|
|
5225
5529
|
path: {
|
|
5226
5530
|
'org': org,
|
|
5227
5531
|
'username': username
|
|
5228
|
-
}
|
|
5532
|
+
},
|
|
5533
|
+
body: requestBody,
|
|
5534
|
+
mediaType: 'application/json'
|
|
5229
5535
|
});
|
|
5230
5536
|
}
|
|
5231
|
-
}
|
|
5232
|
-
|
|
5233
|
-
class CatalogService {
|
|
5234
5537
|
/**
|
|
5235
|
-
*
|
|
5236
|
-
* @returns PaginatedCourseAccessRequest
|
|
5538
|
+
* @returns void
|
|
5237
5539
|
* @throws ApiError
|
|
5238
5540
|
*/
|
|
5239
|
-
static
|
|
5240
|
-
|
|
5241
|
-
|
|
5242
|
-
|
|
5541
|
+
static careerOrgsExperienceUsersDestroy({
|
|
5542
|
+
org,
|
|
5543
|
+
username
|
|
5544
|
+
}) {
|
|
5545
|
+
return request(OpenAPI, {
|
|
5546
|
+
method: 'DELETE',
|
|
5547
|
+
url: '/api/career/orgs/{org}/experience/users/{username}/',
|
|
5548
|
+
path: {
|
|
5549
|
+
'org': org,
|
|
5550
|
+
'username': username
|
|
5551
|
+
}
|
|
5552
|
+
});
|
|
5553
|
+
}
|
|
5554
|
+
/**
|
|
5555
|
+
* @returns Institution
|
|
5556
|
+
* @throws ApiError
|
|
5557
|
+
*/
|
|
5558
|
+
static careerOrgsInstitutionsUsersRetrieve({
|
|
5559
|
+
org,
|
|
5560
|
+
username
|
|
5561
|
+
}) {
|
|
5562
|
+
return request(OpenAPI, {
|
|
5563
|
+
method: 'GET',
|
|
5564
|
+
url: '/api/career/orgs/{org}/institutions/users/{username}/',
|
|
5565
|
+
path: {
|
|
5566
|
+
'org': org,
|
|
5567
|
+
'username': username
|
|
5568
|
+
}
|
|
5569
|
+
});
|
|
5570
|
+
}
|
|
5571
|
+
/**
|
|
5572
|
+
* @returns Institution
|
|
5573
|
+
* @throws ApiError
|
|
5574
|
+
*/
|
|
5575
|
+
static careerOrgsInstitutionsUsersCreate({
|
|
5576
|
+
org,
|
|
5577
|
+
username,
|
|
5578
|
+
requestBody
|
|
5579
|
+
}) {
|
|
5580
|
+
return request(OpenAPI, {
|
|
5581
|
+
method: 'POST',
|
|
5582
|
+
url: '/api/career/orgs/{org}/institutions/users/{username}/',
|
|
5583
|
+
path: {
|
|
5584
|
+
'org': org,
|
|
5585
|
+
'username': username
|
|
5586
|
+
},
|
|
5587
|
+
body: requestBody,
|
|
5588
|
+
mediaType: 'application/json'
|
|
5589
|
+
});
|
|
5590
|
+
}
|
|
5591
|
+
/**
|
|
5592
|
+
* @returns Institution
|
|
5593
|
+
* @throws ApiError
|
|
5594
|
+
*/
|
|
5595
|
+
static careerOrgsInstitutionsUsersUpdate({
|
|
5596
|
+
org,
|
|
5597
|
+
username,
|
|
5598
|
+
requestBody
|
|
5599
|
+
}) {
|
|
5600
|
+
return request(OpenAPI, {
|
|
5601
|
+
method: 'PUT',
|
|
5602
|
+
url: '/api/career/orgs/{org}/institutions/users/{username}/',
|
|
5603
|
+
path: {
|
|
5604
|
+
'org': org,
|
|
5605
|
+
'username': username
|
|
5606
|
+
},
|
|
5607
|
+
body: requestBody,
|
|
5608
|
+
mediaType: 'application/json'
|
|
5609
|
+
});
|
|
5610
|
+
}
|
|
5611
|
+
/**
|
|
5612
|
+
* @returns void
|
|
5613
|
+
* @throws ApiError
|
|
5614
|
+
*/
|
|
5615
|
+
static careerOrgsInstitutionsUsersDestroy({
|
|
5616
|
+
org,
|
|
5617
|
+
username
|
|
5618
|
+
}) {
|
|
5619
|
+
return request(OpenAPI, {
|
|
5620
|
+
method: 'DELETE',
|
|
5621
|
+
url: '/api/career/orgs/{org}/institutions/users/{username}/',
|
|
5622
|
+
path: {
|
|
5623
|
+
'org': org,
|
|
5624
|
+
'username': username
|
|
5625
|
+
}
|
|
5626
|
+
});
|
|
5627
|
+
}
|
|
5628
|
+
/**
|
|
5629
|
+
* @returns Program
|
|
5630
|
+
* @throws ApiError
|
|
5631
|
+
*/
|
|
5632
|
+
static careerOrgsProgramsUsersRetrieve({
|
|
5633
|
+
org,
|
|
5634
|
+
username
|
|
5635
|
+
}) {
|
|
5636
|
+
return request(OpenAPI, {
|
|
5637
|
+
method: 'GET',
|
|
5638
|
+
url: '/api/career/orgs/{org}/programs/users/{username}/',
|
|
5639
|
+
path: {
|
|
5640
|
+
'org': org,
|
|
5641
|
+
'username': username
|
|
5642
|
+
}
|
|
5643
|
+
});
|
|
5644
|
+
}
|
|
5645
|
+
/**
|
|
5646
|
+
* @returns Program
|
|
5647
|
+
* @throws ApiError
|
|
5648
|
+
*/
|
|
5649
|
+
static careerOrgsProgramsUsersCreate({
|
|
5650
|
+
org,
|
|
5651
|
+
username,
|
|
5652
|
+
requestBody
|
|
5653
|
+
}) {
|
|
5654
|
+
return request(OpenAPI, {
|
|
5655
|
+
method: 'POST',
|
|
5656
|
+
url: '/api/career/orgs/{org}/programs/users/{username}/',
|
|
5657
|
+
path: {
|
|
5658
|
+
'org': org,
|
|
5659
|
+
'username': username
|
|
5660
|
+
},
|
|
5661
|
+
body: requestBody,
|
|
5662
|
+
mediaType: 'application/json'
|
|
5663
|
+
});
|
|
5664
|
+
}
|
|
5665
|
+
/**
|
|
5666
|
+
* @returns Program
|
|
5667
|
+
* @throws ApiError
|
|
5668
|
+
*/
|
|
5669
|
+
static careerOrgsProgramsUsersUpdate({
|
|
5670
|
+
org,
|
|
5671
|
+
username,
|
|
5672
|
+
requestBody
|
|
5673
|
+
}) {
|
|
5674
|
+
return request(OpenAPI, {
|
|
5675
|
+
method: 'PUT',
|
|
5676
|
+
url: '/api/career/orgs/{org}/programs/users/{username}/',
|
|
5677
|
+
path: {
|
|
5678
|
+
'org': org,
|
|
5679
|
+
'username': username
|
|
5680
|
+
},
|
|
5681
|
+
body: requestBody,
|
|
5682
|
+
mediaType: 'application/json'
|
|
5683
|
+
});
|
|
5684
|
+
}
|
|
5685
|
+
/**
|
|
5686
|
+
* @returns void
|
|
5687
|
+
* @throws ApiError
|
|
5688
|
+
*/
|
|
5689
|
+
static careerOrgsProgramsUsersDestroy({
|
|
5690
|
+
org,
|
|
5691
|
+
username
|
|
5692
|
+
}) {
|
|
5693
|
+
return request(OpenAPI, {
|
|
5694
|
+
method: 'DELETE',
|
|
5695
|
+
url: '/api/career/orgs/{org}/programs/users/{username}/',
|
|
5696
|
+
path: {
|
|
5697
|
+
'org': org,
|
|
5698
|
+
'username': username
|
|
5699
|
+
}
|
|
5700
|
+
});
|
|
5701
|
+
}
|
|
5702
|
+
/**
|
|
5703
|
+
* @returns any No response body
|
|
5704
|
+
* @throws ApiError
|
|
5705
|
+
*/
|
|
5706
|
+
static careerResumeOrgsUsersRetrieve({
|
|
5707
|
+
org,
|
|
5708
|
+
username
|
|
5709
|
+
}) {
|
|
5710
|
+
return request(OpenAPI, {
|
|
5711
|
+
method: 'GET',
|
|
5712
|
+
url: '/api/career/resume/orgs/{org}/users/{username}/',
|
|
5713
|
+
path: {
|
|
5714
|
+
'org': org,
|
|
5715
|
+
'username': username
|
|
5716
|
+
}
|
|
5717
|
+
});
|
|
5718
|
+
}
|
|
5719
|
+
/**
|
|
5720
|
+
* @returns any No response body
|
|
5721
|
+
* @throws ApiError
|
|
5722
|
+
*/
|
|
5723
|
+
static careerResumeOrgsUsersCreate({
|
|
5724
|
+
org,
|
|
5725
|
+
username
|
|
5726
|
+
}) {
|
|
5727
|
+
return request(OpenAPI, {
|
|
5728
|
+
method: 'POST',
|
|
5729
|
+
url: '/api/career/resume/orgs/{org}/users/{username}/',
|
|
5730
|
+
path: {
|
|
5731
|
+
'org': org,
|
|
5732
|
+
'username': username
|
|
5733
|
+
}
|
|
5734
|
+
});
|
|
5735
|
+
}
|
|
5736
|
+
/**
|
|
5737
|
+
* @returns any No response body
|
|
5738
|
+
* @throws ApiError
|
|
5739
|
+
*/
|
|
5740
|
+
static careerResumeOrgsUsersUpdate({
|
|
5741
|
+
org,
|
|
5742
|
+
username
|
|
5743
|
+
}) {
|
|
5744
|
+
return request(OpenAPI, {
|
|
5745
|
+
method: 'PUT',
|
|
5746
|
+
url: '/api/career/resume/orgs/{org}/users/{username}/',
|
|
5747
|
+
path: {
|
|
5748
|
+
'org': org,
|
|
5749
|
+
'username': username
|
|
5750
|
+
}
|
|
5751
|
+
});
|
|
5752
|
+
}
|
|
5753
|
+
}
|
|
5754
|
+
|
|
5755
|
+
class CatalogService {
|
|
5756
|
+
/**
|
|
5757
|
+
* Retrieve a paginated list of access requests
|
|
5758
|
+
* @returns PaginatedCourseAccessRequest
|
|
5759
|
+
* @throws ApiError
|
|
5760
|
+
*/
|
|
5761
|
+
static catalogAccessRequestsCourseManageRetrieve({
|
|
5762
|
+
page,
|
|
5763
|
+
pageSize,
|
|
5764
|
+
platformKey,
|
|
5243
5765
|
platformOrg,
|
|
5244
5766
|
reviewed,
|
|
5245
5767
|
sort = '-id'
|
|
@@ -18970,6 +19492,461 @@ class NotificationsService {
|
|
|
18970
19492
|
}
|
|
18971
19493
|
}
|
|
18972
19494
|
|
|
19495
|
+
class PlatformsService {
|
|
19496
|
+
/**
|
|
19497
|
+
* Check whether the authenticated user has payment access to an item on a scoped platform.
|
|
19498
|
+
* @returns ItemAccessCheckResponse
|
|
19499
|
+
* @throws ApiError
|
|
19500
|
+
*/
|
|
19501
|
+
static platformsItemsAccessCheckRetrieve({
|
|
19502
|
+
itemId,
|
|
19503
|
+
itemType,
|
|
19504
|
+
platformKey
|
|
19505
|
+
}) {
|
|
19506
|
+
return request(OpenAPI, {
|
|
19507
|
+
method: 'GET',
|
|
19508
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/access-check/',
|
|
19509
|
+
path: {
|
|
19510
|
+
'item_id': itemId,
|
|
19511
|
+
'item_type': itemType,
|
|
19512
|
+
'platform_key': platformKey
|
|
19513
|
+
}
|
|
19514
|
+
});
|
|
19515
|
+
}
|
|
19516
|
+
/**
|
|
19517
|
+
* Create checkout session
|
|
19518
|
+
* Create a Stripe checkout session for an authenticated user to purchase or subscribe to an item.
|
|
19519
|
+
* @returns CheckoutSessionResponse
|
|
19520
|
+
* @throws ApiError
|
|
19521
|
+
*/
|
|
19522
|
+
static platformsItemsCheckoutCreate({
|
|
19523
|
+
itemId,
|
|
19524
|
+
itemType,
|
|
19525
|
+
platformKey,
|
|
19526
|
+
requestBody
|
|
19527
|
+
}) {
|
|
19528
|
+
return request(OpenAPI, {
|
|
19529
|
+
method: 'POST',
|
|
19530
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/checkout/',
|
|
19531
|
+
path: {
|
|
19532
|
+
'item_id': itemId,
|
|
19533
|
+
'item_type': itemType,
|
|
19534
|
+
'platform_key': platformKey
|
|
19535
|
+
},
|
|
19536
|
+
body: requestBody,
|
|
19537
|
+
mediaType: 'application/json'
|
|
19538
|
+
});
|
|
19539
|
+
}
|
|
19540
|
+
/**
|
|
19541
|
+
* Handle checkout callback
|
|
19542
|
+
* Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
|
|
19543
|
+
* @returns void
|
|
19544
|
+
* @throws ApiError
|
|
19545
|
+
*/
|
|
19546
|
+
static platformsItemsCheckoutCallbackRetrieve({
|
|
19547
|
+
itemId,
|
|
19548
|
+
itemType,
|
|
19549
|
+
platformKey,
|
|
19550
|
+
returnUrl
|
|
19551
|
+
}) {
|
|
19552
|
+
return request(OpenAPI, {
|
|
19553
|
+
method: 'GET',
|
|
19554
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/checkout-callback/',
|
|
19555
|
+
path: {
|
|
19556
|
+
'item_id': itemId,
|
|
19557
|
+
'item_type': itemType,
|
|
19558
|
+
'platform_key': platformKey
|
|
19559
|
+
},
|
|
19560
|
+
query: {
|
|
19561
|
+
'return_url': returnUrl
|
|
19562
|
+
},
|
|
19563
|
+
errors: {
|
|
19564
|
+
302: `No response body`
|
|
19565
|
+
}
|
|
19566
|
+
});
|
|
19567
|
+
}
|
|
19568
|
+
/**
|
|
19569
|
+
* Handle checkout callback
|
|
19570
|
+
* Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
|
|
19571
|
+
* @returns void
|
|
19572
|
+
* @throws ApiError
|
|
19573
|
+
*/
|
|
19574
|
+
static platformsItemsCheckoutCallbackRetrieve2({
|
|
19575
|
+
checkoutSessionId,
|
|
19576
|
+
itemId,
|
|
19577
|
+
itemType,
|
|
19578
|
+
platformKey,
|
|
19579
|
+
returnUrl
|
|
19580
|
+
}) {
|
|
19581
|
+
return request(OpenAPI, {
|
|
19582
|
+
method: 'GET',
|
|
19583
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/checkout-callback/{checkout_session_id}/',
|
|
19584
|
+
path: {
|
|
19585
|
+
'checkout_session_id': checkoutSessionId,
|
|
19586
|
+
'item_id': itemId,
|
|
19587
|
+
'item_type': itemType,
|
|
19588
|
+
'platform_key': platformKey
|
|
19589
|
+
},
|
|
19590
|
+
query: {
|
|
19591
|
+
'return_url': returnUrl
|
|
19592
|
+
},
|
|
19593
|
+
errors: {
|
|
19594
|
+
302: `No response body`
|
|
19595
|
+
}
|
|
19596
|
+
});
|
|
19597
|
+
}
|
|
19598
|
+
/**
|
|
19599
|
+
* Create guest checkout session
|
|
19600
|
+
* Create a Stripe checkout session for a guest user (email required).
|
|
19601
|
+
* @returns CheckoutSessionResponse
|
|
19602
|
+
* @throws ApiError
|
|
19603
|
+
*/
|
|
19604
|
+
static platformsItemsCheckoutGuestCreate({
|
|
19605
|
+
itemId,
|
|
19606
|
+
itemType,
|
|
19607
|
+
platformKey,
|
|
19608
|
+
requestBody
|
|
19609
|
+
}) {
|
|
19610
|
+
return request(OpenAPI, {
|
|
19611
|
+
method: 'POST',
|
|
19612
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/checkout-guest/',
|
|
19613
|
+
path: {
|
|
19614
|
+
'item_id': itemId,
|
|
19615
|
+
'item_type': itemType,
|
|
19616
|
+
'platform_key': platformKey
|
|
19617
|
+
},
|
|
19618
|
+
body: requestBody,
|
|
19619
|
+
mediaType: 'application/json'
|
|
19620
|
+
});
|
|
19621
|
+
}
|
|
19622
|
+
/**
|
|
19623
|
+
* Get paywall configuration
|
|
19624
|
+
* Retrieve the paywall configuration for an item. Returns default (disabled) config if none exists.
|
|
19625
|
+
* @returns ItemPaywallConfig
|
|
19626
|
+
* @throws ApiError
|
|
19627
|
+
*/
|
|
19628
|
+
static platformsItemsPaywallRetrieve({
|
|
19629
|
+
itemId,
|
|
19630
|
+
itemType,
|
|
19631
|
+
platformKey
|
|
19632
|
+
}) {
|
|
19633
|
+
return request(OpenAPI, {
|
|
19634
|
+
method: 'GET',
|
|
19635
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
|
|
19636
|
+
path: {
|
|
19637
|
+
'item_id': itemId,
|
|
19638
|
+
'item_type': itemType,
|
|
19639
|
+
'platform_key': platformKey
|
|
19640
|
+
}
|
|
19641
|
+
});
|
|
19642
|
+
}
|
|
19643
|
+
/**
|
|
19644
|
+
* Create or update paywall configuration
|
|
19645
|
+
* Enable or configure the paywall for an item. Creates a Stripe product on first enable.
|
|
19646
|
+
* @returns ItemPaywallConfig
|
|
19647
|
+
* @throws ApiError
|
|
19648
|
+
*/
|
|
19649
|
+
static platformsItemsPaywallCreate({
|
|
19650
|
+
itemId,
|
|
19651
|
+
itemType,
|
|
19652
|
+
platformKey,
|
|
19653
|
+
requestBody
|
|
19654
|
+
}) {
|
|
19655
|
+
return request(OpenAPI, {
|
|
19656
|
+
method: 'POST',
|
|
19657
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
|
|
19658
|
+
path: {
|
|
19659
|
+
'item_id': itemId,
|
|
19660
|
+
'item_type': itemType,
|
|
19661
|
+
'platform_key': platformKey
|
|
19662
|
+
},
|
|
19663
|
+
body: requestBody,
|
|
19664
|
+
mediaType: 'application/json'
|
|
19665
|
+
});
|
|
19666
|
+
}
|
|
19667
|
+
/**
|
|
19668
|
+
* Update paywall configuration
|
|
19669
|
+
* Same as POST. Update the paywall configuration for an item.
|
|
19670
|
+
* @returns ItemPaywallConfig
|
|
19671
|
+
* @throws ApiError
|
|
19672
|
+
*/
|
|
19673
|
+
static platformsItemsPaywallUpdate({
|
|
19674
|
+
itemId,
|
|
19675
|
+
itemType,
|
|
19676
|
+
platformKey,
|
|
19677
|
+
requestBody
|
|
19678
|
+
}) {
|
|
19679
|
+
return request(OpenAPI, {
|
|
19680
|
+
method: 'PUT',
|
|
19681
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
|
|
19682
|
+
path: {
|
|
19683
|
+
'item_id': itemId,
|
|
19684
|
+
'item_type': itemType,
|
|
19685
|
+
'platform_key': platformKey
|
|
19686
|
+
},
|
|
19687
|
+
body: requestBody,
|
|
19688
|
+
mediaType: 'application/json'
|
|
19689
|
+
});
|
|
19690
|
+
}
|
|
19691
|
+
/**
|
|
19692
|
+
* Disable paywall configuration
|
|
19693
|
+
* Disable the paywall for an item. Does not delete the configuration.
|
|
19694
|
+
* @returns void
|
|
19695
|
+
* @throws ApiError
|
|
19696
|
+
*/
|
|
19697
|
+
static platformsItemsPaywallDestroy({
|
|
19698
|
+
itemId,
|
|
19699
|
+
itemType,
|
|
19700
|
+
platformKey
|
|
19701
|
+
}) {
|
|
19702
|
+
return request(OpenAPI, {
|
|
19703
|
+
method: 'DELETE',
|
|
19704
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
|
|
19705
|
+
path: {
|
|
19706
|
+
'item_id': itemId,
|
|
19707
|
+
'item_type': itemType,
|
|
19708
|
+
'platform_key': platformKey
|
|
19709
|
+
}
|
|
19710
|
+
});
|
|
19711
|
+
}
|
|
19712
|
+
/**
|
|
19713
|
+
* List prices
|
|
19714
|
+
* List active prices for an item's paywall configuration.
|
|
19715
|
+
* @returns ItemPrice
|
|
19716
|
+
* @throws ApiError
|
|
19717
|
+
*/
|
|
19718
|
+
static platformsItemsPaywallPricesList({
|
|
19719
|
+
itemId,
|
|
19720
|
+
itemType,
|
|
19721
|
+
platformKey
|
|
19722
|
+
}) {
|
|
19723
|
+
return request(OpenAPI, {
|
|
19724
|
+
method: 'GET',
|
|
19725
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/',
|
|
19726
|
+
path: {
|
|
19727
|
+
'item_id': itemId,
|
|
19728
|
+
'item_type': itemType,
|
|
19729
|
+
'platform_key': platformKey
|
|
19730
|
+
}
|
|
19731
|
+
});
|
|
19732
|
+
}
|
|
19733
|
+
/**
|
|
19734
|
+
* Create a price
|
|
19735
|
+
* Create a new price tier for an item. Requires paywall to be enabled and Stripe Connect account ready.
|
|
19736
|
+
* @returns ItemPrice
|
|
19737
|
+
* @throws ApiError
|
|
19738
|
+
*/
|
|
19739
|
+
static platformsItemsPaywallPricesCreate({
|
|
19740
|
+
itemId,
|
|
19741
|
+
itemType,
|
|
19742
|
+
platformKey,
|
|
19743
|
+
requestBody
|
|
19744
|
+
}) {
|
|
19745
|
+
return request(OpenAPI, {
|
|
19746
|
+
method: 'POST',
|
|
19747
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/',
|
|
19748
|
+
path: {
|
|
19749
|
+
'item_id': itemId,
|
|
19750
|
+
'item_type': itemType,
|
|
19751
|
+
'platform_key': platformKey
|
|
19752
|
+
},
|
|
19753
|
+
body: requestBody,
|
|
19754
|
+
mediaType: 'application/json'
|
|
19755
|
+
});
|
|
19756
|
+
}
|
|
19757
|
+
/**
|
|
19758
|
+
* Get price details
|
|
19759
|
+
* Retrieve a specific price by ID.
|
|
19760
|
+
* @returns ItemPrice
|
|
19761
|
+
* @throws ApiError
|
|
19762
|
+
*/
|
|
19763
|
+
static platformsItemsPaywallPricesRetrieve({
|
|
19764
|
+
itemId,
|
|
19765
|
+
itemType,
|
|
19766
|
+
platformKey,
|
|
19767
|
+
priceId
|
|
19768
|
+
}) {
|
|
19769
|
+
return request(OpenAPI, {
|
|
19770
|
+
method: 'GET',
|
|
19771
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/{price_id}/',
|
|
19772
|
+
path: {
|
|
19773
|
+
'item_id': itemId,
|
|
19774
|
+
'item_type': itemType,
|
|
19775
|
+
'platform_key': platformKey,
|
|
19776
|
+
'price_id': priceId
|
|
19777
|
+
}
|
|
19778
|
+
});
|
|
19779
|
+
}
|
|
19780
|
+
/**
|
|
19781
|
+
* Update a price
|
|
19782
|
+
* Update a price tier. If pricing fields change and a Stripe price exists, a new Stripe price is created and the old one deactivated.
|
|
19783
|
+
* @returns ItemPrice
|
|
19784
|
+
* @throws ApiError
|
|
19785
|
+
*/
|
|
19786
|
+
static platformsItemsPaywallPricesUpdate({
|
|
19787
|
+
itemId,
|
|
19788
|
+
itemType,
|
|
19789
|
+
platformKey,
|
|
19790
|
+
priceId,
|
|
19791
|
+
requestBody
|
|
19792
|
+
}) {
|
|
19793
|
+
return request(OpenAPI, {
|
|
19794
|
+
method: 'PUT',
|
|
19795
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/{price_id}/',
|
|
19796
|
+
path: {
|
|
19797
|
+
'item_id': itemId,
|
|
19798
|
+
'item_type': itemType,
|
|
19799
|
+
'platform_key': platformKey,
|
|
19800
|
+
'price_id': priceId
|
|
19801
|
+
},
|
|
19802
|
+
body: requestBody,
|
|
19803
|
+
mediaType: 'application/json'
|
|
19804
|
+
});
|
|
19805
|
+
}
|
|
19806
|
+
/**
|
|
19807
|
+
* Delete a price
|
|
19808
|
+
* Soft-delete a price tier and deactivate the corresponding Stripe price.
|
|
19809
|
+
* @returns void
|
|
19810
|
+
* @throws ApiError
|
|
19811
|
+
*/
|
|
19812
|
+
static platformsItemsPaywallPricesDestroy({
|
|
19813
|
+
itemId,
|
|
19814
|
+
itemType,
|
|
19815
|
+
platformKey,
|
|
19816
|
+
priceId
|
|
19817
|
+
}) {
|
|
19818
|
+
return request(OpenAPI, {
|
|
19819
|
+
method: 'DELETE',
|
|
19820
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/{price_id}/',
|
|
19821
|
+
path: {
|
|
19822
|
+
'item_id': itemId,
|
|
19823
|
+
'item_type': itemType,
|
|
19824
|
+
'platform_key': platformKey,
|
|
19825
|
+
'price_id': priceId
|
|
19826
|
+
}
|
|
19827
|
+
});
|
|
19828
|
+
}
|
|
19829
|
+
/**
|
|
19830
|
+
* Get public pricing
|
|
19831
|
+
* Retrieve public pricing information for an item. No authentication required.
|
|
19832
|
+
* @returns PublicItemPricing
|
|
19833
|
+
* @throws ApiError
|
|
19834
|
+
*/
|
|
19835
|
+
static platformsItemsPricingRetrieve({
|
|
19836
|
+
itemId,
|
|
19837
|
+
itemType,
|
|
19838
|
+
platformKey
|
|
19839
|
+
}) {
|
|
19840
|
+
return request(OpenAPI, {
|
|
19841
|
+
method: 'GET',
|
|
19842
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/pricing/',
|
|
19843
|
+
path: {
|
|
19844
|
+
'item_id': itemId,
|
|
19845
|
+
'item_type': itemType,
|
|
19846
|
+
'platform_key': platformKey
|
|
19847
|
+
}
|
|
19848
|
+
});
|
|
19849
|
+
}
|
|
19850
|
+
/**
|
|
19851
|
+
* List item subscribers
|
|
19852
|
+
* List all subscribers for an item. Optionally filter by subscription status.
|
|
19853
|
+
* @returns PaginatedItemSubscriptionList
|
|
19854
|
+
* @throws ApiError
|
|
19855
|
+
*/
|
|
19856
|
+
static platformsItemsSubscribersList({
|
|
19857
|
+
itemId,
|
|
19858
|
+
itemType,
|
|
19859
|
+
platformKey,
|
|
19860
|
+
page,
|
|
19861
|
+
pageSize,
|
|
19862
|
+
status
|
|
19863
|
+
}) {
|
|
19864
|
+
return request(OpenAPI, {
|
|
19865
|
+
method: 'GET',
|
|
19866
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/subscribers/',
|
|
19867
|
+
path: {
|
|
19868
|
+
'item_id': itemId,
|
|
19869
|
+
'item_type': itemType,
|
|
19870
|
+
'platform_key': platformKey
|
|
19871
|
+
},
|
|
19872
|
+
query: {
|
|
19873
|
+
'page': page,
|
|
19874
|
+
'page_size': pageSize,
|
|
19875
|
+
'status': status
|
|
19876
|
+
}
|
|
19877
|
+
});
|
|
19878
|
+
}
|
|
19879
|
+
/**
|
|
19880
|
+
* Get user subscription
|
|
19881
|
+
* Retrieve the current user's subscription to an item.
|
|
19882
|
+
* @returns ItemSubscription
|
|
19883
|
+
* @throws ApiError
|
|
19884
|
+
*/
|
|
19885
|
+
static platformsItemsSubscriptionRetrieve({
|
|
19886
|
+
itemId,
|
|
19887
|
+
itemType,
|
|
19888
|
+
platformKey
|
|
19889
|
+
}) {
|
|
19890
|
+
return request(OpenAPI, {
|
|
19891
|
+
method: 'GET',
|
|
19892
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/subscription/',
|
|
19893
|
+
path: {
|
|
19894
|
+
'item_id': itemId,
|
|
19895
|
+
'item_type': itemType,
|
|
19896
|
+
'platform_key': platformKey
|
|
19897
|
+
}
|
|
19898
|
+
});
|
|
19899
|
+
}
|
|
19900
|
+
/**
|
|
19901
|
+
* Cancel subscription
|
|
19902
|
+
* Cancel the current user's subscription. Returns a Stripe customer portal URL for recurring subscriptions, or cancels directly for one-time purchases.
|
|
19903
|
+
* @returns PortalUrlResponse
|
|
19904
|
+
* @throws ApiError
|
|
19905
|
+
*/
|
|
19906
|
+
static platformsItemsSubscriptionCancelCreate({
|
|
19907
|
+
itemId,
|
|
19908
|
+
itemType,
|
|
19909
|
+
platformKey
|
|
19910
|
+
}) {
|
|
19911
|
+
return request(OpenAPI, {
|
|
19912
|
+
method: 'POST',
|
|
19913
|
+
url: '/platforms/{platform_key}/items/{item_type}/{item_id}/subscription/cancel/',
|
|
19914
|
+
path: {
|
|
19915
|
+
'item_id': itemId,
|
|
19916
|
+
'item_type': itemType,
|
|
19917
|
+
'platform_key': platformKey
|
|
19918
|
+
}
|
|
19919
|
+
});
|
|
19920
|
+
}
|
|
19921
|
+
/**
|
|
19922
|
+
* List user subscriptions
|
|
19923
|
+
* Paginated list of the current user's subscriptions on a platform. Optionally filter by status or item_type.
|
|
19924
|
+
* @returns PaginatedItemSubscriptionListList
|
|
19925
|
+
* @throws ApiError
|
|
19926
|
+
*/
|
|
19927
|
+
static platformsMySubscriptionsList({
|
|
19928
|
+
platformKey,
|
|
19929
|
+
itemType,
|
|
19930
|
+
page,
|
|
19931
|
+
pageSize,
|
|
19932
|
+
status
|
|
19933
|
+
}) {
|
|
19934
|
+
return request(OpenAPI, {
|
|
19935
|
+
method: 'GET',
|
|
19936
|
+
url: '/platforms/{platform_key}/my-subscriptions/',
|
|
19937
|
+
path: {
|
|
19938
|
+
'platform_key': platformKey
|
|
19939
|
+
},
|
|
19940
|
+
query: {
|
|
19941
|
+
'item_type': itemType,
|
|
19942
|
+
'page': page,
|
|
19943
|
+
'page_size': pageSize,
|
|
19944
|
+
'status': status
|
|
19945
|
+
}
|
|
19946
|
+
});
|
|
19947
|
+
}
|
|
19948
|
+
}
|
|
19949
|
+
|
|
18973
19950
|
class RecommendationsService {
|
|
18974
19951
|
/**
|
|
18975
19952
|
* API endpoint that returns a search api url prepopulated with context data
|
|
@@ -20676,6 +21653,7 @@ exports.FeaturesService = FeaturesService;
|
|
|
20676
21653
|
exports.MediaService = MediaService;
|
|
20677
21654
|
exports.NotificationsService = NotificationsService;
|
|
20678
21655
|
exports.OpenAPI = OpenAPI;
|
|
21656
|
+
exports.PlatformsService = PlatformsService;
|
|
20679
21657
|
exports.RecommendationsService = RecommendationsService;
|
|
20680
21658
|
exports.ReportsService = ReportsService;
|
|
20681
21659
|
exports.ScimService = ScimService;
|