@iblai/iblai-api 4.175.1-core → 4.175.2-core

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.175.1-core
+  version: 4.175.2-core
   description: API for iblai
 paths:
   /account/:
@@ -32,9 +32,12 @@ paths:
           description: ''
     put:
       operationId: account_update
-      description: Update auto_recharge_threshold_usd, auto_recharge_amount_usd, and/or
-        auto_recharge_enabled. Pass platform_key in the request body to update platform
-        settings.
+      description: 'Update auto_recharge_threshold_usd, auto_recharge_amount_usd,
+        auto_recharge_enabled, and/or auto_recharge_spending_limit_usd. When enabling
+        auto-recharge, missing values are calculated: if only limit set, amount =
+        20% of limit; if only amount set, limit = 5x amount; if neither set, defaults
+        are limit=20, amount=4. Pass platform_key in the request body to update platform
+        settings.'
       summary: Update auto-recharge preferences
       tags:
       - account
@@ -1883,9 +1886,12 @@ paths:
           description: ''
     put:
       operationId: billing_account_update
-      description: Update auto_recharge_threshold_usd, auto_recharge_amount_usd, and/or
-        auto_recharge_enabled. Pass platform_key in the request body to update platform
-        settings.
+      description: 'Update auto_recharge_threshold_usd, auto_recharge_amount_usd,
+        auto_recharge_enabled, and/or auto_recharge_spending_limit_usd. When enabling
+        auto-recharge, missing values are calculated: if only limit set, amount =
+        20% of limit; if only amount set, limit = 5x amount; if neither set, defaults
+        are limit=20, amount=4. Pass platform_key in the request body to update platform
+        settings.'
       summary: Update auto-recharge preferences
       tags:
       - billing
@@ -1950,10 +1956,11 @@ paths:
   /api/billing/auto-recharge/trigger/:
     post:
       operationId: billing_auto_recharge_trigger_create
-      description: Run auto-recharge once if the account has it enabled and balance
-        is below threshold. Returns 400 if skipped or failed (e.g. no payment method,
-        cooldown). Pass platform_key in request body.
-      summary: Trigger auto-recharge
+      description: 'With amount_usd: manual top-up (charge that amount, add credits;
+        no threshold/limit/cooldown). Without amount_usd: run auto-recharge once if
+        enabled and balance below threshold. Returns 400 if skipped or failed (e.g.
+        no payment method, cooldown). Pass platform_key in request body.'
+      summary: Trigger auto-recharge or manual top-up
       tags:
       - billing
       requestBody:
@@ -1988,6 +1995,64 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorDetail'
           description: ''
+  /api/billing/transactions/:
+    get:
+      operationId: billing_transactions_retrieve
+      description: 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).
+      summary: List transaction history
+      parameters:
+      - in: query
+        name: from_date
+        schema:
+          type: string
+          format: date
+        description: Filter from date (YYYY-MM-DD), inclusive.
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        description: Platform key. Omit for user's own account.
+      - in: query
+        name: to_date
+        schema:
+          type: string
+          format: date
+        description: Filter to date (YYYY-MM-DD), inclusive.
+      - in: query
+        name: transaction_type
+        schema:
+          enum:
+          - add
+          - subtract
+          - reserve
+          - release
+          - rollover
+          - refund
+          type: string
+          minLength: 1
+        description: |-
+          Filter by transaction type.
+
+          * `add` - add
+          * `subtract` - subtract
+          * `reserve` - reserve
+          * `release` - release
+          * `rollover` - rollover
+          * `refund` - refund
+      tags:
+      - billing
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CreditTransactionHistory'
+          description: ''
   /api/career/location/orgs/{org}/users/{username}/:
     get:
       operationId: career_location_orgs_users_retrieve
@@ -33286,10 +33351,11 @@ paths:
   /auto-recharge/trigger/:
     post:
       operationId: auto_recharge_trigger_create
-      description: Run auto-recharge once if the account has it enabled and balance
-        is below threshold. Returns 400 if skipped or failed (e.g. no payment method,
-        cooldown). Pass platform_key in request body.
-      summary: Trigger auto-recharge
+      description: 'With amount_usd: manual top-up (charge that amount, add credits;
+        no threshold/limit/cooldown). Without amount_usd: run auto-recharge once if
+        enabled and balance below threshold. Returns 400 if skipped or failed (e.g.
+        no payment method, cooldown). Pass platform_key in request body.'
+      summary: Trigger auto-recharge or manual top-up
       tags:
       - auto-recharge
       requestBody:
@@ -33339,6 +33405,64 @@ paths:
       responses:
         '200':
           description: No response body
+  /transactions/:
+    get:
+      operationId: transactions_retrieve
+      description: 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).
+      summary: List transaction history
+      parameters:
+      - in: query
+        name: from_date
+        schema:
+          type: string
+          format: date
+        description: Filter from date (YYYY-MM-DD), inclusive.
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        description: Platform key. Omit for user's own account.
+      - in: query
+        name: to_date
+        schema:
+          type: string
+          format: date
+        description: Filter to date (YYYY-MM-DD), inclusive.
+      - in: query
+        name: transaction_type
+        schema:
+          enum:
+          - add
+          - subtract
+          - reserve
+          - release
+          - rollover
+          - refund
+          type: string
+          minLength: 1
+        description: |-
+          Filter by transaction type.
+
+          * `add` - add
+          * `subtract` - subtract
+          * `reserve` - reserve
+          * `release` - release
+          * `rollover` - rollover
+          * `refund` - refund
+      tags:
+      - transactions
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CreditTransactionHistory'
+          description: ''
 components:
   schemas:
     AWSTenantLaunchRequest:
@@ -33665,6 +33789,13 @@ components:
         platform_key:
           type: string
           description: The unique key of the platform. Defaults to 'main'.
+        amount_usd:
+          type: string
+          format: decimal
+          pattern: ^-?\d{0,11}(?:\.\d{0,3})?$
+          description: 'Optional. When set, perform manual top-up: charge this amount
+            (user USD) and add credits. No threshold, spending limit, or cooldown.
+            Omit to run normal auto-recharge once.'
     AutoRechargeTriggerResponse:
       type: object
       description: Response schema for POST auto-recharge/trigger/ (200).
@@ -36086,6 +36217,13 @@ components:
         auto_recharge_enabled:
           type: boolean
           description: Enable or disable auto-recharge.
+        auto_recharge_spending_limit_usd:
+          type: string
+          format: decimal
+          pattern: ^-?\d{0,11}(?:\.\d{0,3})?$
+          description: Cap on auto-recharge + manual top-up per 30-day period (user
+            USD). 0 = unlimited. When > 0, backend sets recharge amount to 20% of
+            limit (min $0.50).
         platform_key:
           type: string
           readOnly: true
@@ -36145,6 +36283,32 @@ components:
         pricing_table:
           readOnly: true
           description: Stripe pricing table details for topping up credits.
+        free_trial:
+          type: boolean
+          readOnly: true
+          description: True if the account is on the free trial plan (no paid plan
+            purchased yet).
+        current_plan:
+          type: string
+          readOnly: true
+          nullable: true
+          description: Current plan identifier, e.g. 'free_trial' or Stripe product
+            SKU.
+        previous_plan:
+          type: string
+          readOnly: true
+          nullable: true
+          description: Previous plan before the last purchase.
+        can_use_auto_recharge:
+          type: boolean
+          readOnly: true
+          description: True if the current plan is not free_trial (paid plans can
+            use auto-recharge).
+        has_payment_method:
+          type: boolean
+          readOnly: true
+          description: True if the user has a payment method on file (can use manual
+            top-up and auto-recharge).
       required:
       - account_id
       - auto_recharge_amount_usd
@@ -36152,9 +36316,68 @@ components:
       - auto_recharge_last_triggered_at
       - auto_recharge_threshold_usd
       - available_credits
+      - can_use_auto_recharge
+      - current_plan
+      - free_trial
       - has_credits
+      - has_payment_method
       - platform_key
+      - previous_plan
       - pricing_table
+    CreditTransactionHistory:
+      type: object
+      description: |-
+        Serializer for user-facing transaction history.
+        NEVER exposes internal USD amounts (amount_usd, usd_balance_*).
+      properties:
+        id:
+          type: string
+          format: uuid
+          readOnly: true
+        transaction_type:
+          $ref: '#/components/schemas/TransactionTypeEnum'
+        status:
+          $ref: '#/components/schemas/CreditTransactionHistoryStatusEnum'
+        payment_amount_usd:
+          type: string
+          readOnly: true
+        credits_amount:
+          type: string
+          readOnly: true
+        credits_balance_after:
+          type: string
+          readOnly: true
+        description:
+          type: string
+          readOnly: true
+        service_name:
+          type: string
+          nullable: true
+          maxLength: 255
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+      required:
+      - created_at
+      - credits_amount
+      - credits_balance_after
+      - description
+      - id
+      - payment_amount_usd
+      - transaction_type
+    CreditTransactionHistoryStatusEnum:
+      enum:
+      - pending
+      - completed
+      - failed
+      - cancelled
+      type: string
+      description: |-
+        * `pending` - Pending
+        * `completed` - Completed
+        * `failed` - Failed
+        * `cancelled` - Cancelled
     DesiredRole:
       type: object
       properties:
@@ -36641,6 +36864,16 @@ components:
       - provider_name
       - provider_name_display
       - updated
+    FlowTypeEnum:
+      enum:
+      - payment_method_update
+      - subscription_update
+      - subscription_cancel
+      type: string
+      description: |-
+        * `payment_method_update` - Payment Method Update
+        * `subscription_update` - Subscription Update
+        * `subscription_cancel` - Subscription Cancel
     GCPTenantLaunchRequest:
       type: object
       properties:
@@ -39354,6 +39587,13 @@ components:
         auto_recharge_enabled:
           type: boolean
           description: Enable or disable auto-recharge.
+        auto_recharge_spending_limit_usd:
+          type: string
+          format: decimal
+          pattern: ^-?\d{0,11}(?:\.\d{0,3})?$
+          description: Cap on auto-recharge + manual top-up per 30-day period (user
+            USD). 0 = unlimited. When > 0, backend sets recharge amount to 20% of
+            limit (min $0.50).
         platform_key:
           type: string
           readOnly: true
@@ -44815,11 +45055,29 @@ components:
         return_url:
           type: string
           format: uri
-          description: URL to redirect to when the back button is clicked
+          description: URL to redirect to when the customer exits the portal (back
+            button)
         subscription_id:
           type: string
-          description: Provide a subscription id to set the default landing page to
-            subscription update
+          description: Subscription ID required for subscription_update or subscription_cancel
+            flows
+        flow_type:
+          nullable: true
+          description: |-
+            Type of flow to present: 'payment_method_update' for adding/updating payment method, 'subscription_update' for updating subscription, 'subscription_cancel' for cancellation. If not provided, shows the default portal homepage.
+
+            * `payment_method_update` - Payment Method Update
+            * `subscription_update` - Subscription Update
+            * `subscription_cancel` - Subscription Cancel
+          oneOf:
+          - $ref: '#/components/schemas/FlowTypeEnum'
+          - $ref: '#/components/schemas/NullEnum'
+        after_completion_url:
+          type: string
+          format: uri
+          nullable: true
+          description: URL to redirect after the flow is completed successfully. Only
+            used when flow_type is set. Defaults to return_url if not provided.
       required:
       - return_url
     StripeCustomerPortalResponse:
@@ -45469,6 +45727,22 @@ components:
       - course_identifier
       - course_name
       - time_spent_seconds
+    TransactionTypeEnum:
+      enum:
+      - add
+      - subtract
+      - reserve
+      - release
+      - rollover
+      - refund
+      type: string
+      description: |-
+        * `add` - Add Credits
+        * `subtract` - Subtract Credits
+        * `reserve` - Reserve Credits
+        * `release` - Release Reserved Credits
+        * `rollover` - Rollover Credits
+        * `refund` - Refund Credits
     Type24aEnum:
       enum:
       - ADMIN_NOTIF_COURSE_ENROLLMENT

package/src/core/OpenAPI.ts

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

package/src/index.ts

@@ -125,6 +125,8 @@ export type { Credential } from './models/Credential';
 export type { CredentialProviderConfig } from './models/CredentialProviderConfig';
 export type { CreditAccountAutoRechargeUpdate } from './models/CreditAccountAutoRechargeUpdate';
 export type { CreditAccountInfo } from './models/CreditAccountInfo';
+export type { CreditTransactionHistory } from './models/CreditTransactionHistory';
+export { CreditTransactionHistoryStatusEnum } from './models/CreditTransactionHistoryStatusEnum';
 export type { DesiredRole } from './models/DesiredRole';
 export type { DesiredRoleCreateUpdateRequest } from './models/DesiredRoleCreateUpdateRequest';
 export type { DesiredSkill } from './models/DesiredSkill';
@@ -145,6 +147,7 @@ export type { ErrorDetail } from './models/ErrorDetail';
 export type { ErrorResponse } from './models/ErrorResponse';
 export type { Experience } from './models/Experience';
 export type { ExternalCredentialMapping } from './models/ExternalCredentialMapping';
+export { FlowTypeEnum } from './models/FlowTypeEnum';
 export type { GCPTenantLaunchRequest } from './models/GCPTenantLaunchRequest';
 export type { GlobalCatalogSearchResponse } from './models/GlobalCatalogSearchResponse';
 export type { GooglePayAccountResponse } from './models/GooglePayAccountResponse';
@@ -447,6 +450,7 @@ export type { TokenProxyOutput } from './models/TokenProxyOutput';
 export type { TokenProxyOutputSerializerData } from './models/TokenProxyOutputSerializerData';
 export type { TokenProxyUser } from './models/TokenProxyUser';
 export type { TopContent } from './models/TopContent';
+export { TransactionTypeEnum } from './models/TransactionTypeEnum';
 export { Type24aEnum } from './models/Type24aEnum';
 export type { UploadedImage } from './models/UploadedImage';
 export type { UserApp } from './models/UserApp';
@@ -526,3 +530,4 @@ export { ReportsService } from './services/ReportsService';
 export { ScimService } from './services/ScimService';
 export { SearchService } from './services/SearchService';
 export { SkillsService } from './services/SkillsService';
+export { TransactionsService } from './services/TransactionsService';

package/src/models/AutoRechargeTriggerRequest.ts

@@ -10,5 +10,9 @@ export type AutoRechargeTriggerRequest = {
      * The unique key of the platform. Defaults to 'main'.
      */
     platform_key?: string;
+    /**
+     * Optional. When set, perform manual top-up: charge this amount (user USD) and add credits. No threshold, spending limit, or cooldown. Omit to run normal auto-recharge once.
+     */
+    amount_usd?: string;
 };
 

package/src/models/CreditAccountAutoRechargeUpdate.ts

@@ -18,6 +18,10 @@ export type CreditAccountAutoRechargeUpdate = {
      * Enable or disable auto-recharge.
      */
     auto_recharge_enabled?: boolean;
+    /**
+     * Cap on auto-recharge + manual top-up per 30-day period (user USD). 0 = unlimited. When > 0, backend sets recharge amount to 20% of limit (min $0.50).
+     */
+    auto_recharge_spending_limit_usd?: string;
     /**
      * The platform key to update settings for (read-only in update context).
      */

package/src/models/CreditAccountInfo.ts

@@ -45,5 +45,25 @@ export type CreditAccountInfo = {
      * Stripe pricing table details for topping up credits.
      */
     readonly pricing_table: any;
+    /**
+     * True if the account is on the free trial plan (no paid plan purchased yet).
+     */
+    readonly free_trial: boolean;
+    /**
+     * Current plan identifier, e.g. 'free_trial' or Stripe product SKU.
+     */
+    readonly current_plan: string | null;
+    /**
+     * Previous plan before the last purchase.
+     */
+    readonly previous_plan: string | null;
+    /**
+     * True if the current plan is not free_trial (paid plans can use auto-recharge).
+     */
+    readonly can_use_auto_recharge: boolean;
+    /**
+     * True if the user has a payment method on file (can use manual top-up and auto-recharge).
+     */
+    readonly has_payment_method: boolean;
 };
 

package/src/models/CreditTransactionHistory.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CreditTransactionHistoryStatusEnum } from './CreditTransactionHistoryStatusEnum';
+import type { TransactionTypeEnum } from './TransactionTypeEnum';
+/**
+ * Serializer for user-facing transaction history.
+ * NEVER exposes internal USD amounts (amount_usd, usd_balance_*).
+ */
+export type CreditTransactionHistory = {
+    readonly id: string;
+    transaction_type: TransactionTypeEnum;
+    status?: CreditTransactionHistoryStatusEnum;
+    readonly payment_amount_usd: string;
+    readonly credits_amount: string;
+    readonly credits_balance_after: string;
+    readonly description: string;
+    service_name?: string | null;
+    readonly created_at: string;
+};
+

package/src/models/CreditTransactionHistoryStatusEnum.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `pending` - Pending
+ * * `completed` - Completed
+ * * `failed` - Failed
+ * * `cancelled` - Cancelled
+ */
+export enum CreditTransactionHistoryStatusEnum {
+    PENDING = 'pending',
+    COMPLETED = 'completed',
+    FAILED = 'failed',
+    CANCELLED = 'cancelled',
+}

package/src/models/FlowTypeEnum.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `payment_method_update` - Payment Method Update
+ * * `subscription_update` - Subscription Update
+ * * `subscription_cancel` - Subscription Cancel
+ */
+export enum FlowTypeEnum {
+    PAYMENT_METHOD_UPDATE = 'payment_method_update',
+    SUBSCRIPTION_UPDATE = 'subscription_update',
+    SUBSCRIPTION_CANCEL = 'subscription_cancel',
+}

package/src/models/PatchedCreditAccountAutoRechargeUpdate.ts

@@ -18,6 +18,10 @@ export type PatchedCreditAccountAutoRechargeUpdate = {
      * Enable or disable auto-recharge.
      */
     auto_recharge_enabled?: boolean;
+    /**
+     * Cap on auto-recharge + manual top-up per 30-day period (user USD). 0 = unlimited. When > 0, backend sets recharge amount to 20% of limit (min $0.50).
+     */
+    auto_recharge_spending_limit_usd?: string;
     /**
      * The platform key to update settings for (read-only in update context).
      */

package/src/models/StripeCustomerPortalRequest.ts

@@ -2,14 +2,28 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+import type { FlowTypeEnum } from './FlowTypeEnum';
+import type { NullEnum } from './NullEnum';
 export type StripeCustomerPortalRequest = {
     /**
-     * URL to redirect to when the back button is clicked
+     * URL to redirect to when the customer exits the portal (back button)
      */
     return_url: string;
     /**
-     * Provide a subscription id to set the default landing page to subscription update
+     * Subscription ID required for subscription_update or subscription_cancel flows
      */
     subscription_id?: string;
+    /**
+     * Type of flow to present: 'payment_method_update' for adding/updating payment method, 'subscription_update' for updating subscription, 'subscription_cancel' for cancellation. If not provided, shows the default portal homepage.
+     *
+     * * `payment_method_update` - Payment Method Update
+     * * `subscription_update` - Subscription Update
+     * * `subscription_cancel` - Subscription Cancel
+     */
+    flow_type?: (FlowTypeEnum | NullEnum) | null;
+    /**
+     * URL to redirect after the flow is completed successfully. Only used when flow_type is set. Defaults to return_url if not provided.
+     */
+    after_completion_url?: string | null;
 };
 

package/src/models/TransactionTypeEnum.ts

@@ -0,0 +1,20 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `add` - Add Credits
+ * * `subtract` - Subtract Credits
+ * * `reserve` - Reserve Credits
+ * * `release` - Release Reserved Credits
+ * * `rollover` - Rollover Credits
+ * * `refund` - Refund Credits
+ */
+export enum TransactionTypeEnum {
+    ADD = 'add',
+    SUBTRACT = 'subtract',
+    RESERVE = 'reserve',
+    RELEASE = 'release',
+    ROLLOVER = 'rollover',
+    REFUND = 'refund',
+}

package/src/services/AccountService.ts

@@ -33,7 +33,7 @@ export class AccountService {
     }
     /**
      * Update auto-recharge preferences
-     * Update auto_recharge_threshold_usd, auto_recharge_amount_usd, and/or auto_recharge_enabled. Pass platform_key in the request body to update platform settings.
+     * Update auto_recharge_threshold_usd, auto_recharge_amount_usd, auto_recharge_enabled, and/or auto_recharge_spending_limit_usd. When enabling auto-recharge, missing values are calculated: if only limit set, amount = 20% of limit; if only amount set, limit = 5x amount; if neither set, defaults are limit=20, amount=4. Pass platform_key in the request body to update platform settings.
      * @returns CreditAccountInfo
      * @throws ApiError
      */

package/src/services/AutoRechargeService.ts

@@ -9,8 +9,8 @@ import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 export class AutoRechargeService {
     /**
-     * Trigger auto-recharge
-     * Run auto-recharge once if the account has it enabled and balance is below threshold. Returns 400 if skipped or failed (e.g. no payment method, cooldown). Pass platform_key in request body.
+     * Trigger auto-recharge or manual top-up
+     * With amount_usd: manual top-up (charge that amount, add credits; no threshold/limit/cooldown). Without amount_usd: run auto-recharge once if enabled and balance below threshold. Returns 400 if skipped or failed (e.g. no payment method, cooldown). Pass platform_key in request body.
      * @returns AutoRechargeTriggerResponse
      * @throws ApiError
      */