@widgetic/api-sdk 1.0.27 → 1.0.29

package/dist/esm/models/PartnerEditorSessionSettingsEffective.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PartnerEditorSessionSettingsEffective interface.
+ */
+export function instanceOfPartnerEditorSessionSettingsEffective(value) {
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    if (!('costMultiplier' in value) || value['costMultiplier'] === undefined)
+        return false;
+    if (!('defaultMaxCredits' in value) || value['defaultMaxCredits'] === undefined)
+        return false;
+    return true;
+}
+export function PartnerEditorSessionSettingsEffectiveFromJSON(json) {
+    return PartnerEditorSessionSettingsEffectiveFromJSONTyped(json, false);
+}
+export function PartnerEditorSessionSettingsEffectiveFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enabled': json['enabled'],
+        'costMultiplier': json['costMultiplier'],
+        'defaultMaxCredits': json['defaultMaxCredits'],
+    };
+}
+export function PartnerEditorSessionSettingsEffectiveToJSON(json) {
+    return PartnerEditorSessionSettingsEffectiveToJSONTyped(json, false);
+}
+export function PartnerEditorSessionSettingsEffectiveToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'enabled': value['enabled'],
+        'costMultiplier': value['costMultiplier'],
+        'defaultMaxCredits': value['defaultMaxCredits'],
+    };
+}

package/dist/esm/models/PartnerEditorSessionSettingsSettings.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * What is set for this partner (null for a setting that is not set)
+ * @export
+ * @interface PartnerEditorSessionSettingsSettings
+ */
+export interface PartnerEditorSessionSettingsSettings {
+    /**
+     * false switches editor sessions off for this partner; null (or true) leaves it to the global switch
+     * @type {boolean}
+     * @memberof PartnerEditorSessionSettingsSettings
+     */
+    enabled: boolean | null;
+    /**
+     * What an operation of the partner's customers costs their usage budget, as a multiple of its base cost (above 0, at most 10; smaller is a larger allowance)
+     * @type {number}
+     * @memberof PartnerEditorSessionSettingsSettings
+     */
+    costMultiplier: number | null;
+    /**
+     * The credit limit a new editor session gets when the request for it names none
+     * @type {number}
+     * @memberof PartnerEditorSessionSettingsSettings
+     */
+    defaultMaxCredits: number | null;
+}
+/**
+ * Check if a given object implements the PartnerEditorSessionSettingsSettings interface.
+ */
+export declare function instanceOfPartnerEditorSessionSettingsSettings(value: object): value is PartnerEditorSessionSettingsSettings;
+export declare function PartnerEditorSessionSettingsSettingsFromJSON(json: any): PartnerEditorSessionSettingsSettings;
+export declare function PartnerEditorSessionSettingsSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerEditorSessionSettingsSettings;
+export declare function PartnerEditorSessionSettingsSettingsToJSON(json: any): PartnerEditorSessionSettingsSettings;
+export declare function PartnerEditorSessionSettingsSettingsToJSONTyped(value?: PartnerEditorSessionSettingsSettings | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PartnerEditorSessionSettingsSettings.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PartnerEditorSessionSettingsSettings interface.
+ */
+export function instanceOfPartnerEditorSessionSettingsSettings(value) {
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    if (!('costMultiplier' in value) || value['costMultiplier'] === undefined)
+        return false;
+    if (!('defaultMaxCredits' in value) || value['defaultMaxCredits'] === undefined)
+        return false;
+    return true;
+}
+export function PartnerEditorSessionSettingsSettingsFromJSON(json) {
+    return PartnerEditorSessionSettingsSettingsFromJSONTyped(json, false);
+}
+export function PartnerEditorSessionSettingsSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enabled': json['enabled'],
+        'costMultiplier': json['costMultiplier'],
+        'defaultMaxCredits': json['defaultMaxCredits'],
+    };
+}
+export function PartnerEditorSessionSettingsSettingsToJSON(json) {
+    return PartnerEditorSessionSettingsSettingsToJSONTyped(json, false);
+}
+export function PartnerEditorSessionSettingsSettingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'enabled': value['enabled'],
+        'costMultiplier': value['costMultiplier'],
+        'defaultMaxCredits': value['defaultMaxCredits'],
+    };
+}

package/dist/esm/models/PartnerInvoice.d.ts

@@ -41,11 +41,29 @@ export interface PartnerInvoice {
      */
     description?: string | null;
     /**
-     * Total, in dollars
+     * Total, in dollars. The price plus the tax (the same number as `total`)
      * @type {number}
      * @memberof PartnerInvoice
      */
     amount?: number;
+    /**
+     * The price, before tax, in dollars
+     * @type {number}
+     * @memberof PartnerInvoice
+     */
+    subtotal?: number;
+    /**
+     * The tax on the price, in dollars. 0 when there is none, for example under the EU reverse charge
+     * @type {number}
+     * @memberof PartnerInvoice
+     */
+    taxAmount?: number;
+    /**
+     * What the partner pays, in dollars. The price plus the tax
+     * @type {number}
+     * @memberof PartnerInvoice
+     */
+    total?: number;
     /**
      * What is still owed, in dollars
      * @type {number}
@@ -65,6 +83,13 @@ export interface PartnerInvoice {
      */
     currency?: string | null;
     /**
+     * Why the last attempt to pay failed, in the payment provider's words for the card holder. Null unless the status is `failed`; the invoice stays payable from `hostedInvoiceUrl`
+     * @type {string}
+     * @memberof PartnerInvoice
+     */
+    failureReason?: string | null;
+    /**
+     * `open` waits for payment, `failed` waits for payment after an attempt was refused, `paid` is settled (a payment received outside the payment provider counts), `void` was cancelled and owes nothing, and `uncollectible` was written off
      *
      * @type {string}
      * @memberof PartnerInvoice

package/dist/esm/models/PartnerInvoice.js

@@ -44,9 +44,13 @@ export function PartnerInvoiceFromJSONTyped(json, ignoreDiscriminator) {
         'number': json['number'] == null ? undefined : json['number'],
         'description': json['description'] == null ? undefined : json['description'],
         'amount': json['amount'] == null ? undefined : json['amount'],
+        'subtotal': json['subtotal'] == null ? undefined : json['subtotal'],
+        'taxAmount': json['taxAmount'] == null ? undefined : json['taxAmount'],
+        'total': json['total'] == null ? undefined : json['total'],
         'amountDue': json['amountDue'] == null ? undefined : json['amountDue'],
         'amountPaid': json['amountPaid'] == null ? undefined : json['amountPaid'],
         'currency': json['currency'] == null ? undefined : json['currency'],
+        'failureReason': json['failureReason'] == null ? undefined : json['failureReason'],
         'status': json['status'] == null ? undefined : json['status'],
         'invoiceDate': json['invoiceDate'] == null ? undefined : (new Date(json['invoiceDate'])),
         'dueDate': json['dueDate'] == null ? undefined : (new Date(json['dueDate'])),
@@ -74,9 +78,13 @@ export function PartnerInvoiceToJSONTyped(value, ignoreDiscriminator = false) {
         'number': value['number'],
         'description': value['description'],
         'amount': value['amount'],
+        'subtotal': value['subtotal'],
+        'taxAmount': value['taxAmount'],
+        'total': value['total'],
         'amountDue': value['amountDue'],
         'amountPaid': value['amountPaid'],
         'currency': value['currency'],
+        'failureReason': value['failureReason'],
         'status': value['status'],
         'invoiceDate': value['invoiceDate'] == null ? undefined : (value['invoiceDate'].toISOString()),
         'dueDate': value['dueDate'] == null ? undefined : (value['dueDate'].toISOString()),

package/dist/esm/models/PartnerNotification.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 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 type { PartnerNotificationEventType } from './PartnerNotificationEventType';
+/**
+ * One thing that happened to your partner account. The same object is what your webhook receives as `data` of a call (beside `id`, `type`, `createdAt` and `partnerId`), and what the list in your dashboard shows.
+ * @export
+ * @interface PartnerNotification
+ */
+export interface PartnerNotification {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerNotification
+     */
+    id: string;
+    /**
+     *
+     * @type {PartnerNotificationEventType}
+     * @memberof PartnerNotification
+     */
+    type: PartnerNotificationEventType;
+    /**
+     * One line that says what happened
+     * @type {string}
+     * @memberof PartnerNotification
+     */
+    title: string;
+    /**
+     * A few sentences that say what happened and what to do about it
+     * @type {string}
+     * @memberof PartnerNotification
+     */
+    body: string;
+    /**
+     * How serious it is
+     * @type {string}
+     * @memberof PartnerNotification
+     */
+    tone: PartnerNotificationToneEnum;
+    /**
+     * The facts of the event, named in camelCase. An invoice event carries `invoiceNumber`, `subtotal`, `taxAmount`, `total`, `currency`, `dueDate` and `hostedInvoiceUrl` (the page where it is paid); a payment adds `paidAt`, a failed payment `reason`, a reminder `daysUntilDue` or `daysOverdue`. A credits event carries `band` (`low` or `empty`), `balance` and `threshold`. A standing event carries `status`, `previousStatus` and `reason`. A storage event carries `reason` and `checkedAt`.
+     * @type {{ [key: string]: any; }}
+     * @memberof PartnerNotification
+     */
+    data: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerNotification
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const PartnerNotificationToneEnum: {
+    readonly Info: "info";
+    readonly Success: "success";
+    readonly Warning: "warning";
+    readonly Error: "error";
+};
+export type PartnerNotificationToneEnum = typeof PartnerNotificationToneEnum[keyof typeof PartnerNotificationToneEnum];
+/**
+ * Check if a given object implements the PartnerNotification interface.
+ */
+export declare function instanceOfPartnerNotification(value: object): value is PartnerNotification;
+export declare function PartnerNotificationFromJSON(json: any): PartnerNotification;
+export declare function PartnerNotificationFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerNotification;
+export declare function PartnerNotificationToJSON(json: any): PartnerNotification;
+export declare function PartnerNotificationToJSONTyped(value?: PartnerNotification | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PartnerNotification.js

@@ -0,0 +1,77 @@
+/* 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.
+ */
+import { PartnerNotificationEventTypeFromJSON, PartnerNotificationEventTypeToJSON, } from './PartnerNotificationEventType.js';
+/**
+ * @export
+ */
+export const PartnerNotificationToneEnum = {
+    Info: 'info',
+    Success: 'success',
+    Warning: 'warning',
+    Error: 'error'
+};
+/**
+ * Check if a given object implements the PartnerNotification interface.
+ */
+export function instanceOfPartnerNotification(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('body' in value) || value['body'] === undefined)
+        return false;
+    if (!('tone' in value) || value['tone'] === undefined)
+        return false;
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function PartnerNotificationFromJSON(json) {
+    return PartnerNotificationFromJSONTyped(json, false);
+}
+export function PartnerNotificationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'type': PartnerNotificationEventTypeFromJSON(json['type']),
+        'title': json['title'],
+        'body': json['body'],
+        'tone': json['tone'],
+        'data': json['data'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function PartnerNotificationToJSON(json) {
+    return PartnerNotificationToJSONTyped(json, false);
+}
+export function PartnerNotificationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'type': PartnerNotificationEventTypeToJSON(value['type']),
+        'title': value['title'],
+        'body': value['body'],
+        'tone': value['tone'],
+        'data': value['data'],
+        'createdAt': ((value['createdAt']).toISOString()),
+    };
+}

package/dist/esm/models/PartnerNotificationDefaultRecipients.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+/**
+ * Who gets the emails while you have given no addresses of your own.
+ * @export
+ * @interface PartnerNotificationDefaultRecipients
+ */
+export interface PartnerNotificationDefaultRecipients {
+    /**
+     * For the invoice events, the billing emails of your billing profile, or your contact email when there are none
+     * @type {Array<string>}
+     * @memberof PartnerNotificationDefaultRecipients
+     */
+    payments: Array<string>;
+    /**
+     * For every other event, your contact email
+     * @type {Array<string>}
+     * @memberof PartnerNotificationDefaultRecipients
+     */
+    other: Array<string>;
+}
+/**
+ * Check if a given object implements the PartnerNotificationDefaultRecipients interface.
+ */
+export declare function instanceOfPartnerNotificationDefaultRecipients(value: object): value is PartnerNotificationDefaultRecipients;
+export declare function PartnerNotificationDefaultRecipientsFromJSON(json: any): PartnerNotificationDefaultRecipients;
+export declare function PartnerNotificationDefaultRecipientsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerNotificationDefaultRecipients;
+export declare function PartnerNotificationDefaultRecipientsToJSON(json: any): PartnerNotificationDefaultRecipients;
+export declare function PartnerNotificationDefaultRecipientsToJSONTyped(value?: PartnerNotificationDefaultRecipients | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PartnerNotificationDefaultRecipients.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PartnerNotificationDefaultRecipients interface.
+ */
+export function instanceOfPartnerNotificationDefaultRecipients(value) {
+    if (!('payments' in value) || value['payments'] === undefined)
+        return false;
+    if (!('other' in value) || value['other'] === undefined)
+        return false;
+    return true;
+}
+export function PartnerNotificationDefaultRecipientsFromJSON(json) {
+    return PartnerNotificationDefaultRecipientsFromJSONTyped(json, false);
+}
+export function PartnerNotificationDefaultRecipientsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'payments': json['payments'],
+        'other': json['other'],
+    };
+}
+export function PartnerNotificationDefaultRecipientsToJSON(json) {
+    return PartnerNotificationDefaultRecipientsToJSONTyped(json, false);
+}
+export function PartnerNotificationDefaultRecipientsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'payments': value['payments'],
+        'other': value['other'],
+    };
+}

package/dist/esm/models/PartnerNotificationDelivery.d.ts

@@ -0,0 +1,128 @@
+/**
+ * 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.
+ */
+/**
+ * One send of one notification, to one email address or to your webhook. It stays `pending` while it is being tried again, and ends `delivered`, `failed` (given up on) or `cancelled` (nobody wanted it any more, for example because the webhook was switched off).
+ * @export
+ * @interface PartnerNotificationDelivery
+ */
+export interface PartnerNotificationDelivery {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerNotificationDelivery
+     */
+    deliveryId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerNotificationDelivery
+     */
+    notificationId: string;
+    /**
+     * What the notification was about. Null when the notification has been removed.
+     * @type {string}
+     * @memberof PartnerNotificationDelivery
+     */
+    eventType: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerNotificationDelivery
+     */
+    title: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerNotificationDelivery
+     */
+    channel: PartnerNotificationDeliveryChannelEnum;
+    /**
+     * The email address, or the host of your webhook (never the whole address, which may hold a token)
+     * @type {string}
+     * @memberof PartnerNotificationDelivery
+     */
+    target: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerNotificationDelivery
+     */
+    status: PartnerNotificationDeliveryStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof PartnerNotificationDelivery
+     */
+    attemptCount: number;
+    /**
+     * When the next attempt is made. Null once the delivery has ended.
+     * @type {Date}
+     * @memberof PartnerNotificationDelivery
+     */
+    nextAttemptAt: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerNotificationDelivery
+     */
+    lastAttemptAt: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerNotificationDelivery
+     */
+    deliveredAt: Date | null;
+    /**
+     * The HTTP status your webhook answered with at the last attempt, when it answered
+     * @type {number}
+     * @memberof PartnerNotificationDelivery
+     */
+    lastStatusCode: number | null;
+    /**
+     * Why the last attempt failed, in a few words. Never what your endpoint replied.
+     * @type {string}
+     * @memberof PartnerNotificationDelivery
+     */
+    lastError: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerNotificationDelivery
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const PartnerNotificationDeliveryChannelEnum: {
+    readonly Email: "email";
+    readonly Webhook: "webhook";
+};
+export type PartnerNotificationDeliveryChannelEnum = typeof PartnerNotificationDeliveryChannelEnum[keyof typeof PartnerNotificationDeliveryChannelEnum];
+/**
+ * @export
+ */
+export declare const PartnerNotificationDeliveryStatusEnum: {
+    readonly Pending: "pending";
+    readonly Delivered: "delivered";
+    readonly Failed: "failed";
+    readonly Cancelled: "cancelled";
+};
+export type PartnerNotificationDeliveryStatusEnum = typeof PartnerNotificationDeliveryStatusEnum[keyof typeof PartnerNotificationDeliveryStatusEnum];
+/**
+ * Check if a given object implements the PartnerNotificationDelivery interface.
+ */
+export declare function instanceOfPartnerNotificationDelivery(value: object): value is PartnerNotificationDelivery;
+export declare function PartnerNotificationDeliveryFromJSON(json: any): PartnerNotificationDelivery;
+export declare function PartnerNotificationDeliveryFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerNotificationDelivery;
+export declare function PartnerNotificationDeliveryToJSON(json: any): PartnerNotificationDelivery;
+export declare function PartnerNotificationDeliveryToJSONTyped(value?: PartnerNotificationDelivery | null, ignoreDiscriminator?: boolean): any;