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

package/src/services/PlatformsService.ts

@@ -0,0 +1,601 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CheckoutSessionCreate } from '../models/CheckoutSessionCreate';
+import type { CheckoutSessionResponse } from '../models/CheckoutSessionResponse';
+import type { ItemAccessCheckResponse } from '../models/ItemAccessCheckResponse';
+import type { ItemPaywallConfig } from '../models/ItemPaywallConfig';
+import type { ItemPaywallConfigCreate } from '../models/ItemPaywallConfigCreate';
+import type { ItemPrice } from '../models/ItemPrice';
+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 { PortalUrlResponse } from '../models/PortalUrlResponse';
+import type { PublicItemPricing } from '../models/PublicItemPricing';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class PlatformsService {
+    /**
+     * Check whether the authenticated user has payment access to an item on a scoped platform.
+     * @returns ItemAccessCheckResponse
+     * @throws ApiError
+     */
+    public static platformsItemsAccessCheckRetrieve({
+        itemId,
+        itemType,
+        platformKey,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+    }): CancelablePromise<ItemAccessCheckResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/access-check/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Create checkout session
+     * Create a Stripe checkout session for an authenticated user to purchase or subscribe to an item.
+     * @returns CheckoutSessionResponse
+     * @throws ApiError
+     */
+    public static platformsItemsCheckoutCreate({
+        itemId,
+        itemType,
+        platformKey,
+        requestBody,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        requestBody: CheckoutSessionCreate,
+    }): CancelablePromise<CheckoutSessionResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/checkout/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Handle checkout callback
+     * Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
+     * @returns void
+     * @throws ApiError
+     */
+    public static platformsItemsCheckoutCallbackRetrieve({
+        itemId,
+        itemType,
+        platformKey,
+        returnUrl,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        returnUrl?: string | null,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/checkout-callback/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+            query: {
+                'return_url': returnUrl,
+            },
+            errors: {
+                302: `No response body`,
+            },
+        });
+    }
+    /**
+     * Handle checkout callback
+     * Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
+     * @returns void
+     * @throws ApiError
+     */
+    public static platformsItemsCheckoutCallbackRetrieve2({
+        checkoutSessionId,
+        itemId,
+        itemType,
+        platformKey,
+        returnUrl,
+    }: {
+        checkoutSessionId: string,
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        returnUrl?: string | null,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/checkout-callback/{checkout_session_id}/',
+            path: {
+                'checkout_session_id': checkoutSessionId,
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+            query: {
+                'return_url': returnUrl,
+            },
+            errors: {
+                302: `No response body`,
+            },
+        });
+    }
+    /**
+     * Create guest checkout session
+     * Create a Stripe checkout session for a guest user (email required).
+     * @returns CheckoutSessionResponse
+     * @throws ApiError
+     */
+    public static platformsItemsCheckoutGuestCreate({
+        itemId,
+        itemType,
+        platformKey,
+        requestBody,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        requestBody: CheckoutSessionCreate,
+    }): CancelablePromise<CheckoutSessionResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/checkout-guest/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Get paywall configuration
+     * Retrieve the paywall configuration for an item. Returns default (disabled) config if none exists.
+     * @returns ItemPaywallConfig
+     * @throws ApiError
+     */
+    public static platformsItemsPaywallRetrieve({
+        itemId,
+        itemType,
+        platformKey,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+    }): CancelablePromise<ItemPaywallConfig> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Create or update paywall configuration
+     * Enable or configure the paywall for an item. Creates a Stripe product on first enable.
+     * @returns ItemPaywallConfig
+     * @throws ApiError
+     */
+    public static platformsItemsPaywallCreate({
+        itemId,
+        itemType,
+        platformKey,
+        requestBody,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        requestBody?: ItemPaywallConfigCreate,
+    }): CancelablePromise<ItemPaywallConfig> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update paywall configuration
+     * Same as POST. Update the paywall configuration for an item.
+     * @returns ItemPaywallConfig
+     * @throws ApiError
+     */
+    public static platformsItemsPaywallUpdate({
+        itemId,
+        itemType,
+        platformKey,
+        requestBody,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        requestBody?: ItemPaywallConfigCreate,
+    }): CancelablePromise<ItemPaywallConfig> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Disable paywall configuration
+     * Disable the paywall for an item. Does not delete the configuration.
+     * @returns void
+     * @throws ApiError
+     */
+    public static platformsItemsPaywallDestroy({
+        itemId,
+        itemType,
+        platformKey,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * List prices
+     * List active prices for an item's paywall configuration.
+     * @returns ItemPrice
+     * @throws ApiError
+     */
+    public static platformsItemsPaywallPricesList({
+        itemId,
+        itemType,
+        platformKey,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+    }): CancelablePromise<Array<ItemPrice>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Create a price
+     * Create a new price tier for an item. Requires paywall to be enabled and Stripe Connect account ready.
+     * @returns ItemPrice
+     * @throws ApiError
+     */
+    public static platformsItemsPaywallPricesCreate({
+        itemId,
+        itemType,
+        platformKey,
+        requestBody,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        requestBody: ItemPriceCreate,
+    }): CancelablePromise<ItemPrice> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Get price details
+     * Retrieve a specific price by ID.
+     * @returns ItemPrice
+     * @throws ApiError
+     */
+    public static platformsItemsPaywallPricesRetrieve({
+        itemId,
+        itemType,
+        platformKey,
+        priceId,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        priceId: string,
+    }): CancelablePromise<ItemPrice> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/{price_id}/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+                'price_id': priceId,
+            },
+        });
+    }
+    /**
+     * Update a price
+     * Update a price tier. If pricing fields change and a Stripe price exists, a new Stripe price is created and the old one deactivated.
+     * @returns ItemPrice
+     * @throws ApiError
+     */
+    public static platformsItemsPaywallPricesUpdate({
+        itemId,
+        itemType,
+        platformKey,
+        priceId,
+        requestBody,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        priceId: string,
+        requestBody: ItemPriceCreate,
+    }): CancelablePromise<ItemPrice> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/{price_id}/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+                'price_id': priceId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete a price
+     * Soft-delete a price tier and deactivate the corresponding Stripe price.
+     * @returns void
+     * @throws ApiError
+     */
+    public static platformsItemsPaywallPricesDestroy({
+        itemId,
+        itemType,
+        platformKey,
+        priceId,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        priceId: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/paywall/prices/{price_id}/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+                'price_id': priceId,
+            },
+        });
+    }
+    /**
+     * Get public pricing
+     * Retrieve public pricing information for an item. No authentication required.
+     * @returns PublicItemPricing
+     * @throws ApiError
+     */
+    public static platformsItemsPricingRetrieve({
+        itemId,
+        itemType,
+        platformKey,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+    }): CancelablePromise<PublicItemPricing> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/pricing/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * List item subscribers
+     * List all subscribers for an item. Optionally filter by subscription status.
+     * @returns PaginatedItemSubscriptionList
+     * @throws ApiError
+     */
+    public static platformsItemsSubscribersList({
+        itemId,
+        itemType,
+        platformKey,
+        page,
+        pageSize,
+        status,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+        /**
+         * 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<PaginatedItemSubscriptionList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/subscribers/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+            query: {
+                'page': page,
+                'page_size': pageSize,
+                'status': status,
+            },
+        });
+    }
+    /**
+     * Get user subscription
+     * Retrieve the current user's subscription to an item.
+     * @returns ItemSubscription
+     * @throws ApiError
+     */
+    public static platformsItemsSubscriptionRetrieve({
+        itemId,
+        itemType,
+        platformKey,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+    }): CancelablePromise<ItemSubscription> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/subscription/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * Cancel subscription
+     * Cancel the current user's subscription. Returns a Stripe customer portal URL for recurring subscriptions, or cancels directly for one-time purchases.
+     * @returns PortalUrlResponse
+     * @throws ApiError
+     */
+    public static platformsItemsSubscriptionCancelCreate({
+        itemId,
+        itemType,
+        platformKey,
+    }: {
+        itemId: string,
+        itemType: string,
+        platformKey: string,
+    }): CancelablePromise<PortalUrlResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/platforms/{platform_key}/items/{item_type}/{item_id}/subscription/cancel/',
+            path: {
+                'item_id': itemId,
+                'item_type': itemType,
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * List user subscriptions
+     * Paginated list of the current user's subscriptions on a platform. Optionally filter by status or item_type.
+     * @returns PaginatedItemSubscriptionListList
+     * @throws ApiError
+     */
+    public static platformsMySubscriptionsList({
+        platformKey,
+        itemType,
+        page,
+        pageSize,
+        status,
+    }: {
+        platformKey: string,
+        /**
+         * * `mentor` - mentor
+         * * `course` - course
+         * * `program` - program
+         */
+        itemType?: 'mentor' | 'course' | 'program',
+        /**
+         * 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}/my-subscriptions/',
+            path: {
+                'platform_key': platformKey,
+            },
+            query: {
+                'item_type': itemType,
+                'page': page,
+                'page_size': pageSize,
+                'status': status,
+            },
+        });
+    }
+}