@keboola/api-client 32.0.0 → 34.0.0

package/dist/billing/types.d.cts

@@ -0,0 +1,635 @@
+import { c as OpenapiReturnType } from "../index-V7XKUQm9.cjs";
+//#region src/clients/billing/__generated__/schema.d.ts
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+type paths = {
+  '/': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Service metadata
+     * @description Returns the service name, version and a link to this API specification.
+     *     No authentication required.
+     */
+    get: operations['index'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/health-check': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Health check
+     * @description Liveness/readiness probe. No authentication required.
+     */
+    get: operations['healthCheck'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/credits': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Show consumed and remaining credits.
+     * @description Show consumed and remaining credits of the project, identified by the Storage API token.
+     *     Requires a token whose project has the `pay-as-you-go` feature.
+     */
+    get: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description credits balance */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['Credits'];
+          };
+        };
+      };
+    };
+    put?: never;
+    /**
+     * Show consumed and remaining credits with optional top-up.
+     * @description Show consumed and remaining credits of the project, identified by the Storage API token. If the credit balance
+     *       is zero or negative, then an automatic top-up is attempted. If it succeeds, the new credit balance is returned.
+     *       Requires a token whose project has the `pay-as-you-go` feature.
+     */
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description credits balance */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['Credits'];
+          };
+        };
+      };
+    };
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/duration/workspace': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    /**
+     * Record duration of a workspace.
+     * @description Record durations of a workspace jobs per project. This is a servicing call for recording telemetry data.
+     *     Requires a Manage API application token with the `billing:manage` scope (or an equivalent ServiceAccount token).
+     */
+    put: operations['durationWorkspace'];
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/duration/job': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    /**
+     * Record duration of a project job.
+     * @description Record durations of a job in a project. This is a servicing call for recording telemetry data.
+     *     Requires a Manage API application token with the `billing:manage` scope (or an equivalent ServiceAccount token).
+     */
+    put: operations['durationJob'];
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/duration/container-sandbox': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    /**
+     * Record length of running a container sandbox.
+     * @description Record length of running a container sandbox. This is a servicing call for recording telemetry data.
+     *     Requires a Manage API application token with the `billing:manage` scope (or an equivalent ServiceAccount token).
+     */
+    put: operations['durationContainerSandbox'];
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/marketplaces/resolve-token': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Resolve subscription token
+     * @description Resolve subscription token provided by marketplace and returns related subscription details.
+     *     Requires a Manage API application token with the `marketplace-subscriptions:manage` scope (or an equivalent ServiceAccount token).
+     */
+    post: operations['marketplaces.resolveToken'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/marketplaces/confirm-subscription': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Confirm subcription
+     * @description Confirm subscription after on-boarding user.
+     *
+     *     Links the project to the subscription. Confirms to the marketplace that the subscription is ready to be used.
+     *     Requires a Manage API application token with the `marketplace-subscriptions:manage` scope (or an equivalent ServiceAccount token).
+     */
+    post: operations['marketplaces.confirmSubscription'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/marketplaces/azure-webhook': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Azure Marketplace webhook notification
+     * @description Receives subscription lifecycle notifications (ChangePlan, ChangeQuantity, Suspend,
+     *     Reinstate, Unsubscribe, Renew) from the Azure Marketplace SaaS fulfillment API.
+     *     Called by Azure Marketplace, not by Keboola clients; it is authenticated by the
+     *     Azure-issued JWT rather than a Keboola token.
+     */
+    post: operations['marketplaces.azureWebhook'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+};
+type components = {
+  schemas: {
+    Credits: {
+      /** @example 123 */
+      consumed: number;
+      /** @example 456 */
+      remaining: number;
+      stats?: {
+        componentJobs?: {
+          /** @example 4567.89 */
+          consumed?: number;
+        };
+        workspaceJobs?: {
+          /**
+           * @example writer
+           * @enum {string}
+           */
+          workspaceType?: 'writer' | 'sandbox-sql' | 'transformation' | 'sandbox-data-science';
+          /**
+           * @example x-large
+           * @enum {string}
+           */
+          warehouseSize?: 'x-small' | 'small' | 'medium' | 'large' | 'x-large' | '2x-large' | '3x-large' | '4x-large';
+          /** @example 1234.56 */
+          consumed?: number;
+        };
+        /**
+         * @example {
+         *       "vendor": "azure",
+         *       "state": "active",
+         *       "billingLink": "https://portal.azure.com/#view/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.SaaS%2Fresources"
+         *     }
+         */
+        marketplaceSubscription?: {
+          /** @enum {string} */
+          vendor: 'aws' | 'azure';
+          /** @enum {string} */
+          state: 'inactive' | 'active' | 'suspended' | 'unsubscribed';
+          /** Format: url */
+          billingLink: string;
+        };
+      };
+    };
+    DurationWorkspace: {
+      /** @example 123 */
+      PartitionKey?: string;
+      /** @example 05e238318064a0159e6547db5dd6583d */
+      RowKey?: string;
+      /** @example 123 */
+      projectId?: string;
+      /**
+       * @example writer
+       * @enum {string}
+       */
+      workspaceType?: 'writer' | 'sandbox-sql' | 'transformation' | 'sandbox-data-science';
+      /**
+       * @example x-large
+       * @enum {string}
+       */
+      warehouseSize?: 'x-small' | 'small' | 'medium' | 'large' | 'x-large' | '2x-large' | '3x-large' | '4x-large';
+      /** @example 123.45 */
+      durationSeconds?: number;
+    };
+    DurationJob: {
+      /** @example 123 */
+      PartitionKey?: string;
+      /** @example ac9fb9748cc233de6c25225a8b437c9a */
+      RowKey?: string;
+      /** @example 123 */
+      projectId?: string;
+      /** @example 456 */
+      jobId?: string;
+      /** @example 123.45 */
+      durationSeconds?: number;
+    };
+    /**
+     * @example {
+     *       "id": "1234",
+     *       "vendor": "gcp",
+     *       "vendorSubscriptionId": "564be70b-e1d8-4a75-8254-246895056064",
+     *       "productId": "keboola-europe-west3-saas",
+     *       "planId": "keboola-small-bigquery-P1Y",
+     *       "state": "active",
+     *       "organizationId": null,
+     *       "projectId": null,
+     *       "dateCreated": "2021-09-01T12:00:00+00:00",
+     *       "dateModified": "2021-09-01T12:00:00+00:00"
+     *     }
+     */
+    MarketplaceSubscription: {
+      id?: string;
+      /** @enum {string} */
+      vendor?: 'gcp' | 'aws' | 'azure';
+      vendorSubscriptionId?: string;
+      productId?: string | null;
+      planId?: string;
+      /** @enum {string} */
+      state?: 'inactive' | 'active' | 'suspended' | 'unsubscribed';
+      /** @description ID of organization attached to the subscription Is `null` until organization is attached using [/marketplaces/confirm-subscription](#/Marketplaces/marketplaces.confirmSubscription) */
+      organizationId?: string | null;
+      /** @description ID of project attached to the subscription. Is `null` until project is attached using [/marketplaces/confirm-subscription](#/Marketplaces/marketplaces.confirmSubscription) */
+      projectId?: string | null;
+      /** Format: date-time */
+      dateCreated?: string;
+      /** Format: date-time */
+      dateModified?: string;
+    };
+  };
+  responses: never;
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+};
+interface operations {
+  index: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Service metadata */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          /**
+           * @example {
+           *       "appName": "Billing API",
+           *       "appVersion": "1.2.3",
+           *       "apiDocs": "https://billing.keboola.com/docs/swagger.yaml"
+           *     }
+           */
+          'application/json': {
+            appName?: string;
+            appVersion?: string;
+            /** Format: url */
+            apiDocs?: string;
+          };
+        };
+      };
+    };
+  };
+  healthCheck: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Service is healthy */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': {
+            /** @example ok */
+            status?: string;
+          };
+        };
+      };
+    };
+  };
+  durationWorkspace: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'application/json': {
+          projectId?: string;
+          /** @enum {string} */
+          workspaceType?: 'writer' | 'sandbox' | 'transformation';
+          /** @enum {string} */
+          warehouseSize?: 'x-small' | 'small' | 'medium' | 'large' | 'x-large' | '2x-large' | '3x-large' | '4x-large';
+          durationSeconds?: number;
+        };
+      };
+    };
+    responses: {
+      /** @description Duration of job inserted */
+      201: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['DurationWorkspace'];
+        };
+      };
+    };
+  };
+  durationJob: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'application/json': {
+          projectId?: string;
+          jobId?: string;
+          durationSeconds?: number;
+        };
+      };
+    };
+    responses: {
+      /** @description Duration of job inserted */
+      201: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['DurationJob'];
+        };
+      };
+    };
+  };
+  durationContainerSandbox: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'application/json': {
+          projectId?: string;
+          sandboxId?: string;
+          sandboxType?: string;
+          durationSeconds?: number;
+        };
+      };
+    };
+    responses: {
+      /** @description Run recorded */
+      201: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  'marketplaces.resolveToken': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'application/json': {
+          /** @enum {string} */
+          vendor: 'azure' | 'gcp';
+          token: string;
+        };
+      };
+    };
+    responses: {
+      /** @description Token resolved */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['MarketplaceSubscription'] & {
+            /**
+             * @description Raw data representing the purchase/subscription returned by the marketplace API. As the data are passed directly from the marketplace API, you must expect it to change at any time.
+             *     * for Azure the subscription details are returned:
+             *       https://learn.microsoft.com/en-us/rest/api/resources/subscriptions/get?tabs=HTTP#get-a-single-subscription
+             *     * for GCP the entitlement details are returned:
+             *       https://cloud.google.com/marketplace/docs/partners/commerce-procurement-api/reference/rest/v1/providers.entitlements#Entitlement
+             */
+            vendorData?: Record<string, never>;
+            /**
+             * @deprecated
+             * @description Use `subscription.id` as 1:1 replacement
+             */
+            subscriptionId?: string;
+            /**
+             * @deprecated
+             * @description Use `vendorData` as 1:1 replacement
+             */
+            subscriptionData?: Record<string, never>;
+          };
+        };
+      };
+      /** @description Bad request */
+      400: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  'marketplaces.confirmSubscription': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'application/json': {
+          subscriptionId: string;
+          organizationId: string;
+          projectId: string;
+        };
+      };
+    };
+    responses: {
+      /** @description Confirmation processed */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Bad request */
+      400: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  'marketplaces.azureWebhook': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'application/json': {
+          id: string;
+          subscriptionId: string;
+          /** @enum {string} */
+          action: 'ChangePlan' | 'ChangeQuantity' | 'Suspend' | 'Reinstate' | 'Unsubscribe' | 'Renew';
+        };
+      };
+    };
+    responses: {
+      /** @description Notification accepted */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Authorization header not provided */
+      401: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Invalid, untrusted, or expired JWT */
+      403: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+}
+//#endregion
+//#region src/clients/billing/types.d.ts
+type Credits = OpenapiReturnType<paths['/credits']['get']>;
+//#endregion
+export { Credits };
+//# sourceMappingURL=types.d.cts.map