@l7mp/tivadar-ai-api-sdk 0.2.9 → 0.2.11

package/dist/apis/SubscriptionApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { BillingPortalRequest, BillingPortalResponse, CancelSubscriptionRequest, CancelSubscriptionResponse, CheckoutSessionResponse, CreateCheckoutSessionRequest, CreditBalance, CreditTransactionsResponse, PauseSubscriptionRequest, PauseSubscriptionResponse, ResumeSubscriptionResponse, SubscriptionDetails, SubscriptionStatus, UnpauseSubscriptionResponse, UpdatePlanRequest, UpdatePlanResponse } from '../models/index';
+import type { BillingPortalRequest, BillingPortalResponse, CancelSubscriptionRequest, CheckoutSessionResponse, CreateCheckoutSessionRequest, CurrentPeriodUsage, PauseSubscriptionRequest, PlanCatalogEntry, SubscriptionStatus, UpdatePlanRequest, UsageHistoryResponse } from '../models/index';
 export interface OrganizationsOrganizationIdSubscriptionBillingPortalPostRequest {
     organizationId: string;
     billingPortalRequest: BillingPortalRequest;
@@ -23,18 +23,6 @@ export interface OrganizationsOrganizationIdSubscriptionCheckoutPostRequest {
     organizationId: string;
     createCheckoutSessionRequest: CreateCheckoutSessionRequest;
 }
-export interface OrganizationsOrganizationIdSubscriptionCreditsGetRequest {
-    organizationId: string;
-}
-export interface OrganizationsOrganizationIdSubscriptionCreditsTransactionsGetRequest {
-    organizationId: string;
-    creditType?: string;
-    limit?: number;
-    offset?: number;
-}
-export interface OrganizationsOrganizationIdSubscriptionDetailsGetRequest {
-    organizationId: string;
-}
 export interface OrganizationsOrganizationIdSubscriptionGetRequest {
     organizationId: string;
 }
@@ -46,124 +34,115 @@ export interface OrganizationsOrganizationIdSubscriptionPlanPatchRequest {
     organizationId: string;
     updatePlanRequest: UpdatePlanRequest;
 }
+export interface OrganizationsOrganizationIdSubscriptionPlansGetRequest {
+    organizationId: string;
+}
 export interface OrganizationsOrganizationIdSubscriptionResumePostRequest {
     organizationId: string;
 }
 export interface OrganizationsOrganizationIdSubscriptionUnpausePostRequest {
     organizationId: string;
 }
+export interface OrganizationsOrganizationIdSubscriptionUsageGetRequest {
+    organizationId: string;
+}
+export interface OrganizationsOrganizationIdSubscriptionUsageHistoryGetRequest {
+    organizationId: string;
+    from?: Date;
+    to?: Date;
+    limit?: number;
+    offset?: number;
+}
 /**
  *
  */
 export declare class SubscriptionApi extends runtime.BaseAPI {
     /**
-     * Creates a Stripe Billing Portal session for the customer to manage their payment methods, view invoices, and update billing information. Returns a URL to redirect the customer to.
-     * Create billing portal session
+     * Create a Stripe billing portal session
      */
     organizationsOrganizationIdSubscriptionBillingPortalPostRaw(requestParameters: OrganizationsOrganizationIdSubscriptionBillingPortalPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BillingPortalResponse>>;
     /**
-     * Creates a Stripe Billing Portal session for the customer to manage their payment methods, view invoices, and update billing information. Returns a URL to redirect the customer to.
-     * Create billing portal session
+     * Create a Stripe billing portal session
      */
     organizationsOrganizationIdSubscriptionBillingPortalPost(requestParameters: OrganizationsOrganizationIdSubscriptionBillingPortalPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BillingPortalResponse>;
     /**
-     * Cancels the organization\'s subscription. By default, cancels at the end of the current billing period. Set cancelImmediately to true to cancel immediately.
-     * Cancel subscription
+     * Cancel the subscription (at period end by default)
      */
-    organizationsOrganizationIdSubscriptionCancelPostRaw(requestParameters: OrganizationsOrganizationIdSubscriptionCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CancelSubscriptionResponse>>;
+    organizationsOrganizationIdSubscriptionCancelPostRaw(requestParameters: OrganizationsOrganizationIdSubscriptionCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionStatus>>;
     /**
-     * Cancels the organization\'s subscription. By default, cancels at the end of the current billing period. Set cancelImmediately to true to cancel immediately.
-     * Cancel subscription
+     * Cancel the subscription (at period end by default)
      */
-    organizationsOrganizationIdSubscriptionCancelPost(requestParameters: OrganizationsOrganizationIdSubscriptionCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CancelSubscriptionResponse>;
+    organizationsOrganizationIdSubscriptionCancelPost(requestParameters: OrganizationsOrganizationIdSubscriptionCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionStatus>;
     /**
-     * Creates a Stripe checkout session for subscribing to a plan. Returns a checkout URL that the user should be redirected to complete payment.
-     * Create a checkout session for subscription
+     * Create a Stripe Checkout session
      */
     organizationsOrganizationIdSubscriptionCheckoutPostRaw(requestParameters: OrganizationsOrganizationIdSubscriptionCheckoutPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckoutSessionResponse>>;
     /**
-     * Creates a Stripe checkout session for subscribing to a plan. Returns a checkout URL that the user should be redirected to complete payment.
-     * Create a checkout session for subscription
+     * Create a Stripe Checkout session
      */
     organizationsOrganizationIdSubscriptionCheckoutPost(requestParameters: OrganizationsOrganizationIdSubscriptionCheckoutPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckoutSessionResponse>;
     /**
-     * Retrieves all credit balances for the organization\'s subscription. Returns an array of credit balances for different credit types.
-     * Get credit balances for an organization
+     * Get subscription status with current-period usage
      */
-    organizationsOrganizationIdSubscriptionCreditsGetRaw(requestParameters: OrganizationsOrganizationIdSubscriptionCreditsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CreditBalance>>>;
+    organizationsOrganizationIdSubscriptionGetRaw(requestParameters: OrganizationsOrganizationIdSubscriptionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionStatus>>;
     /**
-     * Retrieves all credit balances for the organization\'s subscription. Returns an array of credit balances for different credit types.
-     * Get credit balances for an organization
+     * Get subscription status with current-period usage
      */
-    organizationsOrganizationIdSubscriptionCreditsGet(requestParameters: OrganizationsOrganizationIdSubscriptionCreditsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CreditBalance>>;
+    organizationsOrganizationIdSubscriptionGet(requestParameters: OrganizationsOrganizationIdSubscriptionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionStatus>;
     /**
-     * Retrieves credit transaction history for the organization\'s subscription. Supports filtering by credit type and pagination.
-     * Get credit transaction history
+     * Pause payment collection
      */
-    organizationsOrganizationIdSubscriptionCreditsTransactionsGetRaw(requestParameters: OrganizationsOrganizationIdSubscriptionCreditsTransactionsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreditTransactionsResponse>>;
+    organizationsOrganizationIdSubscriptionPausePostRaw(requestParameters: OrganizationsOrganizationIdSubscriptionPausePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionStatus>>;
     /**
-     * Retrieves credit transaction history for the organization\'s subscription. Supports filtering by credit type and pagination.
-     * Get credit transaction history
+     * Pause payment collection
      */
-    organizationsOrganizationIdSubscriptionCreditsTransactionsGet(requestParameters: OrganizationsOrganizationIdSubscriptionCreditsTransactionsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreditTransactionsResponse>;
+    organizationsOrganizationIdSubscriptionPausePost(requestParameters: OrganizationsOrganizationIdSubscriptionPausePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionStatus>;
     /**
-     * Retrieves detailed subscription information including Stripe data.
-     * Get detailed subscription information
+     * Change subscription plan
      */
-    organizationsOrganizationIdSubscriptionDetailsGetRaw(requestParameters: OrganizationsOrganizationIdSubscriptionDetailsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionDetails>>;
+    organizationsOrganizationIdSubscriptionPlanPatchRaw(requestParameters: OrganizationsOrganizationIdSubscriptionPlanPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionStatus>>;
     /**
-     * Retrieves detailed subscription information including Stripe data.
-     * Get detailed subscription information
+     * Change subscription plan
      */
-    organizationsOrganizationIdSubscriptionDetailsGet(requestParameters: OrganizationsOrganizationIdSubscriptionDetailsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionDetails>;
+    organizationsOrganizationIdSubscriptionPlanPatch(requestParameters: OrganizationsOrganizationIdSubscriptionPlanPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionStatus>;
     /**
-     * Retrieves the subscription status for the organization from the subscription manager service. Returns information about the active plan, subscription period, and whether the subscription is active.
-     * Check subscription status for an organization
+     * List available plans and their prices
      */
-    organizationsOrganizationIdSubscriptionGetRaw(requestParameters: OrganizationsOrganizationIdSubscriptionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionStatus>>;
+    organizationsOrganizationIdSubscriptionPlansGetRaw(requestParameters: OrganizationsOrganizationIdSubscriptionPlansGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PlanCatalogEntry>>>;
     /**
-     * Retrieves the subscription status for the organization from the subscription manager service. Returns information about the active plan, subscription period, and whether the subscription is active.
-     * Check subscription status for an organization
+     * List available plans and their prices
      */
-    organizationsOrganizationIdSubscriptionGet(requestParameters: OrganizationsOrganizationIdSubscriptionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionStatus>;
+    organizationsOrganizationIdSubscriptionPlansGet(requestParameters: OrganizationsOrganizationIdSubscriptionPlansGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PlanCatalogEntry>>;
     /**
-     * Pauses payment collection for the subscription. The subscription remains active but invoices are marked as uncollectible. Optionally set a date to automatically resume collection.
-     * Pause subscription
+     * Resume a subscription scheduled for cancellation
      */
-    organizationsOrganizationIdSubscriptionPausePostRaw(requestParameters: OrganizationsOrganizationIdSubscriptionPausePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PauseSubscriptionResponse>>;
+    organizationsOrganizationIdSubscriptionResumePostRaw(requestParameters: OrganizationsOrganizationIdSubscriptionResumePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionStatus>>;
     /**
-     * Pauses payment collection for the subscription. The subscription remains active but invoices are marked as uncollectible. Optionally set a date to automatically resume collection.
-     * Pause subscription
+     * Resume a subscription scheduled for cancellation
      */
-    organizationsOrganizationIdSubscriptionPausePost(requestParameters: OrganizationsOrganizationIdSubscriptionPausePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PauseSubscriptionResponse>;
+    organizationsOrganizationIdSubscriptionResumePost(requestParameters: OrganizationsOrganizationIdSubscriptionResumePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionStatus>;
     /**
-     * Changes the subscription to a different plan/price. By default, prorations are created for the price difference.
-     * Update subscription plan
+     * Resume payment collection
      */
-    organizationsOrganizationIdSubscriptionPlanPatchRaw(requestParameters: OrganizationsOrganizationIdSubscriptionPlanPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdatePlanResponse>>;
+    organizationsOrganizationIdSubscriptionUnpausePostRaw(requestParameters: OrganizationsOrganizationIdSubscriptionUnpausePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionStatus>>;
     /**
-     * Changes the subscription to a different plan/price. By default, prorations are created for the price difference.
-     * Update subscription plan
+     * Resume payment collection
      */
-    organizationsOrganizationIdSubscriptionPlanPatch(requestParameters: OrganizationsOrganizationIdSubscriptionPlanPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdatePlanResponse>;
+    organizationsOrganizationIdSubscriptionUnpausePost(requestParameters: OrganizationsOrganizationIdSubscriptionUnpausePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionStatus>;
     /**
-     * Resumes a subscription that was scheduled for cancellation (cancel_at_period_end=true). Cannot resume a fully canceled subscription.
-     * Resume subscription
+     * Get current-period voice usage breakdown
      */
-    organizationsOrganizationIdSubscriptionResumePostRaw(requestParameters: OrganizationsOrganizationIdSubscriptionResumePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResumeSubscriptionResponse>>;
+    organizationsOrganizationIdSubscriptionUsageGetRaw(requestParameters: OrganizationsOrganizationIdSubscriptionUsageGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CurrentPeriodUsage>>;
     /**
-     * Resumes a subscription that was scheduled for cancellation (cancel_at_period_end=true). Cannot resume a fully canceled subscription.
-     * Resume subscription
+     * Get current-period voice usage breakdown
      */
-    organizationsOrganizationIdSubscriptionResumePost(requestParameters: OrganizationsOrganizationIdSubscriptionResumePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResumeSubscriptionResponse>;
+    organizationsOrganizationIdSubscriptionUsageGet(requestParameters: OrganizationsOrganizationIdSubscriptionUsageGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CurrentPeriodUsage>;
     /**
-     * Resumes payment collection for a paused subscription.
-     * Unpause subscription
+     * List individual usage records (paginated)
      */
-    organizationsOrganizationIdSubscriptionUnpausePostRaw(requestParameters: OrganizationsOrganizationIdSubscriptionUnpausePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UnpauseSubscriptionResponse>>;
+    organizationsOrganizationIdSubscriptionUsageHistoryGetRaw(requestParameters: OrganizationsOrganizationIdSubscriptionUsageHistoryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsageHistoryResponse>>;
     /**
-     * Resumes payment collection for a paused subscription.
-     * Unpause subscription
+     * List individual usage records (paginated)
      */
-    organizationsOrganizationIdSubscriptionUnpausePost(requestParameters: OrganizationsOrganizationIdSubscriptionUnpausePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UnpauseSubscriptionResponse>;
+    organizationsOrganizationIdSubscriptionUsageHistoryGet(requestParameters: OrganizationsOrganizationIdSubscriptionUsageHistoryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsageHistoryResponse>;
 }