@cloudinary/apps-api 2.2605.49

package/dist/esm/models/Customer.js

@@ -0,0 +1,158 @@
+/* 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 { CustomerUploadLimitsFromJSON, CustomerUploadLimitsToJSON, } from './CustomerUploadLimits';
+/**
+ * Check if a given object implements the Customer interface.
+ */
+export function instanceOfCustomer(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('account_id' in value) || value['account_id'] === undefined)
+        return false;
+    if (!('cloud_name' in value) || value['cloud_name'] === undefined)
+        return false;
+    if (!('display_name' in value) || value['display_name'] === undefined)
+        return false;
+    if (!('account_external_id' in value) || value['account_external_id'] === undefined)
+        return false;
+    if (!('created_at' in value) || value['created_at'] === undefined)
+        return false;
+    if (!('cname' in value) || value['cname'] === undefined)
+        return false;
+    if (!('api_key' in value) || value['api_key'] === undefined)
+        return false;
+    if (!('base_url' in value) || value['base_url'] === undefined)
+        return false;
+    if (!('secure_base_url' in value) || value['secure_base_url'] === undefined)
+        return false;
+    if (!('upload_limits' in value) || value['upload_limits'] === undefined)
+        return false;
+    if (!('external_id' in value) || value['external_id'] === undefined)
+        return false;
+    if (!('geo' in value) || value['geo'] === undefined)
+        return false;
+    if (!('media_optimizer' in value) || value['media_optimizer'] === undefined)
+        return false;
+    if (!('programmable_media_editing' in value) || value['programmable_media_editing'] === undefined)
+        return false;
+    if (!('media_management' in value) || value['media_management'] === undefined)
+        return false;
+    if (!('product_id' in value) || value['product_id'] === undefined)
+        return false;
+    if (!('product_name' in value) || value['product_name'] === undefined)
+        return false;
+    if (!('block_display_customer_images' in value) || value['block_display_customer_images'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('cdn_url_type' in value) || value['cdn_url_type'] === undefined)
+        return false;
+    if (!('strict_transformations' in value) || value['strict_transformations'] === undefined)
+        return false;
+    if (!('backup' in value) || value['backup'] === undefined)
+        return false;
+    if (!('media_library_original_filename' in value) || value['media_library_original_filename'] === undefined)
+        return false;
+    if (!('etag_as_public_id' in value) || value['etag_as_public_id'] === undefined)
+        return false;
+    if (!('is_untrusted' in value) || value['is_untrusted'] === undefined)
+        return false;
+    if (!('folder_decoupling_enabled' in value) || value['folder_decoupling_enabled'] === undefined)
+        return false;
+    if (!('granular_permissions_enabled' in value) || value['granular_permissions_enabled'] === undefined)
+        return false;
+    return true;
+}
+export function CustomerFromJSON(json) {
+    return CustomerFromJSONTyped(json, false);
+}
+export function CustomerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'account_id': json['account_id'],
+        'cloud_name': json['cloud_name'],
+        'display_name': json['display_name'],
+        'account_external_id': json['account_external_id'],
+        'created_at': json['created_at'],
+        'cname': json['cname'],
+        'api_key': json['api_key'],
+        'base_url': json['base_url'],
+        'secure_base_url': json['secure_base_url'],
+        'upload_limits': CustomerUploadLimitsFromJSON(json['upload_limits']),
+        'external_id': json['external_id'],
+        'geo': json['geo'],
+        'media_optimizer': json['media_optimizer'],
+        'programmable_media_editing': json['programmable_media_editing'],
+        'media_management': json['media_management'],
+        'product_id': json['product_id'],
+        'product_name': json['product_name'],
+        'block_display_customer_images': json['block_display_customer_images'],
+        'description': json['description'],
+        'capabilities': json['capabilities'] == null ? undefined : json['capabilities'],
+        'status': json['status'],
+        'cdn_url_type': json['cdn_url_type'],
+        'strict_transformations': json['strict_transformations'],
+        'backup': json['backup'],
+        'media_library_original_filename': json['media_library_original_filename'],
+        'etag_as_public_id': json['etag_as_public_id'],
+        'is_untrusted': json['is_untrusted'],
+        'folder_decoupling_enabled': json['folder_decoupling_enabled'],
+        'granular_permissions_enabled': json['granular_permissions_enabled'],
+    };
+}
+export function CustomerToJSON(json) {
+    return CustomerToJSONTyped(json, false);
+}
+export function CustomerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'account_id': value['account_id'],
+        'cloud_name': value['cloud_name'],
+        'display_name': value['display_name'],
+        'account_external_id': value['account_external_id'],
+        'created_at': value['created_at'],
+        'cname': value['cname'],
+        'api_key': value['api_key'],
+        'base_url': value['base_url'],
+        'secure_base_url': value['secure_base_url'],
+        'upload_limits': CustomerUploadLimitsToJSON(value['upload_limits']),
+        'external_id': value['external_id'],
+        'geo': value['geo'],
+        'media_optimizer': value['media_optimizer'],
+        'programmable_media_editing': value['programmable_media_editing'],
+        'media_management': value['media_management'],
+        'product_id': value['product_id'],
+        'product_name': value['product_name'],
+        'block_display_customer_images': value['block_display_customer_images'],
+        'description': value['description'],
+        'capabilities': value['capabilities'],
+        'status': value['status'],
+        'cdn_url_type': value['cdn_url_type'],
+        'strict_transformations': value['strict_transformations'],
+        'backup': value['backup'],
+        'media_library_original_filename': value['media_library_original_filename'],
+        'etag_as_public_id': value['etag_as_public_id'],
+        'is_untrusted': value['is_untrusted'],
+        'folder_decoupling_enabled': value['folder_decoupling_enabled'],
+        'granular_permissions_enabled': value['granular_permissions_enabled'],
+    };
+}

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

@@ -0,0 +1,74 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CustomerListMeta
+ */
+export interface CustomerListMeta {
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerListMeta
+     */
+    max_product_environments: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerListMeta
+     */
+    current_product_environments_count: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerListMeta
+     */
+    total_active: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerListMeta
+     */
+    current_page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerListMeta
+     */
+    next_page: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerListMeta
+     */
+    total_pages: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerListMeta
+     */
+    page_size: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerListMeta
+     */
+    total_entries: number;
+}
+/**
+ * Check if a given object implements the CustomerListMeta interface.
+ */
+export declare function instanceOfCustomerListMeta(value: object): value is CustomerListMeta;
+export declare function CustomerListMetaFromJSON(json: any): CustomerListMeta;
+export declare function CustomerListMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomerListMeta;
+export declare function CustomerListMetaToJSON(json: any): CustomerListMeta;
+export declare function CustomerListMetaToJSONTyped(value?: CustomerListMeta | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomerListMeta.js

@@ -0,0 +1,71 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the CustomerListMeta interface.
+ */
+export function instanceOfCustomerListMeta(value) {
+    if (!('max_product_environments' in value) || value['max_product_environments'] === undefined)
+        return false;
+    if (!('current_product_environments_count' in value) || value['current_product_environments_count'] === undefined)
+        return false;
+    if (!('total_active' in value) || value['total_active'] === undefined)
+        return false;
+    if (!('current_page' in value) || value['current_page'] === undefined)
+        return false;
+    if (!('next_page' in value) || value['next_page'] === undefined)
+        return false;
+    if (!('total_pages' in value) || value['total_pages'] === undefined)
+        return false;
+    if (!('page_size' in value) || value['page_size'] === undefined)
+        return false;
+    if (!('total_entries' in value) || value['total_entries'] === undefined)
+        return false;
+    return true;
+}
+export function CustomerListMetaFromJSON(json) {
+    return CustomerListMetaFromJSONTyped(json, false);
+}
+export function CustomerListMetaFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'max_product_environments': json['max_product_environments'],
+        'current_product_environments_count': json['current_product_environments_count'],
+        'total_active': json['total_active'],
+        'current_page': json['current_page'],
+        'next_page': json['next_page'],
+        'total_pages': json['total_pages'],
+        'page_size': json['page_size'],
+        'total_entries': json['total_entries'],
+    };
+}
+export function CustomerListMetaToJSON(json) {
+    return CustomerListMetaToJSONTyped(json, false);
+}
+export function CustomerListMetaToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'max_product_environments': value['max_product_environments'],
+        'current_product_environments_count': value['current_product_environments_count'],
+        'total_active': value['total_active'],
+        'current_page': value['current_page'],
+        'next_page': value['next_page'],
+        'total_pages': value['total_pages'],
+        'page_size': value['page_size'],
+        'total_entries': value['total_entries'],
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CustomerUploadLimits
+ */
+export interface CustomerUploadLimits {
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerUploadLimits
+     */
+    image_max_size_bytes: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerUploadLimits
+     */
+    video_max_size_bytes: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerUploadLimits
+     */
+    raw_max_size_bytes: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerUploadLimits
+     */
+    image_max_px: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerUploadLimits
+     */
+    asset_max_total_px: number;
+}
+/**
+ * Check if a given object implements the CustomerUploadLimits interface.
+ */
+export declare function instanceOfCustomerUploadLimits(value: object): value is CustomerUploadLimits;
+export declare function CustomerUploadLimitsFromJSON(json: any): CustomerUploadLimits;
+export declare function CustomerUploadLimitsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomerUploadLimits;
+export declare function CustomerUploadLimitsToJSON(json: any): CustomerUploadLimits;
+export declare function CustomerUploadLimitsToJSONTyped(value?: CustomerUploadLimits | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CustomerUploadLimits.js

@@ -0,0 +1,59 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the CustomerUploadLimits interface.
+ */
+export function instanceOfCustomerUploadLimits(value) {
+    if (!('image_max_size_bytes' in value) || value['image_max_size_bytes'] === undefined)
+        return false;
+    if (!('video_max_size_bytes' in value) || value['video_max_size_bytes'] === undefined)
+        return false;
+    if (!('raw_max_size_bytes' in value) || value['raw_max_size_bytes'] === undefined)
+        return false;
+    if (!('image_max_px' in value) || value['image_max_px'] === undefined)
+        return false;
+    if (!('asset_max_total_px' in value) || value['asset_max_total_px'] === undefined)
+        return false;
+    return true;
+}
+export function CustomerUploadLimitsFromJSON(json) {
+    return CustomerUploadLimitsFromJSONTyped(json, false);
+}
+export function CustomerUploadLimitsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'image_max_size_bytes': json['image_max_size_bytes'],
+        'video_max_size_bytes': json['video_max_size_bytes'],
+        'raw_max_size_bytes': json['raw_max_size_bytes'],
+        'image_max_px': json['image_max_px'],
+        'asset_max_total_px': json['asset_max_total_px'],
+    };
+}
+export function CustomerUploadLimitsToJSON(json) {
+    return CustomerUploadLimitsToJSONTyped(json, false);
+}
+export function CustomerUploadLimitsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'image_max_size_bytes': value['image_max_size_bytes'],
+        'video_max_size_bytes': value['video_max_size_bytes'],
+        'raw_max_size_bytes': value['raw_max_size_bytes'],
+        'image_max_px': value['image_max_px'],
+        'asset_max_total_px': value['asset_max_total_px'],
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface DamAppErrorResponse
+ */
+export interface DamAppErrorResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof DamAppErrorResponse
+     */
+    error: string;
+}
+/**
+ * Check if a given object implements the DamAppErrorResponse interface.
+ */
+export declare function instanceOfDamAppErrorResponse(value: object): value is DamAppErrorResponse;
+export declare function DamAppErrorResponseFromJSON(json: any): DamAppErrorResponse;
+export declare function DamAppErrorResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DamAppErrorResponse;
+export declare function DamAppErrorResponseToJSON(json: any): DamAppErrorResponse;
+export declare function DamAppErrorResponseToJSONTyped(value?: DamAppErrorResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DamAppErrorResponse.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the DamAppErrorResponse interface.
+ */
+export function instanceOfDamAppErrorResponse(value) {
+    if (!('error' in value) || value['error'] === undefined)
+        return false;
+    return true;
+}
+export function DamAppErrorResponseFromJSON(json) {
+    return DamAppErrorResponseFromJSONTyped(json, false);
+}
+export function DamAppErrorResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'error': json['error'],
+    };
+}
+export function DamAppErrorResponseToJSON(json) {
+    return DamAppErrorResponseToJSONTyped(json, false);
+}
+export function DamAppErrorResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'error': value['error'],
+    };
+}

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

@@ -0,0 +1,153 @@
+/**
+ * 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 type { DamAppResponseAssetAmountLimit } from './DamAppResponseAssetAmountLimit';
+import type { DamAppResponseAppMessageParamsValue } from './DamAppResponseAppMessageParamsValue';
+import type { DamAppUserSnapshot } 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 declare const DamAppResponseAvailabilityEnum: {
+    readonly Internal: "internal";
+    readonly NonCertified: "non_certified";
+    readonly Certified: "certified";
+    readonly Global: "global";
+};
+export type DamAppResponseAvailabilityEnum = typeof DamAppResponseAvailabilityEnum[keyof typeof DamAppResponseAvailabilityEnum];
+/**
+ * Check if a given object implements the DamAppResponse interface.
+ */
+export declare function instanceOfDamAppResponse(value: object): value is DamAppResponse;
+export declare function DamAppResponseFromJSON(json: any): DamAppResponse;
+export declare function DamAppResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DamAppResponse;
+export declare function DamAppResponseToJSON(json: any): DamAppResponse;
+export declare function DamAppResponseToJSONTyped(value?: DamAppResponse | null, ignoreDiscriminator?: boolean): any;