@iblai/iblai-api 4.223.0-core → 4.224.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 +93 -47
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +92 -48
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +93 -47
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +3 -3
- package/dist/types/models/CheckoutSessionCreate.d.ts +1 -1
- package/dist/types/models/ItemAccessCheckResponse.d.ts +2 -8
- package/dist/types/models/ItemPaywallConfig.d.ts +7 -8
- package/dist/types/models/ItemPaywallConfigCreate.d.ts +2 -0
- package/dist/types/models/ItemSubscription.d.ts +1 -7
- package/dist/types/models/ItemSubscriptionList.d.ts +1 -7
- package/dist/types/models/{MediaResourceItemTypeEnum.d.ts → ItemTypeEnum.d.ts} +1 -1
- package/dist/types/models/MediaResource.d.ts +2 -2
- package/dist/types/models/PatchedMediaResource.d.ts +2 -2
- package/dist/types/models/PublicItemPricing.d.ts +1 -2
- package/dist/types/services/BillingService.d.ts +24 -23
- package/dist/types/services/ItemsService.d.ts +13 -0
- package/dist/types/services/PlatformsService.d.ts +5 -23
- package/dist/types/services/PricesService.d.ts +15 -0
- package/package.json +1 -1
- package/sdk_schema.yml +189 -149
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +3 -3
- package/src/models/CheckoutSessionCreate.ts +1 -1
- package/src/models/ItemAccessCheckResponse.ts +2 -8
- package/src/models/ItemPaywallConfig.ts +7 -8
- package/src/models/ItemPaywallConfigCreate.ts +2 -0
- package/src/models/ItemSubscription.ts +1 -7
- package/src/models/ItemSubscriptionList.ts +1 -7
- package/src/models/{MediaResourceItemTypeEnum.ts → ItemTypeEnum.ts} +1 -1
- package/src/models/MediaResource.ts +2 -2
- package/src/models/PatchedMediaResource.ts +2 -2
- package/src/models/PublicItemPricing.ts +1 -2
- package/src/services/BillingService.ts +47 -23
- package/src/services/ItemsService.ts +29 -0
- package/src/services/PlatformsService.ts +5 -23
- package/src/services/PricesService.ts +34 -0
- package/dist/types/models/ItemType3e2Enum.d.ts +0 -12
- package/dist/types/models/ItemType40fEnum.d.ts +0 -12
- package/src/models/ItemType3e2Enum.ts +0 -16
- package/src/models/ItemType40fEnum.ts +0 -16
|
@@ -34,7 +34,7 @@ export declare class PlatformsService {
|
|
|
34
34
|
itemId: string;
|
|
35
35
|
itemType: string;
|
|
36
36
|
platformKey: string;
|
|
37
|
-
requestBody
|
|
37
|
+
requestBody?: CheckoutSessionCreate;
|
|
38
38
|
}): CancelablePromise<CheckoutSessionResponse>;
|
|
39
39
|
/**
|
|
40
40
|
* Handle checkout callback
|
|
@@ -71,7 +71,7 @@ export declare class PlatformsService {
|
|
|
71
71
|
itemId: string;
|
|
72
72
|
itemType: string;
|
|
73
73
|
platformKey: string;
|
|
74
|
-
requestBody
|
|
74
|
+
requestBody?: CheckoutSessionCreate;
|
|
75
75
|
}): CancelablePromise<CheckoutSessionResponse>;
|
|
76
76
|
/**
|
|
77
77
|
* Get paywall configuration
|
|
@@ -250,13 +250,7 @@ export declare class PlatformsService {
|
|
|
250
250
|
*/
|
|
251
251
|
static platformsMySubscriptionsList({ platformKey, itemType, page, pageSize, search, status, }: {
|
|
252
252
|
platformKey: string;
|
|
253
|
-
|
|
254
|
-
* * `mentor` - mentor
|
|
255
|
-
* * `course` - course
|
|
256
|
-
* * `program` - program
|
|
257
|
-
* * `pathway` - pathway
|
|
258
|
-
*/
|
|
259
|
-
itemType?: 'mentor' | 'course' | 'program' | 'pathway';
|
|
253
|
+
itemType?: string;
|
|
260
254
|
/**
|
|
261
255
|
* A page number within the paginated result set.
|
|
262
256
|
*/
|
|
@@ -286,13 +280,7 @@ export declare class PlatformsService {
|
|
|
286
280
|
static platformsPaywallsList({ platformKey, isEnabled, itemType, page, pageSize, search, }: {
|
|
287
281
|
platformKey: string;
|
|
288
282
|
isEnabled?: boolean | null;
|
|
289
|
-
|
|
290
|
-
* * `mentor` - mentor
|
|
291
|
-
* * `course` - course
|
|
292
|
-
* * `program` - program
|
|
293
|
-
* * `pathway` - pathway
|
|
294
|
-
*/
|
|
295
|
-
itemType?: 'mentor' | 'course' | 'program' | 'pathway';
|
|
283
|
+
itemType?: string;
|
|
296
284
|
/**
|
|
297
285
|
* A page number within the paginated result set.
|
|
298
286
|
*/
|
|
@@ -320,13 +308,7 @@ export declare class PlatformsService {
|
|
|
320
308
|
*/
|
|
321
309
|
static platformsSubscribersList({ platformKey, itemType, page, pageSize, search, status, }: {
|
|
322
310
|
platformKey: string;
|
|
323
|
-
|
|
324
|
-
* * `mentor` - mentor
|
|
325
|
-
* * `course` - course
|
|
326
|
-
* * `program` - program
|
|
327
|
-
* * `pathway` - pathway
|
|
328
|
-
*/
|
|
329
|
-
itemType?: 'mentor' | 'course' | 'program' | 'pathway';
|
|
311
|
+
itemType?: string;
|
|
330
312
|
/**
|
|
331
313
|
* A page number within the paginated result set.
|
|
332
314
|
*/
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { CheckoutSessionCreate } from '../models/CheckoutSessionCreate';
|
|
2
|
+
import type { CheckoutSessionResponse } from '../models/CheckoutSessionResponse';
|
|
3
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
4
|
+
export declare class PricesService {
|
|
5
|
+
/**
|
|
6
|
+
* Create guest checkout session by price unique_id
|
|
7
|
+
* Looks up the price by its unique_id, derives platform/item_type/item_id, and delegates to the standard guest checkout flow.
|
|
8
|
+
* @returns CheckoutSessionResponse
|
|
9
|
+
* @throws ApiError
|
|
10
|
+
*/
|
|
11
|
+
static pricesCheckoutGuestCreate({ priceUniqueId, requestBody, }: {
|
|
12
|
+
priceUniqueId: string;
|
|
13
|
+
requestBody?: CheckoutSessionCreate;
|
|
14
|
+
}): CancelablePromise<CheckoutSessionResponse>;
|
|
15
|
+
}
|
package/package.json
CHANGED
package/sdk_schema.yml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
openapi: 3.0.3
|
|
2
2
|
info:
|
|
3
3
|
title: ibl-data-manager
|
|
4
|
-
version: 4.
|
|
4
|
+
version: 4.224.0-core
|
|
5
5
|
description: API for iblai
|
|
6
6
|
paths:
|
|
7
7
|
/access-check/{item_type}/{item_id}/:
|
|
@@ -2071,6 +2071,30 @@ paths:
|
|
|
2071
2071
|
schema:
|
|
2072
2072
|
$ref: '#/components/schemas/ErrorDetail'
|
|
2073
2073
|
description: ''
|
|
2074
|
+
/api/billing/items/{config_unique_id}/public-pricing/:
|
|
2075
|
+
get:
|
|
2076
|
+
operationId: billing_items_public_pricing_retrieve
|
|
2077
|
+
description: Looks up the paywall config by its unique_id and delegates to the
|
|
2078
|
+
standard public pricing endpoint.
|
|
2079
|
+
summary: Get public pricing by paywall config unique_id
|
|
2080
|
+
parameters:
|
|
2081
|
+
- in: path
|
|
2082
|
+
name: config_unique_id
|
|
2083
|
+
schema:
|
|
2084
|
+
type: string
|
|
2085
|
+
format: uuid
|
|
2086
|
+
required: true
|
|
2087
|
+
tags:
|
|
2088
|
+
- billing
|
|
2089
|
+
security:
|
|
2090
|
+
- {}
|
|
2091
|
+
responses:
|
|
2092
|
+
'200':
|
|
2093
|
+
content:
|
|
2094
|
+
application/json:
|
|
2095
|
+
schema:
|
|
2096
|
+
$ref: '#/components/schemas/PublicItemPricing'
|
|
2097
|
+
description: ''
|
|
2074
2098
|
/api/billing/platforms/{platform_key}/items/{item_type}/{item_id}/access-check/:
|
|
2075
2099
|
get:
|
|
2076
2100
|
operationId: billing_platforms_items_access_check_retrieve
|
|
@@ -2150,7 +2174,6 @@ paths:
|
|
|
2150
2174
|
'*/*':
|
|
2151
2175
|
schema:
|
|
2152
2176
|
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
2153
|
-
required: true
|
|
2154
2177
|
security:
|
|
2155
2178
|
- PlatformApiKeyAuthentication: []
|
|
2156
2179
|
responses:
|
|
@@ -2277,7 +2300,6 @@ paths:
|
|
|
2277
2300
|
'*/*':
|
|
2278
2301
|
schema:
|
|
2279
2302
|
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
2280
|
-
required: true
|
|
2281
2303
|
security:
|
|
2282
2304
|
- {}
|
|
2283
2305
|
responses:
|
|
@@ -2847,18 +2869,9 @@ paths:
|
|
|
2847
2869
|
- in: query
|
|
2848
2870
|
name: item_type
|
|
2849
2871
|
schema:
|
|
2850
|
-
enum:
|
|
2851
|
-
- mentor
|
|
2852
|
-
- course
|
|
2853
|
-
- program
|
|
2854
|
-
- pathway
|
|
2855
2872
|
type: string
|
|
2873
|
+
maxLength: 50
|
|
2856
2874
|
minLength: 1
|
|
2857
|
-
description: |-
|
|
2858
|
-
* `mentor` - mentor
|
|
2859
|
-
* `course` - course
|
|
2860
|
-
* `program` - program
|
|
2861
|
-
* `pathway` - pathway
|
|
2862
2875
|
- name: page
|
|
2863
2876
|
required: false
|
|
2864
2877
|
in: query
|
|
@@ -2928,18 +2941,9 @@ paths:
|
|
|
2928
2941
|
- in: query
|
|
2929
2942
|
name: item_type
|
|
2930
2943
|
schema:
|
|
2931
|
-
enum:
|
|
2932
|
-
- mentor
|
|
2933
|
-
- course
|
|
2934
|
-
- program
|
|
2935
|
-
- pathway
|
|
2936
2944
|
type: string
|
|
2945
|
+
maxLength: 50
|
|
2937
2946
|
minLength: 1
|
|
2938
|
-
description: |-
|
|
2939
|
-
* `mentor` - mentor
|
|
2940
|
-
* `course` - course
|
|
2941
|
-
* `program` - program
|
|
2942
|
-
* `pathway` - pathway
|
|
2943
2947
|
- name: page
|
|
2944
2948
|
required: false
|
|
2945
2949
|
in: query
|
|
@@ -3006,18 +3010,9 @@ paths:
|
|
|
3006
3010
|
- in: query
|
|
3007
3011
|
name: item_type
|
|
3008
3012
|
schema:
|
|
3009
|
-
enum:
|
|
3010
|
-
- mentor
|
|
3011
|
-
- course
|
|
3012
|
-
- program
|
|
3013
|
-
- pathway
|
|
3014
3013
|
type: string
|
|
3014
|
+
maxLength: 50
|
|
3015
3015
|
minLength: 1
|
|
3016
|
-
description: |-
|
|
3017
|
-
* `mentor` - mentor
|
|
3018
|
-
* `course` - course
|
|
3019
|
-
* `program` - program
|
|
3020
|
-
* `pathway` - pathway
|
|
3021
3016
|
- name: page
|
|
3022
3017
|
required: false
|
|
3023
3018
|
in: query
|
|
@@ -3072,6 +3067,47 @@ paths:
|
|
|
3072
3067
|
schema:
|
|
3073
3068
|
$ref: '#/components/schemas/PaginatedItemSubscriptionListList'
|
|
3074
3069
|
description: ''
|
|
3070
|
+
/api/billing/prices/{price_unique_id}/checkout-guest/:
|
|
3071
|
+
post:
|
|
3072
|
+
operationId: billing_prices_checkout_guest_create
|
|
3073
|
+
description: Looks up the price by its unique_id, derives platform/item_type/item_id,
|
|
3074
|
+
and delegates to the standard guest checkout flow.
|
|
3075
|
+
summary: Create guest checkout session by price unique_id
|
|
3076
|
+
parameters:
|
|
3077
|
+
- in: path
|
|
3078
|
+
name: price_unique_id
|
|
3079
|
+
schema:
|
|
3080
|
+
type: string
|
|
3081
|
+
format: uuid
|
|
3082
|
+
required: true
|
|
3083
|
+
tags:
|
|
3084
|
+
- billing
|
|
3085
|
+
requestBody:
|
|
3086
|
+
content:
|
|
3087
|
+
application/json:
|
|
3088
|
+
schema:
|
|
3089
|
+
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
3090
|
+
application/scim+json:
|
|
3091
|
+
schema:
|
|
3092
|
+
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
3093
|
+
application/x-www-form-urlencoded:
|
|
3094
|
+
schema:
|
|
3095
|
+
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
3096
|
+
multipart/form-data:
|
|
3097
|
+
schema:
|
|
3098
|
+
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
3099
|
+
'*/*':
|
|
3100
|
+
schema:
|
|
3101
|
+
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
3102
|
+
security:
|
|
3103
|
+
- {}
|
|
3104
|
+
responses:
|
|
3105
|
+
'200':
|
|
3106
|
+
content:
|
|
3107
|
+
application/json:
|
|
3108
|
+
schema:
|
|
3109
|
+
$ref: '#/components/schemas/CheckoutSessionResponse'
|
|
3110
|
+
description: ''
|
|
3075
3111
|
/api/billing/transactions/:
|
|
3076
3112
|
get:
|
|
3077
3113
|
operationId: billing_transactions_retrieve
|
|
@@ -34582,6 +34618,30 @@ paths:
|
|
|
34582
34618
|
responses:
|
|
34583
34619
|
'200':
|
|
34584
34620
|
description: No response body
|
|
34621
|
+
/items/{config_unique_id}/public-pricing/:
|
|
34622
|
+
get:
|
|
34623
|
+
operationId: items_public_pricing_retrieve
|
|
34624
|
+
description: Looks up the paywall config by its unique_id and delegates to the
|
|
34625
|
+
standard public pricing endpoint.
|
|
34626
|
+
summary: Get public pricing by paywall config unique_id
|
|
34627
|
+
parameters:
|
|
34628
|
+
- in: path
|
|
34629
|
+
name: config_unique_id
|
|
34630
|
+
schema:
|
|
34631
|
+
type: string
|
|
34632
|
+
format: uuid
|
|
34633
|
+
required: true
|
|
34634
|
+
tags:
|
|
34635
|
+
- items
|
|
34636
|
+
security:
|
|
34637
|
+
- {}
|
|
34638
|
+
responses:
|
|
34639
|
+
'200':
|
|
34640
|
+
content:
|
|
34641
|
+
application/json:
|
|
34642
|
+
schema:
|
|
34643
|
+
$ref: '#/components/schemas/PublicItemPricing'
|
|
34644
|
+
description: ''
|
|
34585
34645
|
/platforms/{platform_key}/items/{item_type}/{item_id}/access-check/:
|
|
34586
34646
|
get:
|
|
34587
34647
|
operationId: platforms_items_access_check_retrieve
|
|
@@ -34661,7 +34721,6 @@ paths:
|
|
|
34661
34721
|
'*/*':
|
|
34662
34722
|
schema:
|
|
34663
34723
|
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
34664
|
-
required: true
|
|
34665
34724
|
security:
|
|
34666
34725
|
- PlatformApiKeyAuthentication: []
|
|
34667
34726
|
responses:
|
|
@@ -34788,7 +34847,6 @@ paths:
|
|
|
34788
34847
|
'*/*':
|
|
34789
34848
|
schema:
|
|
34790
34849
|
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
34791
|
-
required: true
|
|
34792
34850
|
security:
|
|
34793
34851
|
- {}
|
|
34794
34852
|
responses:
|
|
@@ -35358,18 +35416,9 @@ paths:
|
|
|
35358
35416
|
- in: query
|
|
35359
35417
|
name: item_type
|
|
35360
35418
|
schema:
|
|
35361
|
-
enum:
|
|
35362
|
-
- mentor
|
|
35363
|
-
- course
|
|
35364
|
-
- program
|
|
35365
|
-
- pathway
|
|
35366
35419
|
type: string
|
|
35420
|
+
maxLength: 50
|
|
35367
35421
|
minLength: 1
|
|
35368
|
-
description: |-
|
|
35369
|
-
* `mentor` - mentor
|
|
35370
|
-
* `course` - course
|
|
35371
|
-
* `program` - program
|
|
35372
|
-
* `pathway` - pathway
|
|
35373
35422
|
- name: page
|
|
35374
35423
|
required: false
|
|
35375
35424
|
in: query
|
|
@@ -35439,18 +35488,9 @@ paths:
|
|
|
35439
35488
|
- in: query
|
|
35440
35489
|
name: item_type
|
|
35441
35490
|
schema:
|
|
35442
|
-
enum:
|
|
35443
|
-
- mentor
|
|
35444
|
-
- course
|
|
35445
|
-
- program
|
|
35446
|
-
- pathway
|
|
35447
35491
|
type: string
|
|
35492
|
+
maxLength: 50
|
|
35448
35493
|
minLength: 1
|
|
35449
|
-
description: |-
|
|
35450
|
-
* `mentor` - mentor
|
|
35451
|
-
* `course` - course
|
|
35452
|
-
* `program` - program
|
|
35453
|
-
* `pathway` - pathway
|
|
35454
35494
|
- name: page
|
|
35455
35495
|
required: false
|
|
35456
35496
|
in: query
|
|
@@ -35517,18 +35557,9 @@ paths:
|
|
|
35517
35557
|
- in: query
|
|
35518
35558
|
name: item_type
|
|
35519
35559
|
schema:
|
|
35520
|
-
enum:
|
|
35521
|
-
- mentor
|
|
35522
|
-
- course
|
|
35523
|
-
- program
|
|
35524
|
-
- pathway
|
|
35525
35560
|
type: string
|
|
35561
|
+
maxLength: 50
|
|
35526
35562
|
minLength: 1
|
|
35527
|
-
description: |-
|
|
35528
|
-
* `mentor` - mentor
|
|
35529
|
-
* `course` - course
|
|
35530
|
-
* `program` - program
|
|
35531
|
-
* `pathway` - pathway
|
|
35532
35563
|
- name: page
|
|
35533
35564
|
required: false
|
|
35534
35565
|
in: query
|
|
@@ -35583,6 +35614,47 @@ paths:
|
|
|
35583
35614
|
schema:
|
|
35584
35615
|
$ref: '#/components/schemas/PaginatedItemSubscriptionListList'
|
|
35585
35616
|
description: ''
|
|
35617
|
+
/prices/{price_unique_id}/checkout-guest/:
|
|
35618
|
+
post:
|
|
35619
|
+
operationId: prices_checkout_guest_create
|
|
35620
|
+
description: Looks up the price by its unique_id, derives platform/item_type/item_id,
|
|
35621
|
+
and delegates to the standard guest checkout flow.
|
|
35622
|
+
summary: Create guest checkout session by price unique_id
|
|
35623
|
+
parameters:
|
|
35624
|
+
- in: path
|
|
35625
|
+
name: price_unique_id
|
|
35626
|
+
schema:
|
|
35627
|
+
type: string
|
|
35628
|
+
format: uuid
|
|
35629
|
+
required: true
|
|
35630
|
+
tags:
|
|
35631
|
+
- prices
|
|
35632
|
+
requestBody:
|
|
35633
|
+
content:
|
|
35634
|
+
application/json:
|
|
35635
|
+
schema:
|
|
35636
|
+
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
35637
|
+
application/scim+json:
|
|
35638
|
+
schema:
|
|
35639
|
+
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
35640
|
+
application/x-www-form-urlencoded:
|
|
35641
|
+
schema:
|
|
35642
|
+
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
35643
|
+
multipart/form-data:
|
|
35644
|
+
schema:
|
|
35645
|
+
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
35646
|
+
'*/*':
|
|
35647
|
+
schema:
|
|
35648
|
+
$ref: '#/components/schemas/CheckoutSessionCreate'
|
|
35649
|
+
security:
|
|
35650
|
+
- {}
|
|
35651
|
+
responses:
|
|
35652
|
+
'200':
|
|
35653
|
+
content:
|
|
35654
|
+
application/json:
|
|
35655
|
+
schema:
|
|
35656
|
+
$ref: '#/components/schemas/CheckoutSessionResponse'
|
|
35657
|
+
description: ''
|
|
35586
35658
|
/transactions/:
|
|
35587
35659
|
get:
|
|
35588
35660
|
operationId: transactions_retrieve
|
|
@@ -36407,8 +36479,6 @@ components:
|
|
|
36407
36479
|
type: string
|
|
36408
36480
|
format: email
|
|
36409
36481
|
nullable: true
|
|
36410
|
-
required:
|
|
36411
|
-
- price_id
|
|
36412
36482
|
CheckoutSessionResponse:
|
|
36413
36483
|
type: object
|
|
36414
36484
|
description: Response returned after creating a Stripe checkout session.
|
|
@@ -39462,15 +39532,10 @@ components:
|
|
|
39462
39532
|
type: boolean
|
|
39463
39533
|
description: True if the user can access the item.
|
|
39464
39534
|
item_type:
|
|
39465
|
-
|
|
39466
|
-
|
|
39467
|
-
|
|
39468
|
-
|
|
39469
|
-
|
|
39470
|
-
* `mentor` - mentor
|
|
39471
|
-
* `course` - course
|
|
39472
|
-
* `program` - program
|
|
39473
|
-
* `pathway` - pathway
|
|
39535
|
+
type: string
|
|
39536
|
+
description: Item type that was checked (e.g. 'mentor', 'workshop').
|
|
39537
|
+
pattern: ^(?:custom:)?[a-z][a-z0-9_-]*$
|
|
39538
|
+
maxLength: 50
|
|
39474
39539
|
item_id:
|
|
39475
39540
|
type: string
|
|
39476
39541
|
description: ID of the item that was checked.
|
|
@@ -39502,16 +39567,15 @@ components:
|
|
|
39502
39567
|
ItemPaywallConfig:
|
|
39503
39568
|
type: object
|
|
39504
39569
|
properties:
|
|
39570
|
+
unique_id:
|
|
39571
|
+
type: string
|
|
39572
|
+
format: uuid
|
|
39573
|
+
readOnly: true
|
|
39505
39574
|
item_type:
|
|
39506
|
-
|
|
39507
|
-
|
|
39508
|
-
|
|
39509
|
-
|
|
39510
|
-
|
|
39511
|
-
* `mentor` - Mentor
|
|
39512
|
-
* `course` - Course
|
|
39513
|
-
* `program` - Program
|
|
39514
|
-
* `pathway` - Pathway
|
|
39575
|
+
type: string
|
|
39576
|
+
description: Type of item being paywalled (e.g. mentor, course, program,
|
|
39577
|
+
or custom types)
|
|
39578
|
+
maxLength: 50
|
|
39515
39579
|
item_id:
|
|
39516
39580
|
type: string
|
|
39517
39581
|
description: Identifier for the item (UUID for mentors, slug/key for others)
|
|
@@ -39519,6 +39583,9 @@ components:
|
|
|
39519
39583
|
item_name:
|
|
39520
39584
|
type: string
|
|
39521
39585
|
readOnly: true
|
|
39586
|
+
item_metadata:
|
|
39587
|
+
nullable: true
|
|
39588
|
+
description: Arbitrary metadata for the item (custom types only).
|
|
39522
39589
|
is_enabled:
|
|
39523
39590
|
type: boolean
|
|
39524
39591
|
description: Whether the paywall is enabled for this item
|
|
@@ -39572,10 +39639,15 @@ components:
|
|
|
39572
39639
|
- paywall_enabled_at
|
|
39573
39640
|
- prices
|
|
39574
39641
|
- stripe_product_id
|
|
39642
|
+
- unique_id
|
|
39575
39643
|
- updated_at
|
|
39576
39644
|
ItemPaywallConfigCreate:
|
|
39577
39645
|
type: object
|
|
39578
39646
|
properties:
|
|
39647
|
+
item_name:
|
|
39648
|
+
type: string
|
|
39649
|
+
maxLength: 255
|
|
39650
|
+
item_metadata: {}
|
|
39579
39651
|
is_enabled:
|
|
39580
39652
|
type: boolean
|
|
39581
39653
|
description:
|
|
@@ -39586,7 +39658,9 @@ components:
|
|
|
39586
39658
|
type: integer
|
|
39587
39659
|
minimum: 0
|
|
39588
39660
|
grandfathering_strategy:
|
|
39589
|
-
|
|
39661
|
+
allOf:
|
|
39662
|
+
- $ref: '#/components/schemas/GrandfatheringStrategyEnum'
|
|
39663
|
+
default: require_subscription
|
|
39590
39664
|
ItemPrice:
|
|
39591
39665
|
type: object
|
|
39592
39666
|
properties:
|
|
@@ -39717,15 +39791,9 @@ components:
|
|
|
39717
39791
|
format: email
|
|
39718
39792
|
readOnly: true
|
|
39719
39793
|
item_type:
|
|
39720
|
-
|
|
39721
|
-
|
|
39722
|
-
|
|
39723
|
-
Type of item being subscribed to
|
|
39724
|
-
|
|
39725
|
-
* `mentor` - Mentor
|
|
39726
|
-
* `course` - Course
|
|
39727
|
-
* `program` - Program
|
|
39728
|
-
* `pathway` - Pathway
|
|
39794
|
+
type: string
|
|
39795
|
+
description: Type of item being subscribed to
|
|
39796
|
+
maxLength: 50
|
|
39729
39797
|
item_id:
|
|
39730
39798
|
type: string
|
|
39731
39799
|
description: Identifier for the item
|
|
@@ -39826,15 +39894,9 @@ components:
|
|
|
39826
39894
|
format: email
|
|
39827
39895
|
readOnly: true
|
|
39828
39896
|
item_type:
|
|
39829
|
-
|
|
39830
|
-
|
|
39831
|
-
|
|
39832
|
-
Type of item being subscribed to
|
|
39833
|
-
|
|
39834
|
-
* `mentor` - Mentor
|
|
39835
|
-
* `course` - Course
|
|
39836
|
-
* `program` - Program
|
|
39837
|
-
* `pathway` - Pathway
|
|
39897
|
+
type: string
|
|
39898
|
+
description: Type of item being subscribed to
|
|
39899
|
+
maxLength: 50
|
|
39838
39900
|
item_id:
|
|
39839
39901
|
type: string
|
|
39840
39902
|
description: Identifier for the item
|
|
@@ -39878,30 +39940,6 @@ components:
|
|
|
39878
39940
|
- updated_at
|
|
39879
39941
|
- user_id
|
|
39880
39942
|
- username
|
|
39881
|
-
ItemType3e2Enum:
|
|
39882
|
-
enum:
|
|
39883
|
-
- mentor
|
|
39884
|
-
- course
|
|
39885
|
-
- program
|
|
39886
|
-
- pathway
|
|
39887
|
-
type: string
|
|
39888
|
-
description: |-
|
|
39889
|
-
* `mentor` - mentor
|
|
39890
|
-
* `course` - course
|
|
39891
|
-
* `program` - program
|
|
39892
|
-
* `pathway` - pathway
|
|
39893
|
-
ItemType40fEnum:
|
|
39894
|
-
enum:
|
|
39895
|
-
- mentor
|
|
39896
|
-
- course
|
|
39897
|
-
- program
|
|
39898
|
-
- pathway
|
|
39899
|
-
type: string
|
|
39900
|
-
description: |-
|
|
39901
|
-
* `mentor` - Mentor
|
|
39902
|
-
* `course` - Course
|
|
39903
|
-
* `program` - Program
|
|
39904
|
-
* `pathway` - Pathway
|
|
39905
39943
|
ItemTypeCommission:
|
|
39906
39944
|
type: object
|
|
39907
39945
|
description: Commission percentages keyed by item type.
|
|
@@ -39922,6 +39960,24 @@ components:
|
|
|
39922
39960
|
- course
|
|
39923
39961
|
- mentor
|
|
39924
39962
|
- program
|
|
39963
|
+
ItemTypeEnum:
|
|
39964
|
+
enum:
|
|
39965
|
+
- course
|
|
39966
|
+
- unit
|
|
39967
|
+
- resource
|
|
39968
|
+
- course_unit
|
|
39969
|
+
- course_resource
|
|
39970
|
+
- unit_resource
|
|
39971
|
+
- all
|
|
39972
|
+
type: string
|
|
39973
|
+
description: |-
|
|
39974
|
+
* `course` - Course
|
|
39975
|
+
* `unit` - Unit
|
|
39976
|
+
* `resource` - Resource
|
|
39977
|
+
* `course_unit` - Course and Unit
|
|
39978
|
+
* `course_resource` - Course and Resource
|
|
39979
|
+
* `unit_resource` - Unit and Resource
|
|
39980
|
+
* `all` - Course, Unit, and Resource
|
|
39925
39981
|
LauncherViewPostRequest:
|
|
39926
39982
|
type: object
|
|
39927
39983
|
properties:
|
|
@@ -40521,7 +40577,7 @@ components:
|
|
|
40521
40577
|
* `other` - Other
|
|
40522
40578
|
item_type:
|
|
40523
40579
|
allOf:
|
|
40524
|
-
- $ref: '#/components/schemas/
|
|
40580
|
+
- $ref: '#/components/schemas/ItemTypeEnum'
|
|
40525
40581
|
readOnly: true
|
|
40526
40582
|
description: |-
|
|
40527
40583
|
Type of item this media is associated with
|
|
@@ -40587,24 +40643,6 @@ components:
|
|
|
40587
40643
|
- platform
|
|
40588
40644
|
- title
|
|
40589
40645
|
- updated_at
|
|
40590
|
-
MediaResourceItemTypeEnum:
|
|
40591
|
-
enum:
|
|
40592
|
-
- course
|
|
40593
|
-
- unit
|
|
40594
|
-
- resource
|
|
40595
|
-
- course_unit
|
|
40596
|
-
- course_resource
|
|
40597
|
-
- unit_resource
|
|
40598
|
-
- all
|
|
40599
|
-
type: string
|
|
40600
|
-
description: |-
|
|
40601
|
-
* `course` - Course
|
|
40602
|
-
* `unit` - Unit
|
|
40603
|
-
* `resource` - Resource
|
|
40604
|
-
* `course_unit` - Course and Unit
|
|
40605
|
-
* `course_resource` - Course and Resource
|
|
40606
|
-
* `unit_resource` - Unit and Resource
|
|
40607
|
-
* `all` - Course, Unit, and Resource
|
|
40608
40646
|
MediaTypeEnum:
|
|
40609
40647
|
enum:
|
|
40610
40648
|
- video
|
|
@@ -42399,7 +42437,7 @@ components:
|
|
|
42399
42437
|
* `other` - Other
|
|
42400
42438
|
item_type:
|
|
42401
42439
|
allOf:
|
|
42402
|
-
- $ref: '#/components/schemas/
|
|
42440
|
+
- $ref: '#/components/schemas/ItemTypeEnum'
|
|
42403
42441
|
readOnly: true
|
|
42404
42442
|
description: |-
|
|
42405
42443
|
Type of item this media is associated with
|
|
@@ -46284,7 +46322,9 @@ components:
|
|
|
46284
46322
|
type: object
|
|
46285
46323
|
properties:
|
|
46286
46324
|
item_type:
|
|
46287
|
-
|
|
46325
|
+
type: string
|
|
46326
|
+
pattern: ^(?:custom:)?[a-z][a-z0-9_-]*$
|
|
46327
|
+
maxLength: 50
|
|
46288
46328
|
item_id:
|
|
46289
46329
|
type: string
|
|
46290
46330
|
item_name:
|
package/src/core/OpenAPI.ts
CHANGED
package/src/index.ts
CHANGED
|
@@ -174,9 +174,8 @@ export type { ItemPrice } from './models/ItemPrice';
|
|
|
174
174
|
export type { ItemPriceCreate } from './models/ItemPriceCreate';
|
|
175
175
|
export type { ItemSubscription } from './models/ItemSubscription';
|
|
176
176
|
export type { ItemSubscriptionList } from './models/ItemSubscriptionList';
|
|
177
|
-
export { ItemType3e2Enum } from './models/ItemType3e2Enum';
|
|
178
|
-
export { ItemType40fEnum } from './models/ItemType40fEnum';
|
|
179
177
|
export type { ItemTypeCommission } from './models/ItemTypeCommission';
|
|
178
|
+
export { ItemTypeEnum } from './models/ItemTypeEnum';
|
|
180
179
|
export type { LauncherViewPostRequest } from './models/LauncherViewPostRequest';
|
|
181
180
|
export type { LearnerAnalyticsResponse } from './models/LearnerAnalyticsResponse';
|
|
182
181
|
export type { LearnerAnalyticsResult } from './models/LearnerAnalyticsResult';
|
|
@@ -198,7 +197,6 @@ export type { ManagerAuthToken } from './models/ManagerAuthToken';
|
|
|
198
197
|
export type { MarkAllReadRequest } from './models/MarkAllReadRequest';
|
|
199
198
|
export type { MarkAllReadResponse } from './models/MarkAllReadResponse';
|
|
200
199
|
export type { MediaResource } from './models/MediaResource';
|
|
201
|
-
export { MediaResourceItemTypeEnum } from './models/MediaResourceItemTypeEnum';
|
|
202
200
|
export { MediaTypeEnum } from './models/MediaTypeEnum';
|
|
203
201
|
export type { MentorDetail } from './models/MentorDetail';
|
|
204
202
|
export type { MentorInteractions } from './models/MentorInteractions';
|
|
@@ -545,9 +543,11 @@ export { CredentialsService } from './services/CredentialsService';
|
|
|
545
543
|
export { CreditsService } from './services/CreditsService';
|
|
546
544
|
export { CustomDomainsService } from './services/CustomDomainsService';
|
|
547
545
|
export { FeaturesService } from './services/FeaturesService';
|
|
546
|
+
export { ItemsService } from './services/ItemsService';
|
|
548
547
|
export { MediaService } from './services/MediaService';
|
|
549
548
|
export { NotificationsService } from './services/NotificationsService';
|
|
550
549
|
export { PlatformsService } from './services/PlatformsService';
|
|
550
|
+
export { PricesService } from './services/PricesService';
|
|
551
551
|
export { RecommendationsService } from './services/RecommendationsService';
|
|
552
552
|
export { ReportsService } from './services/ReportsService';
|
|
553
553
|
export { ScimService } from './services/ScimService';
|