@widgetic/api-sdk 1.0.24 → 1.0.25

package/dist/esm/models/PartnerInvoice.js

@@ -0,0 +1,93 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PartnerInvoiceStatusEnum = {
+    Draft: 'draft',
+    Open: 'open',
+    Pending: 'pending',
+    Paid: 'paid',
+    Failed: 'failed',
+    Void: 'void',
+    Uncollectible: 'uncollectible',
+    Refunded: 'refunded',
+    Canceled: 'canceled'
+};
+/**
+ * Check if a given object implements the PartnerInvoice interface.
+ */
+export function instanceOfPartnerInvoice(value) {
+    return true;
+}
+export function PartnerInvoiceFromJSON(json) {
+    return PartnerInvoiceFromJSONTyped(json, false);
+}
+export function PartnerInvoiceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'partnerId': json['partnerId'] == null ? undefined : json['partnerId'],
+        'number': json['number'] == null ? undefined : json['number'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'amount': json['amount'] == null ? undefined : json['amount'],
+        'amountDue': json['amountDue'] == null ? undefined : json['amountDue'],
+        'amountPaid': json['amountPaid'] == null ? undefined : json['amountPaid'],
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        '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'])),
+        'paidDate': json['paidDate'] == null ? undefined : (new Date(json['paidDate'])),
+        'periodStart': json['periodStart'] == null ? undefined : (new Date(json['periodStart'])),
+        'periodEnd': json['periodEnd'] == null ? undefined : (new Date(json['periodEnd'])),
+        'paymentMethod': json['paymentMethod'] == null ? undefined : json['paymentMethod'],
+        'hostedInvoiceUrl': json['hostedInvoiceUrl'] == null ? undefined : json['hostedInvoiceUrl'],
+        'pdfUrl': json['pdfUrl'] == null ? undefined : json['pdfUrl'],
+        'lineItems': json['lineItems'] == null ? undefined : json['lineItems'],
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+    };
+}
+export function PartnerInvoiceToJSON(json) {
+    return PartnerInvoiceToJSONTyped(json, false);
+}
+export function PartnerInvoiceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'partnerId': value['partnerId'],
+        'number': value['number'],
+        'description': value['description'],
+        'amount': value['amount'],
+        'amountDue': value['amountDue'],
+        'amountPaid': value['amountPaid'],
+        'currency': value['currency'],
+        'status': value['status'],
+        'invoiceDate': value['invoiceDate'] == null ? undefined : (value['invoiceDate'].toISOString()),
+        'dueDate': value['dueDate'] == null ? undefined : (value['dueDate'].toISOString()),
+        'paidDate': value['paidDate'] == null ? undefined : (value['paidDate'].toISOString()),
+        'periodStart': value['periodStart'] == null ? undefined : (value['periodStart'].toISOString()),
+        'periodEnd': value['periodEnd'] == null ? undefined : (value['periodEnd'].toISOString()),
+        'paymentMethod': value['paymentMethod'],
+        'hostedInvoiceUrl': value['hostedInvoiceUrl'],
+        'pdfUrl': value['pdfUrl'],
+        'lineItems': value['lineItems'],
+        'createdAt': value['createdAt'] == null ? undefined : (value['createdAt'].toISOString()),
+        'updatedAt': value['updatedAt'] == null ? undefined : (value['updatedAt'].toISOString()),
+    };
+}

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { Partner } from './Partner';
+/**
+ *
+ * @export
+ * @interface PartnerList
+ */
+export interface PartnerList {
+    /**
+     *
+     * @type {Array<Partner>}
+     * @memberof PartnerList
+     */
+    data: Array<Partner>;
+    /**
+     * How many partners match the filters, across all pages
+     * @type {number}
+     * @memberof PartnerList
+     */
+    total: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PartnerList
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PartnerList
+     */
+    size: number;
+}
+/**
+ * Check if a given object implements the PartnerList interface.
+ */
+export declare function instanceOfPartnerList(value: object): value is PartnerList;
+export declare function PartnerListFromJSON(json: any): PartnerList;
+export declare function PartnerListFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerList;
+export declare function PartnerListToJSON(json: any): PartnerList;
+export declare function PartnerListToJSONTyped(value?: PartnerList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PartnerList.js

@@ -0,0 +1,56 @@
+/* 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 { PartnerFromJSON, PartnerToJSON, } from './Partner.js';
+/**
+ * Check if a given object implements the PartnerList interface.
+ */
+export function instanceOfPartnerList(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('size' in value) || value['size'] === undefined)
+        return false;
+    return true;
+}
+export function PartnerListFromJSON(json) {
+    return PartnerListFromJSONTyped(json, false);
+}
+export function PartnerListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(PartnerFromJSON)),
+        'total': json['total'],
+        'page': json['page'],
+        'size': json['size'],
+    };
+}
+export function PartnerListToJSON(json) {
+    return PartnerListToJSONTyped(json, false);
+}
+export function PartnerListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(PartnerToJSON)),
+        'total': value['total'],
+        'page': value['page'],
+        'size': value['size'],
+    };
+}

package/dist/esm/models/PartnerMonthlyStats.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 { PartnerMonthlyStatsPeriod } from './PartnerMonthlyStatsPeriod';
+/**
+ * The partner's wallet activity over the last month, from the ledger
+ * @export
+ * @interface PartnerMonthlyStats
+ */
+export interface PartnerMonthlyStats {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerMonthlyStats
+     */
+    timeframe?: string;
+    /**
+     *
+     * @type {PartnerMonthlyStatsPeriod}
+     * @memberof PartnerMonthlyStats
+     */
+    period?: PartnerMonthlyStatsPeriod;
+    /**
+     *
+     * @type {number}
+     * @memberof PartnerMonthlyStats
+     */
+    creditBalance?: number;
+    /**
+     * Credits consumed in the period
+     * @type {number}
+     * @memberof PartnerMonthlyStats
+     */
+    totalSpent?: number;
+    /**
+     * Credits issued in the period (top-ups, refunds, bonuses)
+     * @type {number}
+     * @memberof PartnerMonthlyStats
+     */
+    totalAdded?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PartnerMonthlyStats
+     */
+    netChange?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PartnerMonthlyStats
+     */
+    transactionCount?: number;
+    /**
+     * How many users belong to the partner; null while that cannot be read
+     * @type {number}
+     * @memberof PartnerMonthlyStats
+     */
+    userCount?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof PartnerMonthlyStats
+     */
+    dailyAverageSpend?: number;
+}
+/**
+ * Check if a given object implements the PartnerMonthlyStats interface.
+ */
+export declare function instanceOfPartnerMonthlyStats(value: object): value is PartnerMonthlyStats;
+export declare function PartnerMonthlyStatsFromJSON(json: any): PartnerMonthlyStats;
+export declare function PartnerMonthlyStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerMonthlyStats;
+export declare function PartnerMonthlyStatsToJSON(json: any): PartnerMonthlyStats;
+export declare function PartnerMonthlyStatsToJSONTyped(value?: PartnerMonthlyStats | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PartnerMonthlyStats.js

@@ -0,0 +1,58 @@
+/* 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 { PartnerMonthlyStatsPeriodFromJSON, PartnerMonthlyStatsPeriodToJSON, } from './PartnerMonthlyStatsPeriod.js';
+/**
+ * Check if a given object implements the PartnerMonthlyStats interface.
+ */
+export function instanceOfPartnerMonthlyStats(value) {
+    return true;
+}
+export function PartnerMonthlyStatsFromJSON(json) {
+    return PartnerMonthlyStatsFromJSONTyped(json, false);
+}
+export function PartnerMonthlyStatsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'timeframe': json['timeframe'] == null ? undefined : json['timeframe'],
+        'period': json['period'] == null ? undefined : PartnerMonthlyStatsPeriodFromJSON(json['period']),
+        'creditBalance': json['creditBalance'] == null ? undefined : json['creditBalance'],
+        'totalSpent': json['totalSpent'] == null ? undefined : json['totalSpent'],
+        'totalAdded': json['totalAdded'] == null ? undefined : json['totalAdded'],
+        'netChange': json['netChange'] == null ? undefined : json['netChange'],
+        'transactionCount': json['transactionCount'] == null ? undefined : json['transactionCount'],
+        'userCount': json['userCount'] == null ? undefined : json['userCount'],
+        'dailyAverageSpend': json['dailyAverageSpend'] == null ? undefined : json['dailyAverageSpend'],
+    };
+}
+export function PartnerMonthlyStatsToJSON(json) {
+    return PartnerMonthlyStatsToJSONTyped(json, false);
+}
+export function PartnerMonthlyStatsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'timeframe': value['timeframe'],
+        'period': PartnerMonthlyStatsPeriodToJSON(value['period']),
+        'creditBalance': value['creditBalance'],
+        'totalSpent': value['totalSpent'],
+        'totalAdded': value['totalAdded'],
+        'netChange': value['netChange'],
+        'transactionCount': value['transactionCount'],
+        'userCount': value['userCount'],
+        'dailyAverageSpend': value['dailyAverageSpend'],
+    };
+}

package/dist/esm/models/PartnerMonthlyStatsPeriod.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.
+ */
+/**
+ *
+ * @export
+ * @interface PartnerMonthlyStatsPeriod
+ */
+export interface PartnerMonthlyStatsPeriod {
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerMonthlyStatsPeriod
+     */
+    start?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerMonthlyStatsPeriod
+     */
+    end?: Date;
+}
+/**
+ * Check if a given object implements the PartnerMonthlyStatsPeriod interface.
+ */
+export declare function instanceOfPartnerMonthlyStatsPeriod(value: object): value is PartnerMonthlyStatsPeriod;
+export declare function PartnerMonthlyStatsPeriodFromJSON(json: any): PartnerMonthlyStatsPeriod;
+export declare function PartnerMonthlyStatsPeriodFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerMonthlyStatsPeriod;
+export declare function PartnerMonthlyStatsPeriodToJSON(json: any): PartnerMonthlyStatsPeriod;
+export declare function PartnerMonthlyStatsPeriodToJSONTyped(value?: PartnerMonthlyStatsPeriod | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PartnerMonthlyStatsPeriod.js

@@ -0,0 +1,43 @@
+/* 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 PartnerMonthlyStatsPeriod interface.
+ */
+export function instanceOfPartnerMonthlyStatsPeriod(value) {
+    return true;
+}
+export function PartnerMonthlyStatsPeriodFromJSON(json) {
+    return PartnerMonthlyStatsPeriodFromJSONTyped(json, false);
+}
+export function PartnerMonthlyStatsPeriodFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'start': json['start'] == null ? undefined : (new Date(json['start'])),
+        'end': json['end'] == null ? undefined : (new Date(json['end'])),
+    };
+}
+export function PartnerMonthlyStatsPeriodToJSON(json) {
+    return PartnerMonthlyStatsPeriodToJSONTyped(json, false);
+}
+export function PartnerMonthlyStatsPeriodToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'start': value['start'] == null ? undefined : ((value['start']).toISOString()),
+        'end': value['end'] == null ? undefined : ((value['end']).toISOString()),
+    };
+}

package/dist/esm/models/PartnerPreset.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.
+ */
+/**
+ * A widget the partner offers its managed users as a starting point, under a key the partner's code names. It belongs to the partner's account, so every managed user of the partner sees the same list.
+ *
+ * @export
+ * @interface PartnerPreset
+ */
+export interface PartnerPreset {
+    /**
+     * The name the partner's code uses for the preset
+     * @type {string}
+     * @memberof PartnerPreset
+     */
+    key: string;
+    /**
+     * The partner's widget. Use it to make a composition (`createComposition` with this `widgetId`).
+     * @type {string}
+     * @memberof PartnerPreset
+     */
+    widgetId: string;
+    /**
+     * What the partner's picker shows. Null means show `widgetName`.
+     * @type {string}
+     * @memberof PartnerPreset
+     */
+    title: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerPreset
+     */
+    description: string | null;
+    /**
+     * The list is ordered by this, smallest first, then by key
+     * @type {number}
+     * @memberof PartnerPreset
+     */
+    position: number;
+    /**
+     * The widget's own name
+     * @type {string}
+     * @memberof PartnerPreset
+     */
+    widgetName: string;
+    /**
+     * The widget's thumbnail, when it has one
+     * @type {string}
+     * @memberof PartnerPreset
+     */
+    thumbnailUrl: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerPreset
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerPreset
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the PartnerPreset interface.
+ */
+export declare function instanceOfPartnerPreset(value: object): value is PartnerPreset;
+export declare function PartnerPresetFromJSON(json: any): PartnerPreset;
+export declare function PartnerPresetFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerPreset;
+export declare function PartnerPresetToJSON(json: any): PartnerPreset;
+export declare function PartnerPresetToJSONTyped(value?: PartnerPreset | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PartnerPreset.js

@@ -0,0 +1,75 @@
+/* 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 PartnerPreset interface.
+ */
+export function instanceOfPartnerPreset(value) {
+    if (!('key' in value) || value['key'] === undefined)
+        return false;
+    if (!('widgetId' in value) || value['widgetId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('position' in value) || value['position'] === undefined)
+        return false;
+    if (!('widgetName' in value) || value['widgetName'] === undefined)
+        return false;
+    if (!('thumbnailUrl' in value) || value['thumbnailUrl'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function PartnerPresetFromJSON(json) {
+    return PartnerPresetFromJSONTyped(json, false);
+}
+export function PartnerPresetFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'key': json['key'],
+        'widgetId': json['widgetId'],
+        'title': json['title'],
+        'description': json['description'],
+        'position': json['position'],
+        'widgetName': json['widgetName'],
+        'thumbnailUrl': json['thumbnailUrl'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function PartnerPresetToJSON(json) {
+    return PartnerPresetToJSONTyped(json, false);
+}
+export function PartnerPresetToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'key': value['key'],
+        'widgetId': value['widgetId'],
+        'title': value['title'],
+        'description': value['description'],
+        'position': value['position'],
+        'widgetName': value['widgetName'],
+        'thumbnailUrl': value['thumbnailUrl'],
+        'createdAt': ((value['createdAt']).toISOString()),
+        'updatedAt': ((value['updatedAt']).toISOString()),
+    };
+}

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

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+/**
+ * Where the copy of a preset is. Open the widget creator on `canvasId` and `widgetId`.
+ * @export
+ * @interface PartnerPresetCopy
+ */
+export interface PartnerPresetCopy {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerPresetCopy
+     */
+    presetKey: string;
+    /**
+     * The managed user the copy was made for
+     * @type {string}
+     * @memberof PartnerPresetCopy
+     */
+    managedUserId: string;
+    /**
+     * The new canvas the copy is on
+     * @type {string}
+     * @memberof PartnerPresetCopy
+     */
+    canvasId: string;
+    /**
+     * The new widget, which is not a preset and which only this managed user's editor reaches
+     * @type {string}
+     * @memberof PartnerPresetCopy
+     */
+    widgetId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerPresetCopy
+     */
+    widgetName: string;
+    /**
+     * Things that did not go as planned but did not stop the copy. Empty when everything did.
+     * @type {Array<string>}
+     * @memberof PartnerPresetCopy
+     */
+    warnings: Array<string>;
+}
+/**
+ * Check if a given object implements the PartnerPresetCopy interface.
+ */
+export declare function instanceOfPartnerPresetCopy(value: object): value is PartnerPresetCopy;
+export declare function PartnerPresetCopyFromJSON(json: any): PartnerPresetCopy;
+export declare function PartnerPresetCopyFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerPresetCopy;
+export declare function PartnerPresetCopyToJSON(json: any): PartnerPresetCopy;
+export declare function PartnerPresetCopyToJSONTyped(value?: PartnerPresetCopy | null, ignoreDiscriminator?: boolean): any;