@widgetic/api-sdk 1.0.29 → 1.0.31

package/dist/esm/apis/CreditsApi.d.ts

@@ -19,10 +19,10 @@ export interface GetAllCreditBalancesRequest {
     limit?: number;
     offset?: number;
 }
-export interface GetUserCreditBalanceRequest {
+export interface GetUserCreditBalance0Request {
     userId: string;
 }
-export interface GetUserCreditTransactionsRequest {
+export interface GetUserCreditTransactions0Request {
     userId: string;
     transactionType?: string;
     limit?: number;
@@ -60,22 +60,22 @@ export declare class CreditsApi extends runtime.BaseAPI {
      * Returns the credits an account holds: the balance, and how much of it is reserved by operations that are still running.  An account reads its own balance; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. An account that has never held credits reads a balance of 0.
      * Get an account\'s credit balance
      */
-    getUserCreditBalanceRaw(requestParameters: GetUserCreditBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountCreditBalance>>;
+    getUserCreditBalanceRaw(requestParameters: GetUserCreditBalance0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountCreditBalance>>;
     /**
      * Returns the credits an account holds: the balance, and how much of it is reserved by operations that are still running.  An account reads its own balance; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. An account that has never held credits reads a balance of 0.
      * Get an account\'s credit balance
      */
-    getUserCreditBalance(requestParameters: GetUserCreditBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountCreditBalance>;
+    getUserCreditBalance(requestParameters: GetUserCreditBalance0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountCreditBalance>;
     /**
      * Lists the entries of an account\'s credit ledger, newest first. This is also how an account\'s usage is read: every operation that spends credits is a `debit` entry, so summing the `debit` entries over a period gives the credits consumed in it, and the other types give what was added.  An account reads its own ledger; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. A partner\'s wallet is a separate ledger, read with `getPartnerCreditTransactions`.  The page is always bounded: `limit` defaults to 100 and is capped at 500, `offset` defaults to 0.
      * List an account\'s credit ledger
      */
-    getUserCreditTransactionsRaw(requestParameters: GetUserCreditTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserCreditTransactions200Response>>;
+    getUserCreditTransactionsRaw(requestParameters: GetUserCreditTransactions0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserCreditTransactions200Response>>;
     /**
      * Lists the entries of an account\'s credit ledger, newest first. This is also how an account\'s usage is read: every operation that spends credits is a `debit` entry, so summing the `debit` entries over a period gives the credits consumed in it, and the other types give what was added.  An account reads its own ledger; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. A partner\'s wallet is a separate ledger, read with `getPartnerCreditTransactions`.  The page is always bounded: `limit` defaults to 100 and is capped at 500, `offset` defaults to 0.
      * List an account\'s credit ledger
      */
-    getUserCreditTransactions(requestParameters: GetUserCreditTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserCreditTransactions200Response>;
+    getUserCreditTransactions(requestParameters: GetUserCreditTransactions0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserCreditTransactions200Response>;
     /**
      * Subtracts credits from a user\'s balance. Admin only. A `referenceId` in the body names the deduction event; when it is omitted the request\'s `Idempotency-Key` header is used instead, and the request is refused with 400 when neither is present, so a retried deduction cannot be applied twice.
      * Subtract credits from user balance

package/dist/esm/apis/EnterpriseCustomizationsApi.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * 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 { EnterpriseCustomization, ListEnterpriseCustomizations200Response, UpdateEnterpriseCustomizationRequest } from '../models/index';
+export interface CreateEnterpriseCustomizationRequest {
+    partnerId: string;
+    updateEnterpriseCustomizationRequest: UpdateEnterpriseCustomizationRequest;
+}
+export interface DeleteEnterpriseCustomizationRequest {
+    partnerId: string;
+}
+export interface GetEnterpriseCustomizationRequest {
+    partnerId: string;
+}
+export interface ListEnterpriseCustomizationsRequest {
+    includeInactive?: boolean;
+    limit?: number;
+    offset?: number;
+}
+export interface UpdateEnterpriseCustomizationOperationRequest {
+    partnerId: string;
+    updateEnterpriseCustomizationRequest: UpdateEnterpriseCustomizationRequest;
+}
+/**
+ *
+ */
+export declare class EnterpriseCustomizationsApi extends runtime.BaseAPI {
+    /**
+     * Creates a new enterprise customization for a partner. Billing admin only.
+     * Create enterprise customization
+     */
+    createEnterpriseCustomizationRaw(requestParameters: CreateEnterpriseCustomizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnterpriseCustomization>>;
+    /**
+     * Creates a new enterprise customization for a partner. Billing admin only.
+     * Create enterprise customization
+     */
+    createEnterpriseCustomization(requestParameters: CreateEnterpriseCustomizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnterpriseCustomization>;
+    /**
+     * Deletes an enterprise customization for a partner. Billing admin only.
+     * Delete enterprise customization
+     */
+    deleteEnterpriseCustomizationRaw(requestParameters: DeleteEnterpriseCustomizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes an enterprise customization for a partner. Billing admin only.
+     * Delete enterprise customization
+     */
+    deleteEnterpriseCustomization(requestParameters: DeleteEnterpriseCustomizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieves enterprise customization for a specific partner. Billing admin or partner admin only.
+     * Get enterprise customization by partner ID
+     */
+    getEnterpriseCustomizationRaw(requestParameters: GetEnterpriseCustomizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnterpriseCustomization>>;
+    /**
+     * Retrieves enterprise customization for a specific partner. Billing admin or partner admin only.
+     * Get enterprise customization by partner ID
+     */
+    getEnterpriseCustomization(requestParameters: GetEnterpriseCustomizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnterpriseCustomization>;
+    /**
+     * Retrieves all enterprise customizations with pagination. Billing admin only.
+     * List all enterprise customizations
+     */
+    listEnterpriseCustomizationsRaw(requestParameters: ListEnterpriseCustomizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEnterpriseCustomizations200Response>>;
+    /**
+     * Retrieves all enterprise customizations with pagination. Billing admin only.
+     * List all enterprise customizations
+     */
+    listEnterpriseCustomizations(requestParameters?: ListEnterpriseCustomizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEnterpriseCustomizations200Response>;
+    /**
+     * Updates an existing enterprise customization for a partner. Billing admin only.
+     * Update enterprise customization
+     */
+    updateEnterpriseCustomizationRaw(requestParameters: UpdateEnterpriseCustomizationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EnterpriseCustomization>>;
+    /**
+     * Updates an existing enterprise customization for a partner. Billing admin only.
+     * Update enterprise customization
+     */
+    updateEnterpriseCustomization(requestParameters: UpdateEnterpriseCustomizationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EnterpriseCustomization>;
+}

package/dist/esm/apis/EnterpriseCustomizationsApi.js

@@ -0,0 +1,229 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime.js';
+import { EnterpriseCustomizationFromJSON, ListEnterpriseCustomizations200ResponseFromJSON, UpdateEnterpriseCustomizationRequestToJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class EnterpriseCustomizationsApi extends runtime.BaseAPI {
+    /**
+     * Creates a new enterprise customization for a partner. Billing admin only.
+     * Create enterprise customization
+     */
+    createEnterpriseCustomizationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['partnerId'] == null) {
+                throw new runtime.RequiredError('partnerId', 'Required parameter "partnerId" was null or undefined when calling createEnterpriseCustomization().');
+            }
+            if (requestParameters['updateEnterpriseCustomizationRequest'] == null) {
+                throw new runtime.RequiredError('updateEnterpriseCustomizationRequest', 'Required parameter "updateEnterpriseCustomizationRequest" was null or undefined when calling createEnterpriseCustomization().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/enterprise-customizations/{partnerId}`.replace(`{${"partnerId"}}`, encodeURIComponent(String(requestParameters['partnerId']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateEnterpriseCustomizationRequestToJSON(requestParameters['updateEnterpriseCustomizationRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => EnterpriseCustomizationFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a new enterprise customization for a partner. Billing admin only.
+     * Create enterprise customization
+     */
+    createEnterpriseCustomization(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createEnterpriseCustomizationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Deletes an enterprise customization for a partner. Billing admin only.
+     * Delete enterprise customization
+     */
+    deleteEnterpriseCustomizationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['partnerId'] == null) {
+                throw new runtime.RequiredError('partnerId', 'Required parameter "partnerId" was null or undefined when calling deleteEnterpriseCustomization().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/enterprise-customizations/{partnerId}`.replace(`{${"partnerId"}}`, encodeURIComponent(String(requestParameters['partnerId']))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes an enterprise customization for a partner. Billing admin only.
+     * Delete enterprise customization
+     */
+    deleteEnterpriseCustomization(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteEnterpriseCustomizationRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Retrieves enterprise customization for a specific partner. Billing admin or partner admin only.
+     * Get enterprise customization by partner ID
+     */
+    getEnterpriseCustomizationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['partnerId'] == null) {
+                throw new runtime.RequiredError('partnerId', 'Required parameter "partnerId" was null or undefined when calling getEnterpriseCustomization().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/enterprise-customizations/{partnerId}`.replace(`{${"partnerId"}}`, encodeURIComponent(String(requestParameters['partnerId']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => EnterpriseCustomizationFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves enterprise customization for a specific partner. Billing admin or partner admin only.
+     * Get enterprise customization by partner ID
+     */
+    getEnterpriseCustomization(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getEnterpriseCustomizationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves all enterprise customizations with pagination. Billing admin only.
+     * List all enterprise customizations
+     */
+    listEnterpriseCustomizationsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['includeInactive'] != null) {
+                queryParameters['include_inactive'] = requestParameters['includeInactive'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/enterprise-customizations`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListEnterpriseCustomizations200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves all enterprise customizations with pagination. Billing admin only.
+     * List all enterprise customizations
+     */
+    listEnterpriseCustomizations() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listEnterpriseCustomizationsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates an existing enterprise customization for a partner. Billing admin only.
+     * Update enterprise customization
+     */
+    updateEnterpriseCustomizationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['partnerId'] == null) {
+                throw new runtime.RequiredError('partnerId', 'Required parameter "partnerId" was null or undefined when calling updateEnterpriseCustomization().');
+            }
+            if (requestParameters['updateEnterpriseCustomizationRequest'] == null) {
+                throw new runtime.RequiredError('updateEnterpriseCustomizationRequest', 'Required parameter "updateEnterpriseCustomizationRequest" was null or undefined when calling updateEnterpriseCustomization().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/enterprise-customizations/{partnerId}`.replace(`{${"partnerId"}}`, encodeURIComponent(String(requestParameters['partnerId']))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateEnterpriseCustomizationRequestToJSON(requestParameters['updateEnterpriseCustomizationRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => EnterpriseCustomizationFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Updates an existing enterprise customization for a partner. Billing admin only.
+     * Update enterprise customization
+     */
+    updateEnterpriseCustomization(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateEnterpriseCustomizationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/InvoicesApi.d.ts

@@ -25,9 +25,9 @@ export interface GetAllInvoicesRequest {
 export interface GetInvoiceByIdRequest {
     id: string;
 }
-export interface GetInvoicesByPartnerIdRequest {
+export interface GetInvoicesByPartnerId0Request {
     partnerId: string;
-    status?: GetInvoicesByPartnerIdStatusEnum;
+    status?: GetInvoicesByPartnerId0StatusEnum;
     limit?: number;
     offset?: number;
 }
@@ -80,12 +80,12 @@ export declare class InvoicesApi extends runtime.BaseAPI {
      * Lists the invoices issued to a partner, newest first. Each carries the price (`subtotal`), the tax on it (`taxAmount`) and what is paid (`total`), its status as the payment provider reports it, why the last payment failed (`failureReason`), and the page where it is paid (`hostedInvoiceUrl`).  A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner\'s and see exactly what the partner sees; the full records, with the internal fields, are `getAllInvoices` filtered by partner.  The page is always bounded: `limit` defaults to 50 and is capped at 100, `offset` defaults to 0.
      * List a partner\'s invoices
      */
-    getInvoicesByPartnerIdRaw(requestParameters: GetInvoicesByPartnerIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetInvoicesByPartnerId200Response>>;
+    getInvoicesByPartnerIdRaw(requestParameters: GetInvoicesByPartnerId0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetInvoicesByPartnerId200Response>>;
     /**
      * Lists the invoices issued to a partner, newest first. Each carries the price (`subtotal`), the tax on it (`taxAmount`) and what is paid (`total`), its status as the payment provider reports it, why the last payment failed (`failureReason`), and the page where it is paid (`hostedInvoiceUrl`).  A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner\'s and see exactly what the partner sees; the full records, with the internal fields, are `getAllInvoices` filtered by partner.  The page is always bounded: `limit` defaults to 50 and is capped at 100, `offset` defaults to 0.
      * List a partner\'s invoices
      */
-    getInvoicesByPartnerId(requestParameters: GetInvoicesByPartnerIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetInvoicesByPartnerId200Response>;
+    getInvoicesByPartnerId(requestParameters: GetInvoicesByPartnerId0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetInvoicesByPartnerId200Response>;
     /**
      * Retrieves the raw invoice records of a specific user, including the internal fields (administrator notes, billing-provider ids). Administrators only. An account reads its own invoice history, with hosted-invoice links, through `GET /billing/users/{userId}/invoices`.
      * Get user invoices
@@ -110,7 +110,7 @@ export declare class InvoicesApi extends runtime.BaseAPI {
 /**
  * @export
  */
-export declare const GetInvoicesByPartnerIdStatusEnum: {
+export declare const GetInvoicesByPartnerId0StatusEnum: {
     readonly Draft: "draft";
     readonly Open: "open";
     readonly Pending: "pending";
@@ -121,4 +121,4 @@ export declare const GetInvoicesByPartnerIdStatusEnum: {
     readonly Refunded: "refunded";
     readonly Canceled: "canceled";
 };
-export type GetInvoicesByPartnerIdStatusEnum = typeof GetInvoicesByPartnerIdStatusEnum[keyof typeof GetInvoicesByPartnerIdStatusEnum];
+export type GetInvoicesByPartnerId0StatusEnum = typeof GetInvoicesByPartnerId0StatusEnum[keyof typeof GetInvoicesByPartnerId0StatusEnum];

package/dist/esm/apis/InvoicesApi.js

@@ -295,7 +295,7 @@ export class InvoicesApi extends runtime.BaseAPI {
 /**
  * @export
  */
-export const GetInvoicesByPartnerIdStatusEnum = {
+export const GetInvoicesByPartnerId0StatusEnum = {
     Draft: 'draft',
     Open: 'open',
     Pending: 'pending',