@cloudinary/apps-api 2.2605.52 → 2.2605.56

package/src/apis/ConsoleApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/MediaApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/PlatformApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -25,12 +25,16 @@ import type {
   Customer,
   DamAppErrorResponse,
   DamAppResponse,
+  DashboardDataResponse,
   DeployApp200Response,
   DeployApp207Response,
   DeployApp400Response,
   ErrorResponse,
   ErrorWithMessageResponse,
+  ForbiddenResponse,
+  ListAddonsResponse,
   ListCustomersResponse,
+  ListUsersResponse,
   NamespaceTokenCreateErrorResponse,
   NamespaceTokenCreateResponse,
   RefreshTokenErrorResponse,
@@ -61,6 +65,8 @@ import {
     DamAppErrorResponseToJSON,
     DamAppResponseFromJSON,
     DamAppResponseToJSON,
+    DashboardDataResponseFromJSON,
+    DashboardDataResponseToJSON,
     DeployApp200ResponseFromJSON,
     DeployApp200ResponseToJSON,
     DeployApp207ResponseFromJSON,
@@ -71,8 +77,14 @@ import {
     ErrorResponseToJSON,
     ErrorWithMessageResponseFromJSON,
     ErrorWithMessageResponseToJSON,
+    ForbiddenResponseFromJSON,
+    ForbiddenResponseToJSON,
+    ListAddonsResponseFromJSON,
+    ListAddonsResponseToJSON,
     ListCustomersResponseFromJSON,
     ListCustomersResponseToJSON,
+    ListUsersResponseFromJSON,
+    ListUsersResponseToJSON,
     NamespaceTokenCreateErrorResponseFromJSON,
     NamespaceTokenCreateErrorResponseToJSON,
     NamespaceTokenCreateResponseFromJSON,
@@ -117,6 +129,15 @@ export interface PlatformApiGetCustomerByCloudRequest {
     cloudName: string;
 }
 
+export interface PlatformApiGetDashboardDataRequest {
+    variant: string;
+    timespan?: string;
+    maxResults?: number | null;
+    sortBy?: string;
+    filters?: string;
+    only?: string;
+}
+
 export interface PlatformApiListCustomersRequest {
     nameContains?: string;
     cloudName?: string;
@@ -125,6 +146,14 @@ export interface PlatformApiListCustomersRequest {
     sortOrder?: string;
 }
 
+export interface PlatformApiListUsersRequest {
+    page?: number | null;
+    pageSize?: number | null;
+    sortBy?: string;
+    sortOrder?: string;
+    withDeleted?: boolean | null;
+}
+
 export interface PlatformApiRefreshCloudinaryTokenRequest {
     type: RefreshCloudinaryTokenTypeEnum;
 }
@@ -489,6 +518,112 @@ export class PlatformApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Returns cloud-level dashboard data for the requested variant (e.g. usage and delivery trend widgets). The variant string and the shape of data/items are defined by the upstream reporting service.
+     * Get dashboard report data
+     */
+    async getDashboardDataRaw(requestParameters: PlatformApiGetDashboardDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DashboardDataResponse>> {
+        if (requestParameters['variant'] == null) {
+            throw new runtime.RequiredError(
+                'variant',
+                'Required parameter "variant" was null or undefined when calling getDashboardData().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['timespan'] != null) {
+            queryParameters['timespan'] = requestParameters['timespan'];
+        }
+
+        if (requestParameters['maxResults'] != null) {
+            queryParameters['max_results'] = requestParameters['maxResults'];
+        }
+
+        if (requestParameters['sortBy'] != null) {
+            queryParameters['sort_by'] = requestParameters['sortBy'];
+        }
+
+        if (requestParameters['filters'] != null) {
+            queryParameters['filters'] = requestParameters['filters'];
+        }
+
+        if (requestParameters['only'] != null) {
+            queryParameters['only'] = requestParameters['only'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v2605/platform/reports/dashboard/{variant}`;
+        urlPath = urlPath.replace(`{${"variant"}}`, encodeURIComponent(String(requestParameters['variant'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DashboardDataResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns cloud-level dashboard data for the requested variant (e.g. usage and delivery trend widgets). The variant string and the shape of data/items are defined by the upstream reporting service.
+     * Get dashboard report data
+     */
+    async getDashboardData(requestParameters: PlatformApiGetDashboardDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DashboardDataResponse> {
+        const response = await this.getDashboardDataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns all billable addons (features) from Multi-Product Billing for the authenticated account.
+     * List billing addons
+     */
+    async listBillingAddonsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAddonsResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v2605/platform/billing/addons`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListAddonsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns all billable addons (features) from Multi-Product Billing for the authenticated account.
+     * List billing addons
+     */
+    async listBillingAddons(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAddonsResponse> {
+        const response = await this.listBillingAddonsRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Returns all Cloudinary customer accounts the authenticated user has access to. Supports filtering by name, cloud_name, and product, with configurable sorting.
      * List customers (clouds) accessible to the user
@@ -548,6 +683,65 @@ export class PlatformApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Returns the users of the product environment with pagination and sorting. Useful for resolving user identities (e.g. in asset history) and adoption reporting.
+     * List users
+     */
+    async listUsersRaw(requestParameters: PlatformApiListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListUsersResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
+        if (requestParameters['sortBy'] != null) {
+            queryParameters['sort_by'] = requestParameters['sortBy'];
+        }
+
+        if (requestParameters['sortOrder'] != null) {
+            queryParameters['sort_order'] = requestParameters['sortOrder'];
+        }
+
+        if (requestParameters['withDeleted'] != null) {
+            queryParameters['with_deleted'] = requestParameters['withDeleted'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v2605/platform/users`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListUsersResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the users of the product environment with pagination and sorting. Useful for resolving user identities (e.g. in asset history) and adoption reporting.
+     * List users
+     */
+    async listUsers(requestParameters: PlatformApiListUsersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListUsersResponse> {
+        const response = await this.listUsersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Exchanges the current gateway bearer token for a fresh underlying Cloudinary token of the specified type (oauth or console). Returns a 401 and invalidates the session if the token cannot be refreshed.
      * Refresh a Cloudinary token

package/src/apis/UploadApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/UtilsApi.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AddCollectionAssetsRequest.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AddCollectionAssetsResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AddPortalCollectionsRequest.ts

@@ -0,0 +1,66 @@
+/* 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.56
+ * 
+ *
+ * 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 AddPortalCollectionsRequest
+ */
+export interface AddPortalCollectionsRequest {
+    /**
+     * Collection external IDs to add to the portal
+     * @type {Array<string>}
+     * @memberof AddPortalCollectionsRequest
+     */
+    collection_ids: Array<string>;
+}
+
+/**
+ * Check if a given object implements the AddPortalCollectionsRequest interface.
+ */
+export function instanceOfAddPortalCollectionsRequest(value: object): value is AddPortalCollectionsRequest {
+    if (!('collection_ids' in value) || value['collection_ids'] === undefined) return false;
+    return true;
+}
+
+export function AddPortalCollectionsRequestFromJSON(json: any): AddPortalCollectionsRequest {
+    return AddPortalCollectionsRequestFromJSONTyped(json, false);
+}
+
+export function AddPortalCollectionsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddPortalCollectionsRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'collection_ids': json['collection_ids'],
+    };
+}
+
+export function AddPortalCollectionsRequestToJSON(json: any): AddPortalCollectionsRequest {
+    return AddPortalCollectionsRequestToJSONTyped(json, false);
+}
+
+export function AddPortalCollectionsRequestToJSONTyped(value?: AddPortalCollectionsRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'collection_ids': value['collection_ids'],
+    };
+}
+

package/src/models/Addon.ts

@@ -0,0 +1,145 @@
+/* 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.56
+ * 
+ *
+ * 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 { AddonSubscription } from './AddonSubscription';
+import {
+    AddonSubscriptionFromJSON,
+    AddonSubscriptionFromJSONTyped,
+    AddonSubscriptionToJSON,
+    AddonSubscriptionToJSONTyped,
+} from './AddonSubscription';
+
+/**
+ * 
+ * @export
+ * @interface Addon
+ */
+export interface Addon {
+    /**
+     * 
+     * @type {string}
+     * @memberof Addon
+     */
+    code?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Addon
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Addon
+     */
+    display_name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Addon
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Addon
+     */
+    documentation_url?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Addon
+     */
+    icon?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Addon
+     */
+    provider?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Addon
+     */
+    provider_url?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Addon
+     */
+    has_free_plan?: boolean;
+    /**
+     * 
+     * @type {AddonSubscription}
+     * @memberof Addon
+     */
+    subscription?: AddonSubscription;
+}
+
+/**
+ * Check if a given object implements the Addon interface.
+ */
+export function instanceOfAddon(value: object): value is Addon {
+    return true;
+}
+
+export function AddonFromJSON(json: any): Addon {
+    return AddonFromJSONTyped(json, false);
+}
+
+export function AddonFromJSONTyped(json: any, ignoreDiscriminator: boolean): Addon {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'] == null ? undefined : json['code'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'display_name': json['display_name'] == null ? undefined : json['display_name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'documentation_url': json['documentation_url'] == null ? undefined : json['documentation_url'],
+        'icon': json['icon'] == null ? undefined : json['icon'],
+        'provider': json['provider'] == null ? undefined : json['provider'],
+        'provider_url': json['provider_url'] == null ? undefined : json['provider_url'],
+        'has_free_plan': json['has_free_plan'] == null ? undefined : json['has_free_plan'],
+        'subscription': json['subscription'] == null ? undefined : AddonSubscriptionFromJSON(json['subscription']),
+    };
+}
+
+export function AddonToJSON(json: any): Addon {
+    return AddonToJSONTyped(json, false);
+}
+
+export function AddonToJSONTyped(value?: Addon | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'name': value['name'],
+        'display_name': value['display_name'],
+        'description': value['description'],
+        'documentation_url': value['documentation_url'],
+        'icon': value['icon'],
+        'provider': value['provider'],
+        'provider_url': value['provider_url'],
+        'has_free_plan': value['has_free_plan'],
+        'subscription': AddonSubscriptionToJSON(value['subscription']),
+    };
+}
+

package/src/models/AddonSubscription.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.56
+ * 
+ *
+ * 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 AddonSubscription
+ */
+export interface AddonSubscription {
+    /**
+     * 
+     * @type {string}
+     * @memberof AddonSubscription
+     */
+    plan_name?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AddonSubscription
+     */
+    usage?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AddonSubscription
+     */
+    limit?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AddonSubscription
+     */
+    is_payg?: boolean;
+}
+
+/**
+ * Check if a given object implements the AddonSubscription interface.
+ */
+export function instanceOfAddonSubscription(value: object): value is AddonSubscription {
+    return true;
+}
+
+export function AddonSubscriptionFromJSON(json: any): AddonSubscription {
+    return AddonSubscriptionFromJSONTyped(json, false);
+}
+
+export function AddonSubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddonSubscription {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'plan_name': json['plan_name'] == null ? undefined : json['plan_name'],
+        'usage': json['usage'] == null ? undefined : json['usage'],
+        'limit': json['limit'] == null ? undefined : json['limit'],
+        'is_payg': json['is_payg'] == null ? undefined : json['is_payg'],
+    };
+}
+
+export function AddonSubscriptionToJSON(json: any): AddonSubscription {
+    return AddonSubscriptionToJSONTyped(json, false);
+}
+
+export function AddonSubscriptionToJSONTyped(value?: AddonSubscription | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'plan_name': value['plan_name'],
+        'usage': value['usage'],
+        'limit': value['limit'],
+        'is_payg': value['is_payg'],
+    };
+}
+

package/src/models/AiVisionGeneralResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AnalyticsResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AnalyzeAiVisionGeneralRequest.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AnalyzeAiVisionGeneralRequestSource.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AppStorageErrorResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AppStorageGetResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/AppStorageSetErrorResponse.ts

@@ -4,7 +4,7 @@
  * Cloudinary API Proxy
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.2605.52
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).