@widgetic/api-sdk 1.0.24 → 1.0.26

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;

package/dist/esm/models/PartnerPresetCopy.js

@@ -0,0 +1,63 @@
+/* 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 PartnerPresetCopy interface.
+ */
+export function instanceOfPartnerPresetCopy(value) {
+    if (!('presetKey' in value) || value['presetKey'] === undefined)
+        return false;
+    if (!('managedUserId' in value) || value['managedUserId'] === undefined)
+        return false;
+    if (!('canvasId' in value) || value['canvasId'] === undefined)
+        return false;
+    if (!('widgetId' in value) || value['widgetId'] === undefined)
+        return false;
+    if (!('widgetName' in value) || value['widgetName'] === undefined)
+        return false;
+    if (!('warnings' in value) || value['warnings'] === undefined)
+        return false;
+    return true;
+}
+export function PartnerPresetCopyFromJSON(json) {
+    return PartnerPresetCopyFromJSONTyped(json, false);
+}
+export function PartnerPresetCopyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'presetKey': json['presetKey'],
+        'managedUserId': json['managedUserId'],
+        'canvasId': json['canvasId'],
+        'widgetId': json['widgetId'],
+        'widgetName': json['widgetName'],
+        'warnings': json['warnings'],
+    };
+}
+export function PartnerPresetCopyToJSON(json) {
+    return PartnerPresetCopyToJSONTyped(json, false);
+}
+export function PartnerPresetCopyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'presetKey': value['presetKey'],
+        'managedUserId': value['managedUserId'],
+        'canvasId': value['canvasId'],
+        'widgetId': value['widgetId'],
+        'widgetName': value['widgetName'],
+        'warnings': value['warnings'],
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 PartnerPresetRemoval
+ */
+export interface PartnerPresetRemoval {
+    /**
+     * False when there was no preset under that key
+     * @type {boolean}
+     * @memberof PartnerPresetRemoval
+     */
+    removed: boolean;
+}
+/**
+ * Check if a given object implements the PartnerPresetRemoval interface.
+ */
+export declare function instanceOfPartnerPresetRemoval(value: object): value is PartnerPresetRemoval;
+export declare function PartnerPresetRemovalFromJSON(json: any): PartnerPresetRemoval;
+export declare function PartnerPresetRemovalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerPresetRemoval;
+export declare function PartnerPresetRemovalToJSON(json: any): PartnerPresetRemoval;
+export declare function PartnerPresetRemovalToJSONTyped(value?: PartnerPresetRemoval | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PartnerPresetRemoval.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 PartnerPresetRemoval interface.
+ */
+export function instanceOfPartnerPresetRemoval(value) {
+    if (!('removed' in value) || value['removed'] === undefined)
+        return false;
+    return true;
+}
+export function PartnerPresetRemovalFromJSON(json) {
+    return PartnerPresetRemovalFromJSONTyped(json, false);
+}
+export function PartnerPresetRemovalFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'removed': json['removed'],
+    };
+}
+export function PartnerPresetRemovalToJSON(json) {
+    return PartnerPresetRemovalToJSONTyped(json, false);
+}
+export function PartnerPresetRemovalToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'removed': value['removed'],
+    };
+}

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

@@ -0,0 +1,99 @@
+/**
+ * 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.
+ */
+/**
+ * The bucket a partner keeps the files its account uploads in: a bucket on an S3-compatible service that the partner owns. The secret access key is never returned.
+ *
+ * @export
+ * @interface PartnerStorageDestination
+ */
+export interface PartnerStorageDestination {
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerStorageDestination
+     */
+    partnerId: string;
+    /**
+     * The HTTPS address of the S3-compatible service, scheme and host only
+     * @type {string}
+     * @memberof PartnerStorageDestination
+     */
+    endpoint: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerStorageDestination
+     */
+    region: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerStorageDestination
+     */
+    bucket: string;
+    /**
+     * The folder inside the bucket every file is written under. Empty, or folders each followed by a slash.
+     * @type {string}
+     * @memberof PartnerStorageDestination
+     */
+    keyPrefix: string;
+    /**
+     * Where the stored files are served from. A file's url is this address, a slash and the file's key.
+     * @type {string}
+     * @memberof PartnerStorageDestination
+     */
+    publicBaseUrl: string;
+    /**
+     * Whether the bucket name goes in the path of a request (true) or in the host name (false)
+     * @type {boolean}
+     * @memberof PartnerStorageDestination
+     */
+    forcePathStyle: boolean;
+    /**
+     * The last four characters of the access key id, to tell which key is set. Not enough to use it.
+     * @type {string}
+     * @memberof PartnerStorageDestination
+     */
+    accessKeyHint: string;
+    /**
+     * When the destination last passed the check
+     * @type {Date}
+     * @memberof PartnerStorageDestination
+     */
+    verifiedAt: Date;
+    /**
+     * Why the most recent re-check failed. Null while the last check passed.
+     * @type {string}
+     * @memberof PartnerStorageDestination
+     */
+    lastVerificationError?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerStorageDestination
+     */
+    lastVerificationFailedAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof PartnerStorageDestination
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the PartnerStorageDestination interface.
+ */
+export declare function instanceOfPartnerStorageDestination(value: object): value is PartnerStorageDestination;
+export declare function PartnerStorageDestinationFromJSON(json: any): PartnerStorageDestination;
+export declare function PartnerStorageDestinationFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerStorageDestination;
+export declare function PartnerStorageDestinationToJSON(json: any): PartnerStorageDestination;
+export declare function PartnerStorageDestinationToJSONTyped(value?: PartnerStorageDestination | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PartnerStorageDestination.js

@@ -0,0 +1,83 @@
+/* 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 PartnerStorageDestination interface.
+ */
+export function instanceOfPartnerStorageDestination(value) {
+    if (!('partnerId' in value) || value['partnerId'] === undefined)
+        return false;
+    if (!('endpoint' in value) || value['endpoint'] === undefined)
+        return false;
+    if (!('region' in value) || value['region'] === undefined)
+        return false;
+    if (!('bucket' in value) || value['bucket'] === undefined)
+        return false;
+    if (!('keyPrefix' in value) || value['keyPrefix'] === undefined)
+        return false;
+    if (!('publicBaseUrl' in value) || value['publicBaseUrl'] === undefined)
+        return false;
+    if (!('forcePathStyle' in value) || value['forcePathStyle'] === undefined)
+        return false;
+    if (!('accessKeyHint' in value) || value['accessKeyHint'] === undefined)
+        return false;
+    if (!('verifiedAt' in value) || value['verifiedAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function PartnerStorageDestinationFromJSON(json) {
+    return PartnerStorageDestinationFromJSONTyped(json, false);
+}
+export function PartnerStorageDestinationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'partnerId': json['partnerId'],
+        'endpoint': json['endpoint'],
+        'region': json['region'],
+        'bucket': json['bucket'],
+        'keyPrefix': json['keyPrefix'],
+        'publicBaseUrl': json['publicBaseUrl'],
+        'forcePathStyle': json['forcePathStyle'],
+        'accessKeyHint': json['accessKeyHint'],
+        'verifiedAt': (new Date(json['verifiedAt'])),
+        'lastVerificationError': json['lastVerificationError'] == null ? undefined : json['lastVerificationError'],
+        'lastVerificationFailedAt': json['lastVerificationFailedAt'] == null ? undefined : (new Date(json['lastVerificationFailedAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function PartnerStorageDestinationToJSON(json) {
+    return PartnerStorageDestinationToJSONTyped(json, false);
+}
+export function PartnerStorageDestinationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'partnerId': value['partnerId'],
+        'endpoint': value['endpoint'],
+        'region': value['region'],
+        'bucket': value['bucket'],
+        'keyPrefix': value['keyPrefix'],
+        'publicBaseUrl': value['publicBaseUrl'],
+        'forcePathStyle': value['forcePathStyle'],
+        'accessKeyHint': value['accessKeyHint'],
+        'verifiedAt': ((value['verifiedAt']).toISOString()),
+        'lastVerificationError': value['lastVerificationError'],
+        'lastVerificationFailedAt': value['lastVerificationFailedAt'] == null ? undefined : (value['lastVerificationFailedAt'].toISOString()),
+        'updatedAt': ((value['updatedAt']).toISOString()),
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 PartnerStorageRemoval
+ */
+export interface PartnerStorageRemoval {
+    /**
+     * False when the partner had no storage destination to remove
+     * @type {boolean}
+     * @memberof PartnerStorageRemoval
+     */
+    removed: boolean;
+}
+/**
+ * Check if a given object implements the PartnerStorageRemoval interface.
+ */
+export declare function instanceOfPartnerStorageRemoval(value: object): value is PartnerStorageRemoval;
+export declare function PartnerStorageRemovalFromJSON(json: any): PartnerStorageRemoval;
+export declare function PartnerStorageRemovalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartnerStorageRemoval;
+export declare function PartnerStorageRemovalToJSON(json: any): PartnerStorageRemoval;
+export declare function PartnerStorageRemovalToJSONTyped(value?: PartnerStorageRemoval | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PartnerStorageRemoval.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 PartnerStorageRemoval interface.
+ */
+export function instanceOfPartnerStorageRemoval(value) {
+    if (!('removed' in value) || value['removed'] === undefined)
+        return false;
+    return true;
+}
+export function PartnerStorageRemovalFromJSON(json) {
+    return PartnerStorageRemovalFromJSONTyped(json, false);
+}
+export function PartnerStorageRemovalFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'removed': json['removed'],
+    };
+}
+export function PartnerStorageRemovalToJSON(json) {
+    return PartnerStorageRemovalToJSONTyped(json, false);
+}
+export function PartnerStorageRemovalToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'removed': value['removed'],
+    };
+}