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

package/src/services/PlatformsService.ts

@@ -12,6 +12,7 @@ import type { ItemPriceCreate } from '../models/ItemPriceCreate';
 import type { ItemSubscription } from '../models/ItemSubscription';
 import type { PaginatedItemSubscriptionList } from '../models/PaginatedItemSubscriptionList';
 import type { PaginatedItemSubscriptionListList } from '../models/PaginatedItemSubscriptionListList';
+import type { PlatformRevenueSummary } from '../models/PlatformRevenueSummary';
 import type { PortalUrlResponse } from '../models/PortalUrlResponse';
 import type { PublicItemPricing } from '../models/PublicItemPricing';
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -563,8 +564,9 @@ export class PlatformsService {
          * * `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.
          */
@@ -598,4 +600,77 @@ export class PlatformsService {
             },
         });
     }
+    /**
+     * Platform sales summary
+     * Aggregate sales volume and count for a platform across all item types.
+     * @returns PlatformRevenueSummary
+     * @throws ApiError
+     */
+    public static platformsRevenueRetrieve({
+        platformKey,
+    }: {
+        platformKey: string,
+    }): CancelablePromise<PlatformRevenueSummary> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/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 platformsSubscribersList({
+        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: '/platforms/{platform_key}/subscribers/',
+            path: {
+                'platform_key': platformKey,
+            },
+            query: {
+                'item_type': itemType,
+                'page': page,
+                'page_size': pageSize,
+                'status': status,
+            },
+        });
+    }
 }