@4players/payment 1.0.1-beta.4 → 1.0.2-beta.2

package/dist/index.d.ts

@@ -445,8 +445,9 @@ interface paths {
         get?: never;
         put?: never;
         /**
-         * Activate an API for the specified project
-         * @description Activates the specified API for the project, enabling access to additional features.
+         * [Deprecated] Activate an API for the specified project. Use /activate-product instead.
+         * @deprecated
+         * @description Activates the specified API for the project. This endpoint is deprecated - use /activate-product instead.
          */
         post: operations["activateAPI"];
         delete?: never;
@@ -455,6 +456,129 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/products": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List all available products
+         * @description Returns the catalog of all available products with their features and pricing tiers. No authentication required.
+         */
+        get: operations["getProducts"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/projects/{projectId}/products": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get activated products for a project
+         * @description Returns the list of products currently activated for the specified project.
+         */
+        get: operations["getProjectProducts"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/projects/{projectId}/activate-product": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Activate a product for a project
+         * @description Activates the specified product for the project. Dependencies are checked automatically. Returns the updated project.
+         */
+        post: operations["activateProduct"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/projects/{projectId}/deactivate-product": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Deactivate a product for a project
+         * @description Deactivates the specified product. Fails if other activated products depend on it.
+         */
+        post: operations["deactivateProduct"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/projects/{projectId}/check-feature": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Check if a feature is available for a project
+         * @description Checks whether the specified feature is available for the project based on activated products and their dependencies.
+         */
+        get: operations["checkFeature"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/projects/{projectId}/check-product-dependencies": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Check product dependencies for a project
+         * @description Returns whether a product can be activated for the given project by checking all
+         *     its dependencies. Each dependency is listed with its current activation status.
+         *     Use this endpoint to build UI that shows missing dependencies before the user
+         *     attempts to activate a product.
+         */
+        get: operations["checkProductDependencies"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/projects/{projectId}/create-token": {
         parameters: {
             query?: never;
@@ -676,6 +800,8 @@ interface components {
             type?: string;
             /** @description The billing state history */
             billingStateHistory?: components["schemas"]["BillingState"][];
+            /** @description List of products currently activated for this project. */
+            activatedProducts?: components["schemas"]["ActivatedProduct"][];
         };
         SetupSession: {
             /** @description The URL that the user needs to be redirected to in order to create a new billing account at Stripe. */
@@ -1041,6 +1167,107 @@ interface components {
             /** Format: date */
             active?: string;
         };
+        /**
+         * @description The unique slug identifier for a product.
+         * @enum {string}
+         */
+        ProductSlug: "voice" | "rooms" | "fleet" | "cortex";
+        /**
+         * @description The type of pricing model.
+         * @enum {string}
+         */
+        PricingType: "free" | "pay_as_you_go" | "one_time" | "monthly";
+        ProjectProduct: {
+            slug?: components["schemas"]["ProductSlug"];
+            /** @description Translation key for the product name. */
+            name?: string;
+            /** @description Translation key for the product description. */
+            description?: string;
+            /** @description Icon identifier or URL. */
+            icon?: string | null;
+            /** @description Features available within this product. */
+            features?: components["schemas"]["ProjectProductFeature"][];
+            /** @description Available pricing tiers for this product. */
+            pricing?: components["schemas"]["ProductPricing"][];
+            /** @description Slugs of products that must be activated before this product. */
+            dependencies?: components["schemas"]["ProductSlug"][];
+        };
+        ProjectProductFeature: {
+            /** @description Unique slug for the feature (e.g. cortex.transcription). */
+            slug?: string;
+            /** @description Translation key for the feature name. */
+            name?: string;
+            /** @description Translation key for the feature description. */
+            description?: string;
+            /** @description Product that must be activated for this feature to work. */
+            dependsOnProduct?: components["schemas"]["ProductSlug"];
+            /** @description Slug of another feature this depends on. */
+            dependsOnFeature?: string | null;
+        };
+        ProductPricing: {
+            pricingType?: components["schemas"]["PricingType"];
+            /** @description Stripe price ID for paid tiers. */
+            stripePriceId?: string | null;
+            /** @description Unit label for pay-as-you-go pricing (e.g. PCU-day, instance-day). */
+            unit?: string | null;
+            /** @description Amount in cents. */
+            unitAmount?: number;
+            /**
+             * @description ISO 4217 currency code.
+             * @example EUR
+             */
+            currency?: string;
+            /** @description Human-readable tier label. */
+            label?: string | null;
+        };
+        ActivatedProduct: {
+            /** @description Encoded unique identifier for the activation. */
+            id?: string;
+            product?: components["schemas"]["ProjectProduct"];
+            /**
+             * Format: date-time
+             * @description When the product was activated.
+             */
+            activatedAt?: string;
+            /** @description Product-specific configuration (e.g. domain for rooms). */
+            config?: {
+                [key: string]: unknown;
+            } | null;
+        };
+        ActivateProductPayload: {
+            /** @description The slug of the product to activate. */
+            product: components["schemas"]["ProductSlug"];
+            /** @description Optional product-specific configuration (e.g. {"domain":"example"} for rooms). */
+            config?: {
+                [key: string]: unknown;
+            };
+        };
+        DeactivateProductPayload: {
+            /** @description The slug of the product to deactivate. */
+            product: components["schemas"]["ProductSlug"];
+        };
+        FeatureAvailability: {
+            /** @description The feature slug that was checked. */
+            feature?: string;
+            /** @description Whether the feature is currently available for this project. */
+            available?: boolean;
+            /** @description List of product or feature slugs that must be activated first. */
+            missingDependencies?: string[];
+        };
+        ProductDependencyCheck: {
+            /** @description The product slug that was checked. */
+            product?: components["schemas"]["ProductSlug"];
+            /** @description Whether all dependencies are satisfied and the product can be activated. */
+            canActivate?: boolean;
+            /** @description List of required products with their activation status. */
+            dependencies?: components["schemas"]["ProductDependencyStatus"][];
+        };
+        ProductDependencyStatus: {
+            /** @description The slug of the required product. */
+            product?: components["schemas"]["ProductSlug"];
+            /** @description Whether this dependency is currently activated for the project. */
+            satisfied?: boolean;
+        };
     };
     responses: never;
     parameters: never;
@@ -2171,6 +2398,253 @@ interface operations {
             };
         };
     };
+    getProducts: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description A list of all available products. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectProduct"][];
+                };
+            };
+        };
+    };
+    getProjectProducts: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique identifier of the project. */
+                projectId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description List of activated products. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ActivatedProduct"][];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Project not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    activateProduct: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ActivateProductPayload"];
+            };
+        };
+        responses: {
+            /** @description Successfully activated the product. Returns the updated project. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentProject"];
+                };
+            };
+            /** @description Bad request - missing product slug, dependency not met, already activated, or invalid configuration. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UnauthorizedResponse"];
+                };
+            };
+            /** @description Project or product not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    deactivateProduct: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DeactivateProductPayload"];
+            };
+        };
+        responses: {
+            /** @description Successfully deactivated the product. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SuccessResponse"];
+                };
+            };
+            /** @description Cannot deactivate - product not active or other products depend on it. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UnauthorizedResponse"];
+                };
+            };
+            /** @description Project or product not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    checkFeature: {
+        parameters: {
+            query: {
+                /** @description The feature slug to check (e.g. cortex.transcription, cortex.functions). */
+                feature: string;
+            };
+            header?: never;
+            path: {
+                projectId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Feature availability status. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FeatureAvailability"];
+                };
+            };
+            /** @description Missing feature query parameter */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Project or feature not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    checkProductDependencies: {
+        parameters: {
+            query: {
+                /** @description The product slug to check (e.g. rooms, cortex). */
+                product: components["schemas"]["ProductSlug"];
+            };
+            header?: never;
+            path: {
+                projectId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Product dependency check result. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProductDependencyCheck"];
+                };
+            };
+            /** @description Missing product query parameter or unknown product */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Project not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     createAccessToken: {
         parameters: {
             query?: never;
@@ -2490,11 +2964,20 @@ type BillingChangeOptions = components["schemas"]["BillingChangeOptions"];
 type BillingStateHistory = components["schemas"]["BillingStateHistory"];
 type ResourcePackagePrice = components["schemas"]["ResourcePackagePrice"];
 type SuccessResponse = components["schemas"]["SuccessResponse"];
+type ProjectProduct = components["schemas"]["ProjectProduct"];
+type ProjectProductFeature = components["schemas"]["ProjectProductFeature"];
+type ProductPricing = components["schemas"]["ProductPricing"];
+type ActivatedProduct = components["schemas"]["ActivatedProduct"];
+type FeatureAvailability = components["schemas"]["FeatureAvailability"];
+type ProductDependencyCheck = components["schemas"]["ProductDependencyCheck"];
+type ProductDependencyStatus = components["schemas"]["ProductDependencyStatus"];
 type APIType = components["schemas"]["APIType"];
 type BillingState = components["schemas"]["BillingState"];
 type PermissionRole = components["schemas"]["PermissionRole"];
 type UserStatus = components["schemas"]["UserStatus"];
 type InvoiceStatus = components["schemas"]["InvoiceStatus"];
+type ProductSlug = components["schemas"]["ProductSlug"];
+type PricingType = components["schemas"]["PricingType"];
 type ActivateAPIPayload = components["schemas"]["ActivateAPIPayload"];
 type AddUserToProjectPayload = components["schemas"]["AddUserToProjectPayload"];
 type ChangeUserRolePayload = components["schemas"]["ChangeUserRolePayload"];
@@ -2508,11 +2991,15 @@ type ResourcePackagePricePayload = components["schemas"]["ResourcePackagePricePa
 type ResourcePackagePricesPayload = components["schemas"]["ResourcePackagePricesPayload"];
 type RevokeUserPayload = components["schemas"]["RevokeUserPayload"];
 type SetBillingAccountPayload = components["schemas"]["SetBillingAccountPayload"];
+type ActivateProductPayload = components["schemas"]["ActivateProductPayload"];
+type DeactivateProductPayload = components["schemas"]["DeactivateProductPayload"];
 type GetProjectsQuery = operations["getProjects"]["parameters"]["query"];
 type GetPeersOverTimeQuery = operations["getPeersOverTime"]["parameters"]["query"];
 type GetRoomsOverTimeQuery = operations["getRoomsOverTime"]["parameters"]["query"];
 type GetInstancesOverTimeQuery = operations["getInstancesOverTime"]["parameters"]["query"];
 type GetInvoicesQuery = operations["getInvoices"]["parameters"]["query"];
+type CheckFeatureQuery = operations["checkFeature"]["parameters"]["query"];
+type CheckProductDependenciesQuery = operations["checkProductDependencies"]["parameters"]["query"];
 /**
  * 4Players Payment API Client
  *
@@ -2665,11 +3152,57 @@ declare class PaymentClient {
     /**
      * Activate an API for the specified project.
      *
+     * @deprecated Use {@link activateProduct} instead.
      * @param projectId - The unique identifier of the project
      * @param body - The API slug to activate
      * @returns Success response
      */
     activateAPI(projectId: string, body: ActivateAPIPayload): Promise<SuccessResponse>;
+    /**
+     * List all available products.
+     *
+     * @returns Array of available products with features and pricing
+     */
+    getProducts(): Promise<ProjectProduct[]>;
+    /**
+     * Get activated products for a project.
+     *
+     * @param projectId - The unique identifier of the project
+     * @returns Array of activated products
+     */
+    getProjectProducts(projectId: string): Promise<ActivatedProduct[]>;
+    /**
+     * Activate a product for a project.
+     *
+     * @param projectId - The unique identifier of the project
+     * @param body - The product slug and optional configuration
+     * @returns Updated project
+     */
+    activateProduct(projectId: string, body: ActivateProductPayload): Promise<PaymentProject>;
+    /**
+     * Deactivate a product for a project.
+     *
+     * @param projectId - The unique identifier of the project
+     * @param body - The product slug to deactivate
+     * @returns Success response
+     */
+    deactivateProduct(projectId: string, body: DeactivateProductPayload): Promise<SuccessResponse>;
+    /**
+     * Check if a feature is available for a project.
+     *
+     * @param projectId - The unique identifier of the project
+     * @param query - Query with the feature slug to check
+     * @returns Feature availability status
+     */
+    checkFeature(projectId: string, query: CheckFeatureQuery): Promise<FeatureAvailability>;
+    /**
+     * Check product dependencies for a project.
+     *
+     * @param projectId - The unique identifier of the project
+     * @param query - Query with the product slug to check
+     * @returns Dependency check result with activation status of each dependency
+     */
+    checkProductDependencies(projectId: string, query: CheckProductDependenciesQuery): Promise<ProductDependencyCheck>;
     /**
      * Get all invoices for the current user, optionally filtered by ID.
      *
@@ -2837,4 +3370,4 @@ declare class PaymentRateLimitError extends PaymentError {
     constructor(retryAfter?: number);
 }
 
-export { type APIType, type ActivateAPIPayload, type AddUserToProjectPayload, type BillingAccount, type BillingChangeOptions, type BillingOptions, type BillingState, type BillingStateHistory, type ChangeUserRolePayload, type CreateAccessKeyPayload, type CreateBillingPortalSessionPayload, type CreateSetupSessionPayload, type CreateTokenPayload, type EditAccessKeyPayload, type EditProjectPayload, type GetInstancesOverTimeQuery, type GetInvoicesQuery, type GetPeersOverTimeQuery, type GetProjectsQuery, type GetRoomsOverTimeQuery, type Invoice, type InvoicePosition, type InvoiceStatus, type Invoices, type OdinAccessKey, type OdinUserPermissions, type OdinUserRole, PaymentApiError, PaymentAuthError, PaymentClient, type PaymentClientConfig, PaymentError, PaymentNotFoundError, type PaymentProject, PaymentRateLimitError, PaymentValidationError, type PermissionRole, type PortalSession, type ResourcePackagePrice, type ResourcePackagePricePayload, type ResourcePackagePricesPayload, type RevokeUserPayload, type SetBillingAccountPayload, type SetupSession, type Subscription, type SubscriptionPosition, type SuccessResponse, type TariffParams, type TimeSeriesData, type TokenPayload, type UserStatus, type components, PaymentClient as default, type operations, type paths };
+export { type APIType, type ActivateAPIPayload, type ActivateProductPayload, type ActivatedProduct, type AddUserToProjectPayload, type BillingAccount, type BillingChangeOptions, type BillingOptions, type BillingState, type BillingStateHistory, type ChangeUserRolePayload, type CheckFeatureQuery, type CheckProductDependenciesQuery, type CreateAccessKeyPayload, type CreateBillingPortalSessionPayload, type CreateSetupSessionPayload, type CreateTokenPayload, type DeactivateProductPayload, type EditAccessKeyPayload, type EditProjectPayload, type FeatureAvailability, type GetInstancesOverTimeQuery, type GetInvoicesQuery, type GetPeersOverTimeQuery, type GetProjectsQuery, type GetRoomsOverTimeQuery, type Invoice, type InvoicePosition, type InvoiceStatus, type Invoices, type OdinAccessKey, type OdinUserPermissions, type OdinUserRole, PaymentApiError, PaymentAuthError, PaymentClient, type PaymentClientConfig, PaymentError, PaymentNotFoundError, type PaymentProject, PaymentRateLimitError, PaymentValidationError, type PermissionRole, type PortalSession, type PricingType, type ProductDependencyCheck, type ProductDependencyStatus, type ProductPricing, type ProductSlug, type ProjectProduct, type ProjectProductFeature, type ResourcePackagePrice, type ResourcePackagePricePayload, type ResourcePackagePricesPayload, type RevokeUserPayload, type SetBillingAccountPayload, type SetupSession, type Subscription, type SubscriptionPosition, type SuccessResponse, type TariffParams, type TimeSeriesData, type TokenPayload, type UserStatus, type components, PaymentClient as default, type operations, type paths };