@iblai/iblai-api 4.195.0-core → 4.196.0-core

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.195.0-core
+  version: 4.196.0-core
   description: API for iblai
 paths:
   /access-check/{item_type}/{item_id}/:
@@ -2846,12 +2846,108 @@ paths:
           - mentor
           - course
           - program
+          - pathway
           type: string
           minLength: 1
         description: |-
           * `mentor` - mentor
           * `course` - course
           * `program` - program
+          * `pathway` - pathway
+      - name: page
+        required: false
+        in: query
+        description: A page number within the paginated result set.
+        schema:
+          type: integer
+      - name: page_size
+        required: false
+        in: query
+        description: Number of results to return per page.
+        schema:
+          type: integer
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: query
+        name: status
+        schema:
+          enum:
+          - active
+          - free
+          - grandfathered
+          - trialing
+          - past_due
+          - canceled
+          - incomplete
+          type: string
+          minLength: 1
+        description: |-
+          * `active` - Active
+          * `free` - Free Tier
+          * `grandfathered` - Grandfathered
+          * `trialing` - Trialing
+          * `past_due` - Past Due
+          * `canceled` - Canceled
+          * `incomplete` - Incomplete
+      tags:
+      - billing
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedItemSubscriptionListList'
+          description: ''
+  /api/billing/platforms/{platform_key}/revenue/:
+    get:
+      operationId: billing_platforms_revenue_retrieve
+      description: Aggregate sales volume and count for a platform across all item
+        types.
+      summary: Platform sales summary
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - billing
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformRevenueSummary'
+          description: ''
+  /api/billing/platforms/{platform_key}/subscribers/:
+    get:
+      operationId: billing_platforms_subscribers_list
+      description: Paginated list of all subscribers across all items on a platform.
+        Filterable by status and item_type.
+      summary: List all platform subscribers
+      parameters:
+      - in: query
+        name: item_type
+        schema:
+          enum:
+          - mentor
+          - course
+          - program
+          - pathway
+          type: string
+          minLength: 1
+        description: |-
+          * `mentor` - mentor
+          * `course` - course
+          * `program` - program
+          * `pathway` - pathway
       - name: page
         required: false
         in: query
@@ -35156,12 +35252,108 @@ paths:
           - mentor
           - course
           - program
+          - pathway
           type: string
           minLength: 1
         description: |-
           * `mentor` - mentor
           * `course` - course
           * `program` - program
+          * `pathway` - pathway
+      - name: page
+        required: false
+        in: query
+        description: A page number within the paginated result set.
+        schema:
+          type: integer
+      - name: page_size
+        required: false
+        in: query
+        description: Number of results to return per page.
+        schema:
+          type: integer
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      - in: query
+        name: status
+        schema:
+          enum:
+          - active
+          - free
+          - grandfathered
+          - trialing
+          - past_due
+          - canceled
+          - incomplete
+          type: string
+          minLength: 1
+        description: |-
+          * `active` - Active
+          * `free` - Free Tier
+          * `grandfathered` - Grandfathered
+          * `trialing` - Trialing
+          * `past_due` - Past Due
+          * `canceled` - Canceled
+          * `incomplete` - Incomplete
+      tags:
+      - platforms
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedItemSubscriptionListList'
+          description: ''
+  /platforms/{platform_key}/revenue/:
+    get:
+      operationId: platforms_revenue_retrieve
+      description: Aggregate sales volume and count for a platform across all item
+        types.
+      summary: Platform sales summary
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - platforms
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlatformRevenueSummary'
+          description: ''
+  /platforms/{platform_key}/subscribers/:
+    get:
+      operationId: platforms_subscribers_list
+      description: Paginated list of all subscribers across all items on a platform.
+        Filterable by status and item_type.
+      summary: List all platform subscribers
+      parameters:
+      - in: query
+        name: item_type
+        schema:
+          enum:
+          - mentor
+          - course
+          - program
+          - pathway
+          type: string
+          minLength: 1
+        description: |-
+          * `mentor` - mentor
+          * `course` - course
+          * `program` - program
+          * `pathway` - pathway
       - name: page
         required: false
         in: query
@@ -39091,13 +39283,14 @@ components:
           description: True if the user can access the item.
         item_type:
           allOf:
-          - $ref: '#/components/schemas/ItemTypeC6bEnum'
+          - $ref: '#/components/schemas/ItemType3e2Enum'
           description: |-
             Item type that was checked (e.g. 'mentor').
 
             * `mentor` - mentor
             * `course` - course
             * `program` - program
+            * `pathway` - pathway
         item_id:
           type: string
           description: ID of the item that was checked.
@@ -39131,13 +39324,14 @@ components:
       properties:
         item_type:
           allOf:
-          - $ref: '#/components/schemas/ItemType5d7Enum'
+          - $ref: '#/components/schemas/ItemType40fEnum'
           description: |-
             Type of item being paywalled (e.g. mentor, course, program)
 
             * `mentor` - Mentor
             * `course` - Course
             * `program` - Program
+            * `pathway` - Pathway
         item_id:
           type: string
           description: Identifier for the item (UUID for mentors, slug/key for others)
@@ -39325,13 +39519,14 @@ components:
           readOnly: true
         item_type:
           allOf:
-          - $ref: '#/components/schemas/ItemType5d7Enum'
+          - $ref: '#/components/schemas/ItemType40fEnum'
           description: |-
             Type of item being subscribed to
 
             * `mentor` - Mentor
             * `course` - Course
             * `program` - Program
+            * `pathway` - Pathway
         item_id:
           type: string
           description: Identifier for the item
@@ -39420,13 +39615,14 @@ components:
           readOnly: true
         item_type:
           allOf:
-          - $ref: '#/components/schemas/ItemType5d7Enum'
+          - $ref: '#/components/schemas/ItemType40fEnum'
           description: |-
             Type of item being subscribed to
 
             * `mentor` - Mentor
             * `course` - Course
             * `program` - Program
+            * `pathway` - Pathway
         item_id:
           type: string
           description: Identifier for the item
@@ -39467,26 +39663,30 @@ components:
       - price
       - unique_id
       - updated_at
-    ItemType5d7Enum:
+    ItemType3e2Enum:
       enum:
       - mentor
       - course
       - program
+      - pathway
       type: string
       description: |-
-        * `mentor` - Mentor
-        * `course` - Course
-        * `program` - Program
-    ItemTypeC6bEnum:
+        * `mentor` - mentor
+        * `course` - course
+        * `program` - program
+        * `pathway` - pathway
+    ItemType40fEnum:
       enum:
       - mentor
       - course
       - program
+      - pathway
       type: string
       description: |-
-        * `mentor` - mentor
-        * `course` - course
-        * `program` - program
+        * `mentor` - Mentor
+        * `course` - Course
+        * `program` - Program
+        * `pathway` - Pathway
     ItemTypeCommission:
       type: object
       description: Commission percentages keyed by item type.
@@ -44128,6 +44328,21 @@ components:
       required:
       - platform_key
       - platform_name
+    PlatformRevenueSummary:
+      type: object
+      properties:
+        sales_volume:
+          type: string
+          format: decimal
+          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
+        sales_count:
+          type: integer
+        currency:
+          type: string
+      required:
+      - currency
+      - sales_count
+      - sales_volume
     PlatformSkillPointBulkRequest:
       type: object
       description: Request serializer for PlatformSkillPointBulkManagementView POST
@@ -45831,7 +46046,7 @@ components:
       type: object
       properties:
         item_type:
-          $ref: '#/components/schemas/ItemTypeC6bEnum'
+          $ref: '#/components/schemas/ItemType3e2Enum'
         item_id:
           type: string
         item_name:

package/src/core/OpenAPI.ts

@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
     BASE: 'https://base.manager.iblai.app',
-    VERSION: '4.195.0-core',
+    VERSION: '4.196.0-core',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/src/index.ts

@@ -174,8 +174,8 @@ export type { ItemPrice } from './models/ItemPrice';
 export type { ItemPriceCreate } from './models/ItemPriceCreate';
 export type { ItemSubscription } from './models/ItemSubscription';
 export type { ItemSubscriptionList } from './models/ItemSubscriptionList';
-export { ItemType5d7Enum } from './models/ItemType5d7Enum';
-export { ItemTypeC6bEnum } from './models/ItemTypeC6bEnum';
+export { ItemType3e2Enum } from './models/ItemType3e2Enum';
+export { ItemType40fEnum } from './models/ItemType40fEnum';
 export type { ItemTypeCommission } from './models/ItemTypeCommission';
 export type { LauncherViewPostRequest } from './models/LauncherViewPostRequest';
 export type { LearnerAnalyticsResponse } from './models/LearnerAnalyticsResponse';
@@ -328,6 +328,7 @@ export type { PlatformMembershipConfigPostRequest } from './models/PlatformMembe
 export type { PlatformMetrics } from './models/PlatformMetrics';
 export type { PlatformPublicImageAsset } from './models/PlatformPublicImageAsset';
 export type { PlatformPublicMetadata } from './models/PlatformPublicMetadata';
+export type { PlatformRevenueSummary } from './models/PlatformRevenueSummary';
 export type { PlatformSkillPointBulkRequest } from './models/PlatformSkillPointBulkRequest';
 export type { PlatformSkillPointBulkResponse } from './models/PlatformSkillPointBulkResponse';
 export type { PlatformSkillPointGroupRequest } from './models/PlatformSkillPointGroupRequest';

package/src/models/ItemAccessCheckResponse.ts

@@ -3,7 +3,7 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { ItemSubscription } from './ItemSubscription';
-import type { ItemTypeC6bEnum } from './ItemTypeC6bEnum';
+import type { ItemType3e2Enum } from './ItemType3e2Enum';
 /**
  * Response for the generic item access check endpoint.
  *
@@ -21,8 +21,9 @@ export type ItemAccessCheckResponse = {
      * * `mentor` - mentor
      * * `course` - course
      * * `program` - program
+     * * `pathway` - pathway
      */
-    item_type: ItemTypeC6bEnum;
+    item_type: ItemType3e2Enum;
     /**
      * ID of the item that was checked.
      */

package/src/models/ItemPaywallConfig.ts

@@ -4,7 +4,7 @@
 /* eslint-disable */
 import type { GrandfatheringStrategyEnum } from './GrandfatheringStrategyEnum';
 import type { ItemPrice } from './ItemPrice';
-import type { ItemType5d7Enum } from './ItemType5d7Enum';
+import type { ItemType40fEnum } from './ItemType40fEnum';
 export type ItemPaywallConfig = {
     /**
      * Type of item being paywalled (e.g. mentor, course, program)
@@ -12,8 +12,9 @@ export type ItemPaywallConfig = {
      * * `mentor` - Mentor
      * * `course` - Course
      * * `program` - Program
+     * * `pathway` - Pathway
      */
-    item_type: ItemType5d7Enum;
+    item_type: ItemType40fEnum;
     /**
      * Identifier for the item (UUID for mentors, slug/key for others)
      */

package/src/models/ItemSubscription.ts

@@ -3,7 +3,7 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { ItemPrice } from './ItemPrice';
-import type { ItemType5d7Enum } from './ItemType5d7Enum';
+import type { ItemType40fEnum } from './ItemType40fEnum';
 import type { Status0e3Enum } from './Status0e3Enum';
 export type ItemSubscription = {
     readonly unique_id: string;
@@ -13,8 +13,9 @@ export type ItemSubscription = {
      * * `mentor` - Mentor
      * * `course` - Course
      * * `program` - Program
+     * * `pathway` - Pathway
      */
-    item_type: ItemType5d7Enum;
+    item_type: ItemType40fEnum;
     /**
      * Identifier for the item
      */

package/src/models/ItemSubscriptionList.ts

@@ -3,7 +3,7 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { ItemPrice } from './ItemPrice';
-import type { ItemType5d7Enum } from './ItemType5d7Enum';
+import type { ItemType40fEnum } from './ItemType40fEnum';
 import type { Status0e3Enum } from './Status0e3Enum';
 export type ItemSubscriptionList = {
     readonly unique_id: string;
@@ -13,8 +13,9 @@ export type ItemSubscriptionList = {
      * * `mentor` - Mentor
      * * `course` - Course
      * * `program` - Program
+     * * `pathway` - Pathway
      */
-    item_type: ItemType5d7Enum;
+    item_type: ItemType40fEnum;
     /**
      * Identifier for the item
      */

package/src/models/{ItemTypeC6bEnum.ts → ItemType3e2Enum.ts}

@@ -6,9 +6,11 @@
  * * `mentor` - mentor
  * * `course` - course
  * * `program` - program
+ * * `pathway` - pathway
  */
-export enum ItemTypeC6bEnum {
+export enum ItemType3e2Enum {
     MENTOR = 'mentor',
     COURSE = 'course',
     PROGRAM = 'program',
+    PATHWAY = 'pathway',
 }

package/src/models/{ItemType5d7Enum.ts → ItemType40fEnum.ts}

@@ -6,9 +6,11 @@
  * * `mentor` - Mentor
  * * `course` - Course
  * * `program` - Program
+ * * `pathway` - Pathway
  */
-export enum ItemType5d7Enum {
+export enum ItemType40fEnum {
     MENTOR = 'mentor',
     COURSE = 'course',
     PROGRAM = 'program',
+    PATHWAY = 'pathway',
 }

package/src/models/PlatformRevenueSummary.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PlatformRevenueSummary = {
+    sales_volume: string;
+    sales_count: number;
+    currency: string;
+};
+

package/src/models/PublicItemPricing.ts

@@ -3,9 +3,9 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { ItemPrice } from './ItemPrice';
-import type { ItemTypeC6bEnum } from './ItemTypeC6bEnum';
+import type { ItemType3e2Enum } from './ItemType3e2Enum';
 export type PublicItemPricing = {
-    item_type: ItemTypeC6bEnum;
+    item_type: ItemType3e2Enum;
     item_id: string;
     item_name: string;
     is_paywalled: boolean;

package/src/services/BillingService.ts

@@ -18,6 +18,7 @@ import type { ItemSubscription } from '../models/ItemSubscription';
 import type { PaginatedItemSubscriptionList } from '../models/PaginatedItemSubscriptionList';
 import type { PaginatedItemSubscriptionListList } from '../models/PaginatedItemSubscriptionListList';
 import type { PatchedCreditAccountAutoRechargeUpdate } from '../models/PatchedCreditAccountAutoRechargeUpdate';
+import type { PlatformRevenueSummary } from '../models/PlatformRevenueSummary';
 import type { PortalUrlResponse } from '../models/PortalUrlResponse';
 import type { PublicItemPricing } from '../models/PublicItemPricing';
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -674,8 +675,9 @@ export class BillingService {
          * * `mentor` - mentor
          * * `course` - course
          * * `program` - program
+         * * `pathway` - pathway
          */
-        itemType?: 'mentor' | 'course' | 'program',
+        itemType?: 'mentor' | 'course' | 'program' | 'pathway',
         /**
          * A page number within the paginated result set.
          */
@@ -709,6 +711,79 @@ export class BillingService {
             },
         });
     }
+    /**
+     * Platform sales summary
+     * Aggregate sales volume and count for a platform across all item types.
+     * @returns PlatformRevenueSummary
+     * @throws ApiError
+     */
+    public static billingPlatformsRevenueRetrieve({
+        platformKey,
+    }: {
+        platformKey: string,
+    }): CancelablePromise<PlatformRevenueSummary> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/billing/platforms/{platform_key}/revenue/',
+            path: {
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * List all platform subscribers
+     * Paginated list of all subscribers across all items on a platform. Filterable by status and item_type.
+     * @returns PaginatedItemSubscriptionListList
+     * @throws ApiError
+     */
+    public static billingPlatformsSubscribersList({
+        platformKey,
+        itemType,
+        page,
+        pageSize,
+        status,
+    }: {
+        platformKey: string,
+        /**
+         * * `mentor` - mentor
+         * * `course` - course
+         * * `program` - program
+         * * `pathway` - pathway
+         */
+        itemType?: 'mentor' | 'course' | 'program' | 'pathway',
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number,
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number,
+        /**
+         * * `active` - Active
+         * * `free` - Free Tier
+         * * `grandfathered` - Grandfathered
+         * * `trialing` - Trialing
+         * * `past_due` - Past Due
+         * * `canceled` - Canceled
+         * * `incomplete` - Incomplete
+         */
+        status?: 'active' | 'free' | 'grandfathered' | 'trialing' | 'past_due' | 'canceled' | 'incomplete',
+    }): CancelablePromise<PaginatedItemSubscriptionListList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/billing/platforms/{platform_key}/subscribers/',
+            path: {
+                'platform_key': platformKey,
+            },
+            query: {
+                'item_type': itemType,
+                'page': page,
+                'page_size': pageSize,
+                'status': status,
+            },
+        });
+    }
     /**
      * List transaction history
      * 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).