@cloudinary/apps-api 2.2605.52 → 2.2605.56

package/docs/CreatePortalRequest.md

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

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

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

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

@@ -0,0 +1,36 @@
+
+# DashboardDataResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | { [key: string]: any; }
+`items` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { DashboardDataResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "items": null,
+} satisfies DashboardDataResponse
+
+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 DashboardDataResponse
+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/GetAssetsLastDeliveryRequest.md

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

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

@@ -0,0 +1,36 @@
+
+# ListPortalsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`portals` | [Array<Portal>](Portal.md)
+`meta` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { ListPortalsResponse } from '@cloudinary/apps-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "portals": null,
+  "meta": null,
+} satisfies ListPortalsResponse
+
+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 ListPortalsResponse
+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/ListPublicLinksResponse.md

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

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

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