@cloudinary/apps-api 2.2605.52 → 2.2605.56

package/docs/PlatformApi.md

@@ -10,7 +10,10 @@ All URIs are relative to *http://localhost*
 | [**getAppStorageValue**](PlatformApi.md#getappstoragevalue) | **GET** /v2605/platform/apps/storage/{namespace_token}/{level}/{key} | Get a value from app persistent storage |
 | [**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 |
 | [**setAppStorageValue**](PlatformApi.md#setappstoragevalueoperation) | **PUT** /v2605/platform/apps/storage/{namespace_token}/{level}/{key} | Set a value in app persistent storage |
 | [**trackAnalyticsEvent**](PlatformApi.md#trackanalyticseventoperation) | **POST** /v2605/platform/analytics | Submit analytics events |
@@ -465,6 +468,157 @@ 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)
 
 
+## getDashboardData
+
+> DashboardDataResponse getDashboardData(variant, timespan, maxResults, sortBy, filters, only)
+
+Get dashboard report data
+
+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.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlatformApi,
+} from '@cloudinary/apps-api';
+import type { GetDashboardDataRequest } 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);
+
+  const body = {
+    // string | Dashboard data variant to fetch
+    variant: variant_example,
+    // string | Time range for the data (optional)
+    timespan: timespan_example,
+    // number | Maximum number of items (optional)
+    maxResults: 8.14,
+    // string | Sort field (optional)
+    sortBy: sortBy_example,
+    // string | Serialized filters (optional)
+    filters: filters_example,
+    // string | Trim response attributes (optional)
+    only: only_example,
+  } satisfies GetDashboardDataRequest;
+
+  try {
+    const data = await api.getDashboardData(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **variant** | `string` | Dashboard data variant to fetch | [Defaults to `undefined`] |
+| **timespan** | `string` | Time range for the data | [Optional] [Defaults to `undefined`] |
+| **maxResults** | `number` | Maximum number of items | [Optional] [Defaults to `undefined`] |
+| **sortBy** | `string` | Sort field | [Optional] [Defaults to `undefined`] |
+| **filters** | `string` | Serialized filters | [Optional] [Defaults to `undefined`] |
+| **only** | `string` | Trim response attributes | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DashboardDataResponse**](DashboardDataResponse.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)
+
+
+## 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)
@@ -548,6 +702,90 @@ 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)
 
 
+## listUsers
+
+> ListUsersResponse listUsers(page, pageSize, sortBy, sortOrder, withDeleted)
+
+List users
+
+Returns the users of the product environment with pagination and sorting. Useful for resolving user identities (e.g. in asset history) and adoption reporting.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlatformApi,
+} from '@cloudinary/apps-api';
+import type { ListUsersRequest } 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);
+
+  const body = {
+    // number | Page number (optional)
+    page: 8.14,
+    // number | Results per page (optional)
+    pageSize: 8.14,
+    // string | Sort field (optional)
+    sortBy: sortBy_example,
+    // string | Sort direction (asc/desc) (optional)
+    sortOrder: sortOrder_example,
+    // boolean | Include deleted users (optional)
+    withDeleted: true,
+  } satisfies ListUsersRequest;
+
+  try {
+    const data = await api.listUsers(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` | Page number | [Optional] [Defaults to `undefined`] |
+| **pageSize** | `number` | Results per page | [Optional] [Defaults to `undefined`] |
+| **sortBy** | `string` | Sort field | [Optional] [Defaults to `undefined`] |
+| **sortOrder** | `string` | Sort direction (asc/desc) | [Optional] [Defaults to `undefined`] |
+| **withDeleted** | `boolean` | Include deleted users | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListUsersResponse**](ListUsersResponse.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)
+
+
 ## refreshCloudinaryToken
 
 > RefreshTokenResponse refreshCloudinaryToken(type)

package/docs/Portal.md

@@ -0,0 +1,64 @@
+
+# Portal
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`privacy` | string
+`title` | string
+`description` | string
+`logo` | any
+`cover` | string
+`theme` | Array<string>
+`delivery_name` | string
+`collection_ids` | Array<string>
+`prevent_download_original` | boolean
+`shared_preset_ids` | Array<string>
+`user_id` | string
+`user_external_id` | string
+`created_at` | string
+`updated_at` | string
+
+## Example
+
+```typescript
+import type { Portal } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "privacy": null,
+  "title": null,
+  "description": null,
+  "logo": null,
+  "cover": null,
+  "theme": null,
+  "delivery_name": null,
+  "collection_ids": null,
+  "prevent_download_original": null,
+  "shared_preset_ids": null,
+  "user_id": null,
+  "user_external_id": null,
+  "created_at": null,
+  "updated_at": null,
+} satisfies Portal
+
+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 Portal
+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/PublicLink.md

@@ -0,0 +1,46 @@
+
+# PublicLink
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`url` | string
+`name` | string
+`start_at` | string
+`end_at` | string
+`prevent_download_original` | boolean
+`shared_preset_ids` | Array<string>
+
+## Example
+
+```typescript
+import type { PublicLink } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "url": null,
+  "name": null,
+  "start_at": null,
+  "end_at": null,
+  "prevent_download_original": null,
+  "shared_preset_ids": null,
+} satisfies PublicLink
+
+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 PublicLink
+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/PublicLinkResponse.md

@@ -0,0 +1,34 @@
+
+# PublicLinkResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`media_library_public_link` | [PublicLink](PublicLink.md)
+
+## Example
+
+```typescript
+import type { PublicLinkResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "media_library_public_link": null,
+} satisfies PublicLinkResponse
+
+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 PublicLinkResponse
+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/RelatedAsset.md

@@ -0,0 +1,44 @@
+
+# RelatedAsset
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`asset_id` | string
+`public_id` | string
+`resource_type` | string
+`type` | string
+`status` | string
+`moderation_status` | string
+
+## Example
+
+```typescript
+import type { RelatedAsset } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "asset_id": null,
+  "public_id": null,
+  "resource_type": null,
+  "type": null,
+  "status": null,
+  "moderation_status": null,
+} satisfies RelatedAsset
+
+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 RelatedAsset
+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/RelatedAssetsResponse.md

@@ -0,0 +1,34 @@
+
+# RelatedAssetsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`related_assets` | [Array<RelatedAsset>](RelatedAsset.md)
+
+## Example
+
+```typescript
+import type { RelatedAssetsResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "related_assets": null,
+} satisfies RelatedAssetsResponse
+
+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 RelatedAssetsResponse
+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/RemovePortalCollectionsRequest.md

@@ -0,0 +1,34 @@
+
+# RemovePortalCollectionsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`collection_ids` | Array<string>
+
+## Example
+
+```typescript
+import type { RemovePortalCollectionsRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "collection_ids": null,
+} satisfies RemovePortalCollectionsRequest
+
+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 RemovePortalCollectionsRequest
+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/SavedSearch.md

@@ -0,0 +1,52 @@
+
+# SavedSearch
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`query_type` | string
+`filters` | { [key: string]: any; }
+`info` | string
+`created_at` | string
+`updated_at` | string
+`owner_external_id` | string
+`permissions` | [Array<SavedSearchPermission>](SavedSearchPermission.md)
+`shared_with` | [Array<SavedSearchPermission>](SavedSearchPermission.md)
+
+## Example
+
+```typescript
+import type { SavedSearch } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "query_type": null,
+  "filters": null,
+  "info": null,
+  "created_at": null,
+  "updated_at": null,
+  "owner_external_id": null,
+  "permissions": null,
+  "shared_with": null,
+} satisfies SavedSearch
+
+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 SavedSearch
+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/SavedSearchPermission.md

@@ -0,0 +1,36 @@
+
+# SavedSearchPermission
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`external_id` | string
+`permission` | string
+
+## Example
+
+```typescript
+import type { SavedSearchPermission } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "external_id": null,
+  "permission": null,
+} satisfies SavedSearchPermission
+
+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 SavedSearchPermission
+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/UpdatePortalRequest.md

@@ -0,0 +1,50 @@
+
+# UpdatePortalRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`title` | string
+`description` | string
+`portal_url` | string
+`status` | string
+`privacy` | string
+`cover` | string
+`theme` | Array<string>
+`collection_ids` | Array<string>
+`prevent_download_original` | boolean
+
+## Example
+
+```typescript
+import type { UpdatePortalRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "title": null,
+  "description": null,
+  "portal_url": null,
+  "status": null,
+  "privacy": null,
+  "cover": null,
+  "theme": null,
+  "collection_ids": null,
+  "prevent_download_original": null,
+} satisfies UpdatePortalRequest
+
+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 UpdatePortalRequest
+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/UpdatePublicLinkRequest.md

@@ -0,0 +1,40 @@
+
+# UpdatePublicLinkRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`start_at` | string
+`end_at` | string
+`prevent_download_original` | boolean
+
+## Example
+
+```typescript
+import type { UpdatePublicLinkRequest } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "start_at": null,
+  "end_at": null,
+  "prevent_download_original": null,
+} satisfies UpdatePublicLinkRequest
+
+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 UpdatePublicLinkRequest
+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)
+
+