@cloudinary/apps-api 2.2605.54 → 2.2605.56

package/docs/AddonSubscription.md

@@ -0,0 +1,40 @@
+
+# AddonSubscription
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`plan_name` | string
+`usage` | number
+`limit` | number
+`is_payg` | boolean
+
+## Example
+
+```typescript
+import type { AddonSubscription } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "plan_name": null,
+  "usage": null,
+  "limit": null,
+  "is_payg": null,
+} satisfies AddonSubscription
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AddonSubscription
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListAddonsResponse.md

@@ -0,0 +1,34 @@
+
+# ListAddonsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`addons` | [Array<Addon>](Addon.md)
+
+## Example
+
+```typescript
+import type { ListAddonsResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "addons": null,
+} satisfies ListAddonsResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListAddonsResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PlatformApi.md

@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost*
 | [**getAuthCredentials**](PlatformApi.md#getauthcredentials) | **GET** /v2605/platform/auth/credentials | Get current user and cloud identity |
 | [**getCustomerByCloud**](PlatformApi.md#getcustomerbycloud) | **GET** /v2605/platform/customers/by-cloud/{cloud_name} | Get a customer by cloud name |
 | [**getDashboardData**](PlatformApi.md#getdashboarddata) | **GET** /v2605/platform/reports/dashboard/{variant} | Get dashboard report data |
+| [**listBillingAddons**](PlatformApi.md#listbillingaddons) | **GET** /v2605/platform/billing/addons | List billing addons |
 | [**listCustomers**](PlatformApi.md#listcustomers) | **GET** /v2605/platform/customers | List customers (clouds) accessible to the user |
 | [**listUsers**](PlatformApi.md#listusers) | **GET** /v2605/platform/users | List users |
 | [**refreshCloudinaryToken**](PlatformApi.md#refreshcloudinarytoken) | **GET** /v2605/platform/auth/tokens/cloudinary/{type}/refresh | Refresh a Cloudinary token |
@@ -554,6 +555,70 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## listBillingAddons
+
+> ListAddonsResponse listBillingAddons()
+
+List billing addons
+
+Returns all billable addons (features) from Multi-Product Billing for the authenticated account.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlatformApi,
+} from '@cloudinary/apps-api';
+import type { ListBillingAddonsRequest } from '@cloudinary/apps-api';
+
+async function example() {
+  console.log("🚀 Testing @cloudinary/apps-api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new PlatformApi(config);
+
+  try {
+    const data = await api.listBillingAddons();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListAddonsResponse**](ListAddonsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful operation |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## listCustomers
 
 > ListCustomersResponse listCustomers(nameContains, cloudName, product, sortBy, sortOrder)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudinary/apps-api",
-  "version": "2.2605.54",
+  "version": "2.2605.56",
   "description": "OpenAPI client for @cloudinary/apps-api",
   "author": "OpenAPI-Generator",
   "main": "./dist/index.js",

package/src/apis/AssetManagementApi.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.54
+ * 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/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.54
+ * 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.54
+ * 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.54
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,6 +32,7 @@ import type {
   ErrorResponse,
   ErrorWithMessageResponse,
   ForbiddenResponse,
+  ListAddonsResponse,
   ListCustomersResponse,
   ListUsersResponse,
   NamespaceTokenCreateErrorResponse,
@@ -78,6 +79,8 @@ import {
     ErrorWithMessageResponseToJSON,
     ForbiddenResponseFromJSON,
     ForbiddenResponseToJSON,
+    ListAddonsResponseFromJSON,
+    ListAddonsResponseToJSON,
     ListCustomersResponseFromJSON,
     ListCustomersResponseToJSON,
     ListUsersResponseFromJSON,
@@ -582,6 +585,45 @@ export class PlatformApi extends runtime.BaseAPI {
         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

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.54
+ * 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.54
+ * 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.54
+ * 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.54
+ * 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

@@ -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.54
+ * 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/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.54
+ * 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.54
+ * 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.54
+ * 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.54
+ * 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.54
+ * 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.54
+ * 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.54
+ * 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/AppStorageSetResponse.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.54
+ * 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/Asset.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.54
+ * 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/AssetHistoryResponse.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.54
+ * 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/AssetHistoryResponseAssetHistoryInner.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.54
+ * 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/AssetLastDelivery.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.54
+ * The version of the OpenAPI document: 2.2605.56
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).