@cloudinary/apps-api 2.2605.87 → 2.2605.92

package/src/models/TemplateWriteAsset.ts

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cloudinary API Proxy
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2605.92
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface TemplateWriteAsset
+ */
+export interface TemplateWriteAsset {
+    /**
+     * The asset's opaque id
+     * @type {string}
+     * @memberof TemplateWriteAsset
+     */
+    externalId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateWriteAsset
+     */
+    publicId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateWriteAsset
+     */
+    secureUrl?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateWriteAsset
+     */
+    format?: string;
+}
+
+/**
+ * Check if a given object implements the TemplateWriteAsset interface.
+ */
+export function instanceOfTemplateWriteAsset(value: object): value is TemplateWriteAsset {
+    if (!('externalId' in value) || value['externalId'] === undefined) return false;
+    if (!('publicId' in value) || value['publicId'] === undefined) return false;
+    return true;
+}
+
+export function TemplateWriteAssetFromJSON(json: any): TemplateWriteAsset {
+    return TemplateWriteAssetFromJSONTyped(json, false);
+}
+
+export function TemplateWriteAssetFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplateWriteAsset {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'externalId': json['externalId'],
+        'publicId': json['publicId'],
+        'secureUrl': json['secureUrl'] == null ? undefined : json['secureUrl'],
+        'format': json['format'] == null ? undefined : json['format'],
+    };
+}
+
+export function TemplateWriteAssetToJSON(json: any): TemplateWriteAsset {
+    return TemplateWriteAssetToJSONTyped(json, false);
+}
+
+export function TemplateWriteAssetToJSONTyped(value?: TemplateWriteAsset | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'externalId': value['externalId'],
+        'publicId': value['publicId'],
+        'secureUrl': value['secureUrl'],
+        'format': value['format'],
+    };
+}
+

package/src/models/TemplateWriteFailureResponse.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cloudinary API Proxy
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2605.92
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { TemplateChanges } from './TemplateChanges';
+import {
+    TemplateChangesFromJSON,
+    TemplateChangesFromJSONTyped,
+    TemplateChangesToJSON,
+    TemplateChangesToJSONTyped,
+} from './TemplateChanges';
+import type { TemplateWriteFailureResponsePrevious } from './TemplateWriteFailureResponsePrevious';
+import {
+    TemplateWriteFailureResponsePreviousFromJSON,
+    TemplateWriteFailureResponsePreviousFromJSONTyped,
+    TemplateWriteFailureResponsePreviousToJSON,
+    TemplateWriteFailureResponsePreviousToJSONTyped,
+} from './TemplateWriteFailureResponsePrevious';
+
+/**
+ * 
+ * @export
+ * @interface TemplateWriteFailureResponse
+ */
+export interface TemplateWriteFailureResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateWriteFailureResponse
+     */
+    error: string;
+    /**
+     * The status this response carries: the upstream's own when it rejected the request, 502 otherwise
+     * @type {number}
+     * @memberof TemplateWriteFailureResponse
+     */
+    upstream_status: number;
+    /**
+     * 
+     * @type {TemplateChanges}
+     * @memberof TemplateWriteFailureResponse
+     */
+    changes: TemplateChanges;
+    /**
+     * 
+     * @type {TemplateWriteFailureResponsePrevious}
+     * @memberof TemplateWriteFailureResponse
+     */
+    previous?: TemplateWriteFailureResponsePrevious;
+}
+
+/**
+ * Check if a given object implements the TemplateWriteFailureResponse interface.
+ */
+export function instanceOfTemplateWriteFailureResponse(value: object): value is TemplateWriteFailureResponse {
+    if (!('error' in value) || value['error'] === undefined) return false;
+    if (!('upstream_status' in value) || value['upstream_status'] === undefined) return false;
+    if (!('changes' in value) || value['changes'] === undefined) return false;
+    return true;
+}
+
+export function TemplateWriteFailureResponseFromJSON(json: any): TemplateWriteFailureResponse {
+    return TemplateWriteFailureResponseFromJSONTyped(json, false);
+}
+
+export function TemplateWriteFailureResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplateWriteFailureResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'error': json['error'],
+        'upstream_status': json['upstream_status'],
+        'changes': TemplateChangesFromJSON(json['changes']),
+        'previous': json['previous'] == null ? undefined : TemplateWriteFailureResponsePreviousFromJSON(json['previous']),
+    };
+}
+
+export function TemplateWriteFailureResponseToJSON(json: any): TemplateWriteFailureResponse {
+    return TemplateWriteFailureResponseToJSONTyped(json, false);
+}
+
+export function TemplateWriteFailureResponseToJSONTyped(value?: TemplateWriteFailureResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error': value['error'],
+        'upstream_status': value['upstream_status'],
+        'changes': TemplateChangesToJSON(value['changes']),
+        'previous': TemplateWriteFailureResponsePreviousToJSON(value['previous']),
+    };
+}
+

package/src/models/TemplateWriteFailureResponsePrevious.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cloudinary API Proxy
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2605.92
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface TemplateWriteFailureResponsePrevious
+ */
+export interface TemplateWriteFailureResponsePrevious {
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateWriteFailureResponsePrevious
+     */
+    transformation_string?: string;
+}
+
+/**
+ * Check if a given object implements the TemplateWriteFailureResponsePrevious interface.
+ */
+export function instanceOfTemplateWriteFailureResponsePrevious(value: object): value is TemplateWriteFailureResponsePrevious {
+    return true;
+}
+
+export function TemplateWriteFailureResponsePreviousFromJSON(json: any): TemplateWriteFailureResponsePrevious {
+    return TemplateWriteFailureResponsePreviousFromJSONTyped(json, false);
+}
+
+export function TemplateWriteFailureResponsePreviousFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplateWriteFailureResponsePrevious {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'transformation_string': json['transformation_string'] == null ? undefined : json['transformation_string'],
+    };
+}
+
+export function TemplateWriteFailureResponsePreviousToJSON(json: any): TemplateWriteFailureResponsePrevious {
+    return TemplateWriteFailureResponsePreviousToJSONTyped(json, false);
+}
+
+export function TemplateWriteFailureResponsePreviousToJSONTyped(value?: TemplateWriteFailureResponsePrevious | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'transformation_string': value['transformation_string'],
+    };
+}
+

package/src/models/TemplateWriteRequest.ts

@@ -0,0 +1,163 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cloudinary API Proxy
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2605.92
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { TemplateWriteRequestProvenance } from './TemplateWriteRequestProvenance';
+import {
+    TemplateWriteRequestProvenanceFromJSON,
+    TemplateWriteRequestProvenanceFromJSONTyped,
+    TemplateWriteRequestProvenanceToJSON,
+    TemplateWriteRequestProvenanceToJSONTyped,
+} from './TemplateWriteRequestProvenance';
+import type { TemplateWriteRequestCanvas } from './TemplateWriteRequestCanvas';
+import {
+    TemplateWriteRequestCanvasFromJSON,
+    TemplateWriteRequestCanvasFromJSONTyped,
+    TemplateWriteRequestCanvasToJSON,
+    TemplateWriteRequestCanvasToJSONTyped,
+} from './TemplateWriteRequestCanvas';
+import type { CldtTemplateVariable } from './CldtTemplateVariable';
+import {
+    CldtTemplateVariableFromJSON,
+    CldtTemplateVariableFromJSONTyped,
+    CldtTemplateVariableToJSON,
+    CldtTemplateVariableToJSONTyped,
+} from './CldtTemplateVariable';
+
+/**
+ * 
+ * @export
+ * @interface TemplateWriteRequest
+ */
+export interface TemplateWriteRequest {
+    /**
+     * Template name; PUT takes it from the path
+     * @type {string}
+     * @memberof TemplateWriteRequest
+     */
+    name?: string;
+    /**
+     * Public id of the already-uploaded preview asset; must not contain a quote or a backslash
+     * @type {string}
+     * @memberof TemplateWriteRequest
+     */
+    publicId?: string;
+    /**
+     * Opaque id of the already-uploaded preview asset, as an upload returns it
+     * @type {string}
+     * @memberof TemplateWriteRequest
+     */
+    externalId?: string;
+    /**
+     * Transformation body — no delivery params
+     * @type {string}
+     * @memberof TemplateWriteRequest
+     */
+    transformation: string;
+    /**
+     * 
+     * @type {TemplateWriteRequestCanvas}
+     * @memberof TemplateWriteRequest
+     */
+    canvas: TemplateWriteRequestCanvas;
+    /**
+     * Template variables; only the caller can derive these from its layers
+     * @type {Array<CldtTemplateVariable>}
+     * @memberof TemplateWriteRequest
+     */
+    variables: Array<CldtTemplateVariable>;
+    /**
+     * 
+     * @type {TemplateWriteRequestProvenance}
+     * @memberof TemplateWriteRequest
+     */
+    provenance: TemplateWriteRequestProvenance;
+    /**
+     * Raster scale the layer assets were exported at; defaults to 1
+     * @type {number}
+     * @memberof TemplateWriteRequest
+     */
+    exportScale?: number;
+    /**
+     * Explicit base asset; defaults to the referenced asset's own public id
+     * @type {string}
+     * @memberof TemplateWriteRequest
+     */
+    basePublicId?: string;
+    /**
+     * Prefix the caller puts ahead of t_<name> when delivering
+     * @type {string}
+     * @memberof TemplateWriteRequest
+     */
+    deliveryParams?: string;
+}
+
+/**
+ * Check if a given object implements the TemplateWriteRequest interface.
+ */
+export function instanceOfTemplateWriteRequest(value: object): value is TemplateWriteRequest {
+    if (!('transformation' in value) || value['transformation'] === undefined) return false;
+    if (!('canvas' in value) || value['canvas'] === undefined) return false;
+    if (!('variables' in value) || value['variables'] === undefined) return false;
+    if (!('provenance' in value) || value['provenance'] === undefined) return false;
+    return true;
+}
+
+export function TemplateWriteRequestFromJSON(json: any): TemplateWriteRequest {
+    return TemplateWriteRequestFromJSONTyped(json, false);
+}
+
+export function TemplateWriteRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplateWriteRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'publicId': json['publicId'] == null ? undefined : json['publicId'],
+        'externalId': json['externalId'] == null ? undefined : json['externalId'],
+        'transformation': json['transformation'],
+        'canvas': TemplateWriteRequestCanvasFromJSON(json['canvas']),
+        'variables': ((json['variables'] as Array<any>).map(CldtTemplateVariableFromJSON)),
+        'provenance': TemplateWriteRequestProvenanceFromJSON(json['provenance']),
+        'exportScale': json['exportScale'] == null ? undefined : json['exportScale'],
+        'basePublicId': json['basePublicId'] == null ? undefined : json['basePublicId'],
+        'deliveryParams': json['deliveryParams'] == null ? undefined : json['deliveryParams'],
+    };
+}
+
+export function TemplateWriteRequestToJSON(json: any): TemplateWriteRequest {
+    return TemplateWriteRequestToJSONTyped(json, false);
+}
+
+export function TemplateWriteRequestToJSONTyped(value?: TemplateWriteRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'publicId': value['publicId'],
+        'externalId': value['externalId'],
+        'transformation': value['transformation'],
+        'canvas': TemplateWriteRequestCanvasToJSON(value['canvas']),
+        'variables': ((value['variables'] as Array<any>).map(CldtTemplateVariableToJSON)),
+        'provenance': TemplateWriteRequestProvenanceToJSON(value['provenance']),
+        'exportScale': value['exportScale'],
+        'basePublicId': value['basePublicId'],
+        'deliveryParams': value['deliveryParams'],
+    };
+}
+

package/src/models/TemplateWriteRequestCanvas.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cloudinary API Proxy
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2605.92
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Design canvas size in pixels
+ * @export
+ * @interface TemplateWriteRequestCanvas
+ */
+export interface TemplateWriteRequestCanvas {
+    /**
+     * 
+     * @type {number}
+     * @memberof TemplateWriteRequestCanvas
+     */
+    width: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof TemplateWriteRequestCanvas
+     */
+    height: number;
+}
+
+/**
+ * Check if a given object implements the TemplateWriteRequestCanvas interface.
+ */
+export function instanceOfTemplateWriteRequestCanvas(value: object): value is TemplateWriteRequestCanvas {
+    if (!('width' in value) || value['width'] === undefined) return false;
+    if (!('height' in value) || value['height'] === undefined) return false;
+    return true;
+}
+
+export function TemplateWriteRequestCanvasFromJSON(json: any): TemplateWriteRequestCanvas {
+    return TemplateWriteRequestCanvasFromJSONTyped(json, false);
+}
+
+export function TemplateWriteRequestCanvasFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplateWriteRequestCanvas {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'width': json['width'],
+        'height': json['height'],
+    };
+}
+
+export function TemplateWriteRequestCanvasToJSON(json: any): TemplateWriteRequestCanvas {
+    return TemplateWriteRequestCanvasToJSONTyped(json, false);
+}
+
+export function TemplateWriteRequestCanvasToJSONTyped(value?: TemplateWriteRequestCanvas | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'width': value['width'],
+        'height': value['height'],
+    };
+}
+

package/src/models/TemplateWriteRequestProvenance.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cloudinary API Proxy
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2605.92
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Where this template came from
+ * @export
+ * @interface TemplateWriteRequestProvenance
+ */
+export interface TemplateWriteRequestProvenance {
+    /**
+     * The client that produced this template, e.g. figma
+     * @type {string}
+     * @memberof TemplateWriteRequestProvenance
+     */
+    platform: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateWriteRequestProvenance
+     */
+    documentId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateWriteRequestProvenance
+     */
+    url: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof TemplateWriteRequestProvenance
+     */
+    createdBy: string;
+    /**
+     * ISO 8601 timestamp of when the design was exported
+     * @type {string}
+     * @memberof TemplateWriteRequestProvenance
+     */
+    createdAt: string;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof TemplateWriteRequestProvenance
+     */
+    sourceContext?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the TemplateWriteRequestProvenance interface.
+ */
+export function instanceOfTemplateWriteRequestProvenance(value: object): value is TemplateWriteRequestProvenance {
+    if (!('platform' in value) || value['platform'] === undefined) return false;
+    if (!('documentId' in value) || value['documentId'] === undefined) return false;
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function TemplateWriteRequestProvenanceFromJSON(json: any): TemplateWriteRequestProvenance {
+    return TemplateWriteRequestProvenanceFromJSONTyped(json, false);
+}
+
+export function TemplateWriteRequestProvenanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemplateWriteRequestProvenance {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'platform': json['platform'],
+        'documentId': json['documentId'],
+        'url': json['url'],
+        'createdBy': json['createdBy'],
+        'createdAt': json['createdAt'],
+        'sourceContext': json['sourceContext'] == null ? undefined : json['sourceContext'],
+    };
+}
+
+export function TemplateWriteRequestProvenanceToJSON(json: any): TemplateWriteRequestProvenance {
+    return TemplateWriteRequestProvenanceToJSONTyped(json, false);
+}
+
+export function TemplateWriteRequestProvenanceToJSONTyped(value?: TemplateWriteRequestProvenance | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'platform': value['platform'],
+        'documentId': value['documentId'],
+        'url': value['url'],
+        'createdBy': value['createdBy'],
+        'createdAt': value['createdAt'],
+        'sourceContext': value['sourceContext'],
+    };
+}
+