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

package/dist/types/services/BillingService.d.ts

@@ -1,10 +1,21 @@
 import type { AutoRechargeTriggerRequest } from '../models/AutoRechargeTriggerRequest';
 import type { AutoRechargeTriggerResponse } from '../models/AutoRechargeTriggerResponse';
+import type { CheckoutSessionCreate } from '../models/CheckoutSessionCreate';
+import type { CheckoutSessionResponse } from '../models/CheckoutSessionResponse';
 import type { CreditAccountAutoRechargeUpdate } from '../models/CreditAccountAutoRechargeUpdate';
 import type { CreditAccountInfo } from '../models/CreditAccountInfo';
 import type { CreditTransactionHistory } from '../models/CreditTransactionHistory';
 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 { PatchedCreditAccountAutoRechargeUpdate } from '../models/PatchedCreditAccountAutoRechargeUpdate';
+import type { PortalUrlResponse } from '../models/PortalUrlResponse';
+import type { PublicItemPricing } from '../models/PublicItemPricing';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class BillingService {
     /**
@@ -59,6 +70,266 @@ export declare class BillingService {
     static billingAutoRechargeTriggerCreate({ requestBody, }: {
         requestBody?: AutoRechargeTriggerRequest;
     }): CancelablePromise<AutoRechargeTriggerResponse>;
+    /**
+     * Check whether the authenticated user has payment access to an item on a scoped platform.
+     * @returns ItemAccessCheckResponse
+     * @throws ApiError
+     */
+    static billingPlatformsItemsAccessCheckRetrieve({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<ItemAccessCheckResponse>;
+    /**
+     * Create checkout session
+     * Create a Stripe checkout session for an authenticated user to purchase or subscribe to an item.
+     * @returns CheckoutSessionResponse
+     * @throws ApiError
+     */
+    static billingPlatformsItemsCheckoutCreate({ itemId, itemType, platformKey, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        requestBody: CheckoutSessionCreate;
+    }): CancelablePromise<CheckoutSessionResponse>;
+    /**
+     * Handle checkout callback
+     * Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
+     * @returns void
+     * @throws ApiError
+     */
+    static billingPlatformsItemsCheckoutCallbackRetrieve({ itemId, itemType, platformKey, returnUrl, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        returnUrl?: string | null;
+    }): CancelablePromise<void>;
+    /**
+     * Handle checkout callback
+     * Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
+     * @returns void
+     * @throws ApiError
+     */
+    static billingPlatformsItemsCheckoutCallbackRetrieve2({ checkoutSessionId, itemId, itemType, platformKey, returnUrl, }: {
+        checkoutSessionId: string;
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        returnUrl?: string | null;
+    }): CancelablePromise<void>;
+    /**
+     * Create guest checkout session
+     * Create a Stripe checkout session for a guest user (email required).
+     * @returns CheckoutSessionResponse
+     * @throws ApiError
+     */
+    static billingPlatformsItemsCheckoutGuestCreate({ itemId, itemType, platformKey, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        requestBody: CheckoutSessionCreate;
+    }): CancelablePromise<CheckoutSessionResponse>;
+    /**
+     * Get paywall configuration
+     * Retrieve the paywall configuration for an item. Returns default (disabled) config if none exists.
+     * @returns ItemPaywallConfig
+     * @throws ApiError
+     */
+    static billingPlatformsItemsPaywallRetrieve({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<ItemPaywallConfig>;
+    /**
+     * Create or update paywall configuration
+     * Enable or configure the paywall for an item. Creates a Stripe product on first enable.
+     * @returns ItemPaywallConfig
+     * @throws ApiError
+     */
+    static billingPlatformsItemsPaywallCreate({ itemId, itemType, platformKey, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        requestBody?: ItemPaywallConfigCreate;
+    }): CancelablePromise<ItemPaywallConfig>;
+    /**
+     * Update paywall configuration
+     * Same as POST. Update the paywall configuration for an item.
+     * @returns ItemPaywallConfig
+     * @throws ApiError
+     */
+    static billingPlatformsItemsPaywallUpdate({ itemId, itemType, platformKey, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        requestBody?: ItemPaywallConfigCreate;
+    }): CancelablePromise<ItemPaywallConfig>;
+    /**
+     * Disable paywall configuration
+     * Disable the paywall for an item. Does not delete the configuration.
+     * @returns void
+     * @throws ApiError
+     */
+    static billingPlatformsItemsPaywallDestroy({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<void>;
+    /**
+     * List prices
+     * List active prices for an item's paywall configuration.
+     * @returns ItemPrice
+     * @throws ApiError
+     */
+    static billingPlatformsItemsPaywallPricesList({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<Array<ItemPrice>>;
+    /**
+     * 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
+     */
+    static billingPlatformsItemsPaywallPricesCreate({ itemId, itemType, platformKey, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        requestBody: ItemPriceCreate;
+    }): CancelablePromise<ItemPrice>;
+    /**
+     * Get price details
+     * Retrieve a specific price by ID.
+     * @returns ItemPrice
+     * @throws ApiError
+     */
+    static billingPlatformsItemsPaywallPricesRetrieve({ itemId, itemType, platformKey, priceId, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        priceId: string;
+    }): CancelablePromise<ItemPrice>;
+    /**
+     * 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
+     */
+    static billingPlatformsItemsPaywallPricesUpdate({ itemId, itemType, platformKey, priceId, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        priceId: string;
+        requestBody: ItemPriceCreate;
+    }): CancelablePromise<ItemPrice>;
+    /**
+     * Delete a price
+     * Soft-delete a price tier and deactivate the corresponding Stripe price.
+     * @returns void
+     * @throws ApiError
+     */
+    static billingPlatformsItemsPaywallPricesDestroy({ itemId, itemType, platformKey, priceId, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        priceId: string;
+    }): CancelablePromise<void>;
+    /**
+     * Get public pricing
+     * Retrieve public pricing information for an item. No authentication required.
+     * @returns PublicItemPricing
+     * @throws ApiError
+     */
+    static billingPlatformsItemsPricingRetrieve({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<PublicItemPricing>;
+    /**
+     * List item subscribers
+     * List all subscribers for an item. Optionally filter by subscription status.
+     * @returns PaginatedItemSubscriptionList
+     * @throws ApiError
+     */
+    static billingPlatformsItemsSubscribersList({ 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>;
+    /**
+     * Get user subscription
+     * Retrieve the current user's subscription to an item.
+     * @returns ItemSubscription
+     * @throws ApiError
+     */
+    static billingPlatformsItemsSubscriptionRetrieve({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<ItemSubscription>;
+    /**
+     * 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
+     */
+    static billingPlatformsItemsSubscriptionCancelCreate({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<PortalUrlResponse>;
+    /**
+     * 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
+     */
+    static billingPlatformsMySubscriptionsList({ 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>;
     /**
      * 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).

package/dist/types/services/PlatformsService.d.ts

@@ -0,0 +1,275 @@
+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';
+export declare class PlatformsService {
+    /**
+     * Check whether the authenticated user has payment access to an item on a scoped platform.
+     * @returns ItemAccessCheckResponse
+     * @throws ApiError
+     */
+    static platformsItemsAccessCheckRetrieve({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<ItemAccessCheckResponse>;
+    /**
+     * Create checkout session
+     * Create a Stripe checkout session for an authenticated user to purchase or subscribe to an item.
+     * @returns CheckoutSessionResponse
+     * @throws ApiError
+     */
+    static platformsItemsCheckoutCreate({ itemId, itemType, platformKey, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        requestBody: CheckoutSessionCreate;
+    }): CancelablePromise<CheckoutSessionResponse>;
+    /**
+     * Handle checkout callback
+     * Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
+     * @returns void
+     * @throws ApiError
+     */
+    static platformsItemsCheckoutCallbackRetrieve({ itemId, itemType, platformKey, returnUrl, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        returnUrl?: string | null;
+    }): CancelablePromise<void>;
+    /**
+     * Handle checkout callback
+     * Stripe redirects here after checkout. Processes the completed session and redirects to the return URL.
+     * @returns void
+     * @throws ApiError
+     */
+    static platformsItemsCheckoutCallbackRetrieve2({ checkoutSessionId, itemId, itemType, platformKey, returnUrl, }: {
+        checkoutSessionId: string;
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        returnUrl?: string | null;
+    }): CancelablePromise<void>;
+    /**
+     * Create guest checkout session
+     * Create a Stripe checkout session for a guest user (email required).
+     * @returns CheckoutSessionResponse
+     * @throws ApiError
+     */
+    static platformsItemsCheckoutGuestCreate({ itemId, itemType, platformKey, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        requestBody: CheckoutSessionCreate;
+    }): CancelablePromise<CheckoutSessionResponse>;
+    /**
+     * Get paywall configuration
+     * Retrieve the paywall configuration for an item. Returns default (disabled) config if none exists.
+     * @returns ItemPaywallConfig
+     * @throws ApiError
+     */
+    static platformsItemsPaywallRetrieve({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<ItemPaywallConfig>;
+    /**
+     * Create or update paywall configuration
+     * Enable or configure the paywall for an item. Creates a Stripe product on first enable.
+     * @returns ItemPaywallConfig
+     * @throws ApiError
+     */
+    static platformsItemsPaywallCreate({ itemId, itemType, platformKey, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        requestBody?: ItemPaywallConfigCreate;
+    }): CancelablePromise<ItemPaywallConfig>;
+    /**
+     * Update paywall configuration
+     * Same as POST. Update the paywall configuration for an item.
+     * @returns ItemPaywallConfig
+     * @throws ApiError
+     */
+    static platformsItemsPaywallUpdate({ itemId, itemType, platformKey, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        requestBody?: ItemPaywallConfigCreate;
+    }): CancelablePromise<ItemPaywallConfig>;
+    /**
+     * Disable paywall configuration
+     * Disable the paywall for an item. Does not delete the configuration.
+     * @returns void
+     * @throws ApiError
+     */
+    static platformsItemsPaywallDestroy({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<void>;
+    /**
+     * List prices
+     * List active prices for an item's paywall configuration.
+     * @returns ItemPrice
+     * @throws ApiError
+     */
+    static platformsItemsPaywallPricesList({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<Array<ItemPrice>>;
+    /**
+     * 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
+     */
+    static platformsItemsPaywallPricesCreate({ itemId, itemType, platformKey, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        requestBody: ItemPriceCreate;
+    }): CancelablePromise<ItemPrice>;
+    /**
+     * Get price details
+     * Retrieve a specific price by ID.
+     * @returns ItemPrice
+     * @throws ApiError
+     */
+    static platformsItemsPaywallPricesRetrieve({ itemId, itemType, platformKey, priceId, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        priceId: string;
+    }): CancelablePromise<ItemPrice>;
+    /**
+     * 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
+     */
+    static platformsItemsPaywallPricesUpdate({ itemId, itemType, platformKey, priceId, requestBody, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        priceId: string;
+        requestBody: ItemPriceCreate;
+    }): CancelablePromise<ItemPrice>;
+    /**
+     * Delete a price
+     * Soft-delete a price tier and deactivate the corresponding Stripe price.
+     * @returns void
+     * @throws ApiError
+     */
+    static platformsItemsPaywallPricesDestroy({ itemId, itemType, platformKey, priceId, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+        priceId: string;
+    }): CancelablePromise<void>;
+    /**
+     * Get public pricing
+     * Retrieve public pricing information for an item. No authentication required.
+     * @returns PublicItemPricing
+     * @throws ApiError
+     */
+    static platformsItemsPricingRetrieve({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<PublicItemPricing>;
+    /**
+     * List item subscribers
+     * List all subscribers for an item. Optionally filter by subscription status.
+     * @returns PaginatedItemSubscriptionList
+     * @throws ApiError
+     */
+    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>;
+    /**
+     * Get user subscription
+     * Retrieve the current user's subscription to an item.
+     * @returns ItemSubscription
+     * @throws ApiError
+     */
+    static platformsItemsSubscriptionRetrieve({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<ItemSubscription>;
+    /**
+     * 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
+     */
+    static platformsItemsSubscriptionCancelCreate({ itemId, itemType, platformKey, }: {
+        itemId: string;
+        itemType: string;
+        platformKey: string;
+    }): CancelablePromise<PortalUrlResponse>;
+    /**
+     * 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
+     */
+    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>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/iblai-api",
-  "version": "4.194.2-core",
+  "version": "4.195.0-core",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "type": "module",