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