@augstash/sdk 0.2.0 → 0.3.0

package/dist/generated/src/apis/AutomationIdentityApi.js

@@ -0,0 +1,91 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutomationIdentityApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class AutomationIdentityApi extends runtime.BaseAPI {
+    /**
+     * Returns the workspace this credential belongs to and the scopes it carries, so an automation tool can label the connection and grey out actions the key cannot perform. Nothing here is secret — it is the caller\'s own identity, echoed back. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Identify the calling credential
+     */
+    async meIntegrationsRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/me`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AutomationIdentityResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Returns the workspace this credential belongs to and the scopes it carries, so an automation tool can label the connection and grey out actions the key cannot perform. Nothing here is secret — it is the caller\'s own identity, echoed back. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Identify the calling credential
+     */
+    async meIntegrations(initOverrides) {
+        const response = await this.meIntegrationsRaw(initOverrides);
+        return await response.value();
+    }
+}
+exports.AutomationIdentityApi = AutomationIdentityApi;

package/dist/generated/src/apis/AutomationSubscriptionApi.d.ts

@@ -0,0 +1,111 @@
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AutomationSubscriptionResponse, CreateSubscriptionRequest, PageResponseAutomationSubscriptionResponse, Pageable } from '../models/index';
+export interface ListIntegrationsSubscriptionsRequest {
+    pageable: Pageable;
+}
+export interface SubscribeRequest {
+    createSubscriptionRequest: CreateSubscriptionRequest;
+    xIdempotencyKey?: string;
+}
+export interface UnsubscribeRequest {
+    id: string;
+    xIdempotencyKey?: string;
+}
+/**
+ * AutomationSubscriptionApi - interface
+ *
+ * @export
+ * @interface AutomationSubscriptionApiInterface
+ */
+export interface AutomationSubscriptionApiInterface {
+    /**
+     * Only subscriptions created through this surface — endpoints registered by hand in the webhook manager are not shown, because a subscription is exactly one event and a hand-made endpoint may carry several. Reads < 300ms. Requires API-key scope: integrations:read.
+     * @summary List this workspace\'s automation subscriptions
+     * @param {Pageable} pageable
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomationSubscriptionApiInterface
+     */
+    listIntegrationsSubscriptionsRaw(requestParameters: ListIntegrationsSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseAutomationSubscriptionResponse>>;
+    /**
+     * Only subscriptions created through this surface — endpoints registered by hand in the webhook manager are not shown, because a subscription is exactly one event and a hand-made endpoint may carry several. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List this workspace\'s automation subscriptions
+     */
+    listIntegrationsSubscriptions(requestParameters: ListIntegrationsSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseAutomationSubscriptionResponse>;
+    /**
+     * One event per subscription: automation tools turn individual workflows on and off, and a shared receiver could not be unsubscribed from one of them. The event is POSTed to targetUrl, HMAC-signed like every other Augstash webhook. Writes < 500ms. Requires API-key scope: integrations:write.
+     * @summary Subscribe an automation target URL to one event
+     * @param {CreateSubscriptionRequest} createSubscriptionRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomationSubscriptionApiInterface
+     */
+    subscribeRaw(requestParameters: SubscribeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutomationSubscriptionResponse>>;
+    /**
+     * One event per subscription: automation tools turn individual workflows on and off, and a shared receiver could not be unsubscribed from one of them. The event is POSTed to targetUrl, HMAC-signed like every other Augstash webhook. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Subscribe an automation target URL to one event
+     */
+    subscribe(requestParameters: SubscribeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutomationSubscriptionResponse>;
+    /**
+     * Deliberately NOT idempotent: an automation tool retries an unsubscribe and reads 404 as \'already gone\', so answering 204 for an id that was never yours would hide a tool unsubscribing against the wrong workspace. Writes < 500ms. Requires API-key scope: integrations:write.
+     * @summary Unsubscribe
+     * @param {string} id
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomationSubscriptionApiInterface
+     */
+    unsubscribeRaw(requestParameters: UnsubscribeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deliberately NOT idempotent: an automation tool retries an unsubscribe and reads 404 as \'already gone\', so answering 204 for an id that was never yours would hide a tool unsubscribing against the wrong workspace. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Unsubscribe
+     */
+    unsubscribe(requestParameters: UnsubscribeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class AutomationSubscriptionApi extends runtime.BaseAPI implements AutomationSubscriptionApiInterface {
+    /**
+     * Only subscriptions created through this surface — endpoints registered by hand in the webhook manager are not shown, because a subscription is exactly one event and a hand-made endpoint may carry several. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List this workspace\'s automation subscriptions
+     */
+    listIntegrationsSubscriptionsRaw(requestParameters: ListIntegrationsSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseAutomationSubscriptionResponse>>;
+    /**
+     * Only subscriptions created through this surface — endpoints registered by hand in the webhook manager are not shown, because a subscription is exactly one event and a hand-made endpoint may carry several. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List this workspace\'s automation subscriptions
+     */
+    listIntegrationsSubscriptions(requestParameters: ListIntegrationsSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseAutomationSubscriptionResponse>;
+    /**
+     * One event per subscription: automation tools turn individual workflows on and off, and a shared receiver could not be unsubscribed from one of them. The event is POSTed to targetUrl, HMAC-signed like every other Augstash webhook. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Subscribe an automation target URL to one event
+     */
+    subscribeRaw(requestParameters: SubscribeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutomationSubscriptionResponse>>;
+    /**
+     * One event per subscription: automation tools turn individual workflows on and off, and a shared receiver could not be unsubscribed from one of them. The event is POSTed to targetUrl, HMAC-signed like every other Augstash webhook. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Subscribe an automation target URL to one event
+     */
+    subscribe(requestParameters: SubscribeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutomationSubscriptionResponse>;
+    /**
+     * Deliberately NOT idempotent: an automation tool retries an unsubscribe and reads 404 as \'already gone\', so answering 204 for an id that was never yours would hide a tool unsubscribing against the wrong workspace. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Unsubscribe
+     */
+    unsubscribeRaw(requestParameters: UnsubscribeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deliberately NOT idempotent: an automation tool retries an unsubscribe and reads 404 as \'already gone\', so answering 204 for an id that was never yours would hide a tool unsubscribing against the wrong workspace. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Unsubscribe
+     */
+    unsubscribe(requestParameters: UnsubscribeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}

package/dist/generated/src/apis/AutomationSubscriptionApi.js

@@ -0,0 +1,179 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutomationSubscriptionApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class AutomationSubscriptionApi extends runtime.BaseAPI {
+    /**
+     * Only subscriptions created through this surface — endpoints registered by hand in the webhook manager are not shown, because a subscription is exactly one event and a hand-made endpoint may carry several. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List this workspace\'s automation subscriptions
+     */
+    async listIntegrationsSubscriptionsRaw(requestParameters, initOverrides) {
+        if (requestParameters['pageable'] == null) {
+            throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling listIntegrationsSubscriptions().');
+        }
+        const queryParameters = {};
+        if (requestParameters['pageable'] != null) {
+            queryParameters['pageable'] = requestParameters['pageable'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/subscriptions`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PageResponseAutomationSubscriptionResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Only subscriptions created through this surface — endpoints registered by hand in the webhook manager are not shown, because a subscription is exactly one event and a hand-made endpoint may carry several. Reads < 300ms. Requires API-key scope: integrations:read.
+     * List this workspace\'s automation subscriptions
+     */
+    async listIntegrationsSubscriptions(requestParameters, initOverrides) {
+        const response = await this.listIntegrationsSubscriptionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * One event per subscription: automation tools turn individual workflows on and off, and a shared receiver could not be unsubscribed from one of them. The event is POSTed to targetUrl, HMAC-signed like every other Augstash webhook. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Subscribe an automation target URL to one event
+     */
+    async subscribeRaw(requestParameters, initOverrides) {
+        if (requestParameters['createSubscriptionRequest'] == null) {
+            throw new runtime.RequiredError('createSubscriptionRequest', 'Required parameter "createSubscriptionRequest" was null or undefined when calling subscribe().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/subscriptions`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateSubscriptionRequestToJSON)(requestParameters['createSubscriptionRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AutomationSubscriptionResponseFromJSON)(jsonValue));
+    }
+    /**
+     * One event per subscription: automation tools turn individual workflows on and off, and a shared receiver could not be unsubscribed from one of them. The event is POSTed to targetUrl, HMAC-signed like every other Augstash webhook. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Subscribe an automation target URL to one event
+     */
+    async subscribe(requestParameters, initOverrides) {
+        const response = await this.subscribeRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Deliberately NOT idempotent: an automation tool retries an unsubscribe and reads 404 as \'already gone\', so answering 204 for an id that was never yours would hide a tool unsubscribing against the wrong workspace. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Unsubscribe
+     */
+    async unsubscribeRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling unsubscribe().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/subscriptions/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Deliberately NOT idempotent: an automation tool retries an unsubscribe and reads 404 as \'already gone\', so answering 204 for an id that was never yours would hide a tool unsubscribing against the wrong workspace. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Unsubscribe
+     */
+    async unsubscribe(requestParameters, initOverrides) {
+        await this.unsubscribeRaw(requestParameters, initOverrides);
+    }
+}
+exports.AutomationSubscriptionApi = AutomationSubscriptionApi;

package/dist/generated/src/apis/BillingApi.d.ts

@@ -10,10 +10,14 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { BillingSpendSummaryResponse, InvoiceResponse, PaddleCheckoutRequest, PaddleCheckoutResponse, PageInvoiceResponse, PageTaxRecordResponse, Pageable, PaymentMethodRequest, PlanCardResponse, SubscriptionResponse, UsagePreviewResponse } from '../models/index';
+import type { BillingSpendSummaryResponse, ChangePlanRequest, InvoiceResponse, PaddleCheckoutRequest, PaddleCheckoutResponse, PageInvoiceResponse, PageTaxRecordResponse, Pageable, PaymentMethodRequest, PlanCardResponse, SubscriptionResponse, UsagePreviewResponse } from '../models/index';
 export interface CancelPaddleSubscriptionRequest {
     xIdempotencyKey?: string;
 }
+export interface ChangePlanOperationRequest {
+    changePlanRequest: ChangePlanRequest;
+    xIdempotencyKey?: string;
+}
 export interface InvoiceRequest {
     id: string;
 }
@@ -63,6 +67,21 @@ export interface BillingApiInterface {
      * Cancel the Paddle subscription at period end
      */
     cancelPaddleSubscription(requestParameters: CancelPaddleSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionResponse>;
+    /**
+     * Writes < 300ms. Moves the workspace to LITE, STARTER, GROWTH or SCALE and, with billingCycle, bills the plan MONTHLY or ANNUAL (twelve months in advance at 20% off) from the next invoice. Plans are billed in advance. The new plan\'s limits apply from the next request, and the term already paid is re-priced for the part still to run on the next invoice (an upgrade is charged, a downgrade credited). A move to a smaller plan is refused (PLAN_DOWNGRADE_BLOCKED, with data.params.over listing every limit that is over) until usage fits; nothing is deleted. Extra users are billed, never refused. A workspace on ENTERPRISE cannot change itself. Tenant admins only. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * @summary Change the workspace\'s plan
+     * @param {ChangePlanRequest} changePlanRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApiInterface
+     */
+    changePlanRaw(requestParameters: ChangePlanOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlanCardResponse>>;
+    /**
+     * Writes < 300ms. Moves the workspace to LITE, STARTER, GROWTH or SCALE and, with billingCycle, bills the plan MONTHLY or ANNUAL (twelve months in advance at 20% off) from the next invoice. Plans are billed in advance. The new plan\'s limits apply from the next request, and the term already paid is re-priced for the part still to run on the next invoice (an upgrade is charged, a downgrade credited). A move to a smaller plan is refused (PLAN_DOWNGRADE_BLOCKED, with data.params.over listing every limit that is over) until usage fits; nothing is deleted. Extra users are billed, never refused. A workspace on ENTERPRISE cannot change itself. Tenant admins only. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * Change the workspace\'s plan
+     */
+    changePlan(requestParameters: ChangePlanOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlanCardResponse>;
     /**
      * Reads < 300ms. Requires API-key scope: wallet:read.
      * @summary Get a single invoice
@@ -233,6 +252,16 @@ export declare class BillingApi extends runtime.BaseAPI implements BillingApiInt
      * Cancel the Paddle subscription at period end
      */
     cancelPaddleSubscription(requestParameters?: CancelPaddleSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionResponse>;
+    /**
+     * Writes < 300ms. Moves the workspace to LITE, STARTER, GROWTH or SCALE and, with billingCycle, bills the plan MONTHLY or ANNUAL (twelve months in advance at 20% off) from the next invoice. Plans are billed in advance. The new plan\'s limits apply from the next request, and the term already paid is re-priced for the part still to run on the next invoice (an upgrade is charged, a downgrade credited). A move to a smaller plan is refused (PLAN_DOWNGRADE_BLOCKED, with data.params.over listing every limit that is over) until usage fits; nothing is deleted. Extra users are billed, never refused. A workspace on ENTERPRISE cannot change itself. Tenant admins only. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * Change the workspace\'s plan
+     */
+    changePlanRaw(requestParameters: ChangePlanOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlanCardResponse>>;
+    /**
+     * Writes < 300ms. Moves the workspace to LITE, STARTER, GROWTH or SCALE and, with billingCycle, bills the plan MONTHLY or ANNUAL (twelve months in advance at 20% off) from the next invoice. Plans are billed in advance. The new plan\'s limits apply from the next request, and the term already paid is re-priced for the part still to run on the next invoice (an upgrade is charged, a downgrade credited). A move to a smaller plan is refused (PLAN_DOWNGRADE_BLOCKED, with data.params.over listing every limit that is over) until usage fits; nothing is deleted. Extra users are billed, never refused. A workspace on ENTERPRISE cannot change itself. Tenant admins only. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * Change the workspace\'s plan
+     */
+    changePlan(requestParameters: ChangePlanOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlanCardResponse>;
     /**
      * Reads < 300ms. Requires API-key scope: wallet:read.
      * Get a single invoice

package/dist/generated/src/apis/BillingApi.js

@@ -90,6 +90,48 @@ class BillingApi extends runtime.BaseAPI {
         const response = await this.cancelPaddleSubscriptionRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Writes < 300ms. Moves the workspace to LITE, STARTER, GROWTH or SCALE and, with billingCycle, bills the plan MONTHLY or ANNUAL (twelve months in advance at 20% off) from the next invoice. Plans are billed in advance. The new plan\'s limits apply from the next request, and the term already paid is re-priced for the part still to run on the next invoice (an upgrade is charged, a downgrade credited). A move to a smaller plan is refused (PLAN_DOWNGRADE_BLOCKED, with data.params.over listing every limit that is over) until usage fits; nothing is deleted. Extra users are billed, never refused. A workspace on ENTERPRISE cannot change itself. Tenant admins only. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * Change the workspace\'s plan
+     */
+    async changePlanRaw(requestParameters, initOverrides) {
+        if (requestParameters['changePlanRequest'] == null) {
+            throw new runtime.RequiredError('changePlanRequest', 'Required parameter "changePlanRequest" was null or undefined when calling changePlan().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/billing/plan`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.ChangePlanRequestToJSON)(requestParameters['changePlanRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PlanCardResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Writes < 300ms. Moves the workspace to LITE, STARTER, GROWTH or SCALE and, with billingCycle, bills the plan MONTHLY or ANNUAL (twelve months in advance at 20% off) from the next invoice. Plans are billed in advance. The new plan\'s limits apply from the next request, and the term already paid is re-priced for the part still to run on the next invoice (an upgrade is charged, a downgrade credited). A move to a smaller plan is refused (PLAN_DOWNGRADE_BLOCKED, with data.params.over listing every limit that is over) until usage fits; nothing is deleted. Extra users are billed, never refused. A workspace on ENTERPRISE cannot change itself. Tenant admins only. Not reachable with an ask_live_* API key - needs a signed-in user\'s token.
+     * Change the workspace\'s plan
+     */
+    async changePlan(requestParameters, initOverrides) {
+        const response = await this.changePlanRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Reads < 300ms. Requires API-key scope: wallet:read.
      * Get a single invoice