@cloudinary/apps-api 2.2605.49

package/src/models/DamAppResponse.ts

@@ -0,0 +1,243 @@
+/* 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.49
+ * 
+ *
+ * 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 { DamAppResponseAssetAmountLimit } from './DamAppResponseAssetAmountLimit';
+import {
+    DamAppResponseAssetAmountLimitFromJSON,
+    DamAppResponseAssetAmountLimitFromJSONTyped,
+    DamAppResponseAssetAmountLimitToJSON,
+    DamAppResponseAssetAmountLimitToJSONTyped,
+} from './DamAppResponseAssetAmountLimit';
+import type { DamAppResponseAppMessageParamsValue } from './DamAppResponseAppMessageParamsValue';
+import {
+    DamAppResponseAppMessageParamsValueFromJSON,
+    DamAppResponseAppMessageParamsValueFromJSONTyped,
+    DamAppResponseAppMessageParamsValueToJSON,
+    DamAppResponseAppMessageParamsValueToJSONTyped,
+} from './DamAppResponseAppMessageParamsValue';
+import type { DamAppUserSnapshot } from './DamAppUserSnapshot';
+import {
+    DamAppUserSnapshotFromJSON,
+    DamAppUserSnapshotFromJSONTyped,
+    DamAppUserSnapshotToJSON,
+    DamAppUserSnapshotToJSONTyped,
+} from './DamAppUserSnapshot';
+
+/**
+ * 
+ * @export
+ * @interface DamAppResponse
+ */
+export interface DamAppResponse {
+    /**
+     * Display name of the DAM app
+     * @type {string}
+     * @memberof DamAppResponse
+     */
+    appName: string;
+    /**
+     * Short description shown in the Media Library
+     * @type {string}
+     * @memberof DamAppResponse
+     */
+    appDescription?: string;
+    /**
+     * Custom action UUID
+     * @type {string}
+     * @memberof DamAppResponse
+     */
+    appId?: string;
+    /**
+     * URL loaded when the custom action is triggered
+     * @type {string}
+     * @memberof DamAppResponse
+     */
+    appUrl: string;
+    /**
+     * Icon URL for the action in the ML UI
+     * @type {string}
+     * @memberof DamAppResponse
+     */
+    actionIcon: string;
+    /**
+     * Dynamic query params requested by the app
+     * @type {{ [key: string]: any; }}
+     * @memberof DamAppResponse
+     */
+    appUrlParams?: { [key: string]: any; };
+    /**
+     * Dynamic data passed to the app when opened (e.g. cloud_name, selected_items)
+     * @type {{ [key: string]: DamAppResponseAppMessageParamsValue; }}
+     * @memberof DamAppResponse
+     */
+    appMessageParams?: { [key: string]: DamAppResponseAppMessageParamsValue; };
+    /**
+     * Whether the app is enabled for this customer
+     * @type {boolean}
+     * @memberof DamAppResponse
+     */
+    appActive: boolean;
+    /**
+     * Custom modal window title
+     * @type {string}
+     * @memberof DamAppResponse
+     */
+    appTitle?: string;
+    /**
+     * Supported file formats
+     * @type {Array<string>}
+     * @memberof DamAppResponse
+     */
+    assetFormat?: Array<string>;
+    /**
+     * Devices where the action is shown
+     * @type {Array<string>}
+     * @memberof DamAppResponse
+     */
+    appSupportedDevices: Array<string>;
+    /**
+     * 
+     * @type {DamAppResponseAssetAmountLimit}
+     * @memberof DamAppResponse
+     */
+    assetAmountLimit?: DamAppResponseAssetAmountLimit | null;
+    /**
+     * Entity type for UI selection (e.g. asset, collection)
+     * @type {Array<string>}
+     * @memberof DamAppResponse
+     */
+    selectionType: Array<string>;
+    /**
+     * 
+     * @type {DamAppUserSnapshot}
+     * @memberof DamAppResponse
+     */
+    userCreatedBy?: DamAppUserSnapshot;
+    /**
+     * 
+     * @type {DamAppUserSnapshot}
+     * @memberof DamAppResponse
+     */
+    userUpdatedBy?: DamAppUserSnapshot;
+    /**
+     * App availability / certification tier
+     * @type {string}
+     * @memberof DamAppResponse
+     */
+    availability: DamAppResponseAvailabilityEnum;
+    /**
+     * Whether cloudinary.app.json is served from appUrl
+     * @type {boolean}
+     * @memberof DamAppResponse
+     */
+    hasManifest?: boolean | null;
+    /**
+     * cloudinary.app.json when stored inline
+     * @type {{ [key: string]: any; }}
+     * @memberof DamAppResponse
+     */
+    manifest?: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const DamAppResponseAvailabilityEnum = {
+    Internal: 'internal',
+    NonCertified: 'non_certified',
+    Certified: 'certified',
+    Global: 'global'
+} as const;
+export type DamAppResponseAvailabilityEnum = typeof DamAppResponseAvailabilityEnum[keyof typeof DamAppResponseAvailabilityEnum];
+
+
+/**
+ * Check if a given object implements the DamAppResponse interface.
+ */
+export function instanceOfDamAppResponse(value: object): value is DamAppResponse {
+    if (!('appName' in value) || value['appName'] === undefined) return false;
+    if (!('appUrl' in value) || value['appUrl'] === undefined) return false;
+    if (!('actionIcon' in value) || value['actionIcon'] === undefined) return false;
+    if (!('appActive' in value) || value['appActive'] === undefined) return false;
+    if (!('appSupportedDevices' in value) || value['appSupportedDevices'] === undefined) return false;
+    if (!('selectionType' in value) || value['selectionType'] === undefined) return false;
+    if (!('availability' in value) || value['availability'] === undefined) return false;
+    return true;
+}
+
+export function DamAppResponseFromJSON(json: any): DamAppResponse {
+    return DamAppResponseFromJSONTyped(json, false);
+}
+
+export function DamAppResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DamAppResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'appName': json['appName'],
+        'appDescription': json['appDescription'] == null ? undefined : json['appDescription'],
+        'appId': json['appId'] == null ? undefined : json['appId'],
+        'appUrl': json['appUrl'],
+        'actionIcon': json['actionIcon'],
+        'appUrlParams': json['appUrlParams'] == null ? undefined : json['appUrlParams'],
+        'appMessageParams': json['appMessageParams'] == null ? undefined : (mapValues(json['appMessageParams'], DamAppResponseAppMessageParamsValueFromJSON)),
+        'appActive': json['appActive'],
+        'appTitle': json['appTitle'] == null ? undefined : json['appTitle'],
+        'assetFormat': json['assetFormat'] == null ? undefined : json['assetFormat'],
+        'appSupportedDevices': json['appSupportedDevices'],
+        'assetAmountLimit': json['assetAmountLimit'] == null ? undefined : DamAppResponseAssetAmountLimitFromJSON(json['assetAmountLimit']),
+        'selectionType': json['selectionType'],
+        'userCreatedBy': json['userCreatedBy'] == null ? undefined : DamAppUserSnapshotFromJSON(json['userCreatedBy']),
+        'userUpdatedBy': json['userUpdatedBy'] == null ? undefined : DamAppUserSnapshotFromJSON(json['userUpdatedBy']),
+        'availability': json['availability'],
+        'hasManifest': json['hasManifest'] == null ? undefined : json['hasManifest'],
+        'manifest': json['manifest'] == null ? undefined : json['manifest'],
+    };
+}
+
+export function DamAppResponseToJSON(json: any): DamAppResponse {
+    return DamAppResponseToJSONTyped(json, false);
+}
+
+export function DamAppResponseToJSONTyped(value?: DamAppResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'appName': value['appName'],
+        'appDescription': value['appDescription'],
+        'appId': value['appId'],
+        'appUrl': value['appUrl'],
+        'actionIcon': value['actionIcon'],
+        'appUrlParams': value['appUrlParams'],
+        'appMessageParams': value['appMessageParams'] == null ? undefined : (mapValues(value['appMessageParams'], DamAppResponseAppMessageParamsValueToJSON)),
+        'appActive': value['appActive'],
+        'appTitle': value['appTitle'],
+        'assetFormat': value['assetFormat'],
+        'appSupportedDevices': value['appSupportedDevices'],
+        'assetAmountLimit': DamAppResponseAssetAmountLimitToJSON(value['assetAmountLimit']),
+        'selectionType': value['selectionType'],
+        'userCreatedBy': DamAppUserSnapshotToJSON(value['userCreatedBy']),
+        'userUpdatedBy': DamAppUserSnapshotToJSON(value['userUpdatedBy']),
+        'availability': value['availability'],
+        'hasManifest': value['hasManifest'],
+        'manifest': value['manifest'],
+    };
+}
+

package/src/models/DamAppResponseAppMessageParamsValue.ts

@@ -0,0 +1,82 @@
+/* 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.49
+ * 
+ *
+ * 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 { DamAppResponseAppMessageParamsValueAnyOf } from './DamAppResponseAppMessageParamsValueAnyOf';
+import {
+    DamAppResponseAppMessageParamsValueAnyOfFromJSON,
+    DamAppResponseAppMessageParamsValueAnyOfFromJSONTyped,
+    DamAppResponseAppMessageParamsValueAnyOfToJSON,
+    DamAppResponseAppMessageParamsValueAnyOfToJSONTyped,
+} from './DamAppResponseAppMessageParamsValueAnyOf';
+
+/**
+ * 
+ * @export
+ * @interface DamAppResponseAppMessageParamsValue
+ */
+export interface DamAppResponseAppMessageParamsValue {
+    /**
+     * 
+     * @type {string}
+     * @memberof DamAppResponseAppMessageParamsValue
+     */
+    type: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DamAppResponseAppMessageParamsValue
+     */
+    attributes?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the DamAppResponseAppMessageParamsValue interface.
+ */
+export function instanceOfDamAppResponseAppMessageParamsValue(value: object): value is DamAppResponseAppMessageParamsValue {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function DamAppResponseAppMessageParamsValueFromJSON(json: any): DamAppResponseAppMessageParamsValue {
+    return DamAppResponseAppMessageParamsValueFromJSONTyped(json, false);
+}
+
+export function DamAppResponseAppMessageParamsValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): DamAppResponseAppMessageParamsValue {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'attributes': json['attributes'] == null ? undefined : json['attributes'],
+    };
+}
+
+export function DamAppResponseAppMessageParamsValueToJSON(json: any): DamAppResponseAppMessageParamsValue {
+    return DamAppResponseAppMessageParamsValueToJSONTyped(json, false);
+}
+
+export function DamAppResponseAppMessageParamsValueToJSONTyped(value?: DamAppResponseAppMessageParamsValue | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'attributes': value['attributes'],
+    };
+}
+

package/src/models/DamAppResponseAppMessageParamsValueAnyOf.ts

@@ -0,0 +1,74 @@
+/* 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.49
+ * 
+ *
+ * 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 DamAppResponseAppMessageParamsValueAnyOf
+ */
+export interface DamAppResponseAppMessageParamsValueAnyOf {
+    /**
+     * 
+     * @type {string}
+     * @memberof DamAppResponseAppMessageParamsValueAnyOf
+     */
+    type: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DamAppResponseAppMessageParamsValueAnyOf
+     */
+    attributes?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the DamAppResponseAppMessageParamsValueAnyOf interface.
+ */
+export function instanceOfDamAppResponseAppMessageParamsValueAnyOf(value: object): value is DamAppResponseAppMessageParamsValueAnyOf {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function DamAppResponseAppMessageParamsValueAnyOfFromJSON(json: any): DamAppResponseAppMessageParamsValueAnyOf {
+    return DamAppResponseAppMessageParamsValueAnyOfFromJSONTyped(json, false);
+}
+
+export function DamAppResponseAppMessageParamsValueAnyOfFromJSONTyped(json: any, ignoreDiscriminator: boolean): DamAppResponseAppMessageParamsValueAnyOf {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'attributes': json['attributes'] == null ? undefined : json['attributes'],
+    };
+}
+
+export function DamAppResponseAppMessageParamsValueAnyOfToJSON(json: any): DamAppResponseAppMessageParamsValueAnyOf {
+    return DamAppResponseAppMessageParamsValueAnyOfToJSONTyped(json, false);
+}
+
+export function DamAppResponseAppMessageParamsValueAnyOfToJSONTyped(value?: DamAppResponseAppMessageParamsValueAnyOf | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'attributes': value['attributes'],
+    };
+}
+

package/src/models/DamAppResponseAssetAmountLimit.ts

@@ -0,0 +1,46 @@
+/* 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.49
+ * 
+ *
+ * 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';
+/**
+ * Max assets passed to the app; empty string means no limit
+ * @export
+ * @interface DamAppResponseAssetAmountLimit
+ */
+export interface DamAppResponseAssetAmountLimit {
+}
+
+/**
+ * Check if a given object implements the DamAppResponseAssetAmountLimit interface.
+ */
+export function instanceOfDamAppResponseAssetAmountLimit(value: object): value is DamAppResponseAssetAmountLimit {
+    return true;
+}
+
+export function DamAppResponseAssetAmountLimitFromJSON(json: any): DamAppResponseAssetAmountLimit {
+    return DamAppResponseAssetAmountLimitFromJSONTyped(json, false);
+}
+
+export function DamAppResponseAssetAmountLimitFromJSONTyped(json: any, ignoreDiscriminator: boolean): DamAppResponseAssetAmountLimit {
+    return json;
+}
+
+export function DamAppResponseAssetAmountLimitToJSON(json: any): DamAppResponseAssetAmountLimit {
+    return DamAppResponseAssetAmountLimitToJSONTyped(json, false);
+}
+
+export function DamAppResponseAssetAmountLimitToJSONTyped(value?: DamAppResponseAssetAmountLimit | null, ignoreDiscriminator: boolean = false): any {
+    return value;
+}
+

package/src/models/DamAppUserSnapshot.ts

@@ -0,0 +1,89 @@
+/* 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.49
+ * 
+ *
+ * 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 DamAppUserSnapshot
+ */
+export interface DamAppUserSnapshot {
+    /**
+     * 
+     * @type {string}
+     * @memberof DamAppUserSnapshot
+     */
+    email?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DamAppUserSnapshot
+     */
+    first_name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DamAppUserSnapshot
+     */
+    last_name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DamAppUserSnapshot
+     */
+    external_id?: string;
+}
+
+/**
+ * Check if a given object implements the DamAppUserSnapshot interface.
+ */
+export function instanceOfDamAppUserSnapshot(value: object): value is DamAppUserSnapshot {
+    return true;
+}
+
+export function DamAppUserSnapshotFromJSON(json: any): DamAppUserSnapshot {
+    return DamAppUserSnapshotFromJSONTyped(json, false);
+}
+
+export function DamAppUserSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): DamAppUserSnapshot {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'email': json['email'] == null ? undefined : json['email'],
+        'first_name': json['first_name'] == null ? undefined : json['first_name'],
+        'last_name': json['last_name'] == null ? undefined : json['last_name'],
+        'external_id': json['external_id'] == null ? undefined : json['external_id'],
+    };
+}
+
+export function DamAppUserSnapshotToJSON(json: any): DamAppUserSnapshot {
+    return DamAppUserSnapshotToJSONTyped(json, false);
+}
+
+export function DamAppUserSnapshotToJSONTyped(value?: DamAppUserSnapshot | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'email': value['email'],
+        'first_name': value['first_name'],
+        'last_name': value['last_name'],
+        'external_id': value['external_id'],
+    };
+}
+

package/src/models/DeleteFolderResponse.ts

@@ -0,0 +1,73 @@
+/* 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.49
+ * 
+ *
+ * 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 DeleteFolderResponse
+ */
+export interface DeleteFolderResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DeleteFolderResponse
+     */
+    fully_deleted?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof DeleteFolderResponse
+     */
+    id?: string;
+}
+
+/**
+ * Check if a given object implements the DeleteFolderResponse interface.
+ */
+export function instanceOfDeleteFolderResponse(value: object): value is DeleteFolderResponse {
+    return true;
+}
+
+export function DeleteFolderResponseFromJSON(json: any): DeleteFolderResponse {
+    return DeleteFolderResponseFromJSONTyped(json, false);
+}
+
+export function DeleteFolderResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteFolderResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fully_deleted': json['fully_deleted'] == null ? undefined : json['fully_deleted'],
+        'id': json['id'] == null ? undefined : json['id'],
+    };
+}
+
+export function DeleteFolderResponseToJSON(json: any): DeleteFolderResponse {
+    return DeleteFolderResponseToJSONTyped(json, false);
+}
+
+export function DeleteFolderResponseToJSONTyped(value?: DeleteFolderResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'fully_deleted': value['fully_deleted'],
+        'id': value['id'],
+    };
+}
+

package/src/models/DeployApp200Response.ts

@@ -0,0 +1,84 @@
+/* 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.49
+ * 
+ *
+ * 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 DeployApp200Response
+ */
+export interface DeployApp200Response {
+    /**
+     * 
+     * @type {string}
+     * @memberof DeployApp200Response
+     */
+    deployed_url: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DeployApp200Response
+     */
+    app_url: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DeployApp200Response
+     */
+    app_url_updated: boolean;
+}
+
+/**
+ * Check if a given object implements the DeployApp200Response interface.
+ */
+export function instanceOfDeployApp200Response(value: object): value is DeployApp200Response {
+    if (!('deployed_url' in value) || value['deployed_url'] === undefined) return false;
+    if (!('app_url' in value) || value['app_url'] === undefined) return false;
+    if (!('app_url_updated' in value) || value['app_url_updated'] === undefined) return false;
+    return true;
+}
+
+export function DeployApp200ResponseFromJSON(json: any): DeployApp200Response {
+    return DeployApp200ResponseFromJSONTyped(json, false);
+}
+
+export function DeployApp200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeployApp200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'deployed_url': json['deployed_url'],
+        'app_url': json['app_url'],
+        'app_url_updated': json['app_url_updated'],
+    };
+}
+
+export function DeployApp200ResponseToJSON(json: any): DeployApp200Response {
+    return DeployApp200ResponseToJSONTyped(json, false);
+}
+
+export function DeployApp200ResponseToJSONTyped(value?: DeployApp200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'deployed_url': value['deployed_url'],
+        'app_url': value['app_url'],
+        'app_url_updated': value['app_url_updated'],
+    };
+}
+