@cloudinary/apps-api 2.2605.52 → 2.2605.56

package/dist/esm/apis/AssetManagementApi.d.ts

@@ -2,7 +2,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).
@@ -10,11 +10,15 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AddCollectionAssetsRequest, AddCollectionAssetsResponse, AssetHistoryResponse, AssetSearchResponse, AutocompleteResponse, Collection, CreateAssetMetadataFieldRequest, CreateCollectionRequest, CreateCollectionResponse, CreateFolderRequest, CreateFolderResponse, CreateMetadataFieldResponse, DeleteFolderResponse, DownloadAssetRequest, DownloadAssetResponse, DownloadCollectionResponse, ListAssetsByFolderResponse, ListBackreferencesResponse, ListCollectionsResponse, ListContextualMetadataFieldsResponse, ListMetadataFieldsResponse, ListSubfoldersResponse, ListTransformationsResponse, RemoveCollectionAssetsRequest, RemoveCollectionAssetsResponse, SearchCollectionsRequest, SearchCollectionsResponse, TemplateSearchResponse, UpdateAssetBackreferencesRequest, UpdateAssetMetadataRequest, UpdateAssetMetadataResponse, UpdateAssetTagsRequest, UpdateAssetTagsResponse, UpdateBackreferencesResponse, UpdateCollectionRequest, UpdateCollectionResponse } from '../models/index';
+import type { AddCollectionAssetsRequest, AddCollectionAssetsResponse, AddPortalCollectionsRequest, AssetHistoryResponse, AssetSearchResponse, AutocompleteResponse, Collection, CreateAssetMetadataFieldRequest, CreateCollectionRequest, CreateCollectionResponse, CreateFolderRequest, CreateFolderResponse, CreateMetadataFieldResponse, CreatePortalRequest, CreatePublicLinkRequest, CreateSavedSearchRequest, DeleteFolderResponse, DownloadAssetRequest, DownloadAssetResponse, DownloadCollectionResponse, GetAssetsLastDeliveryRequest, LastDeliveryResponse, ListAssetsByFolderResponse, ListBackreferencesResponse, ListCollectionsResponse, ListContextualMetadataFieldsResponse, ListMetadataFieldsResponse, ListPortalsResponse, ListPublicLinksResponse, ListSavedSearchesResponse, ListSubfoldersResponse, ListTransformationsResponse, Portal, PublicLinkResponse, RelatedAssetsResponse, RemoveCollectionAssetsRequest, RemoveCollectionAssetsResponse, RemovePortalCollectionsRequest, SavedSearch, SearchCollectionsRequest, SearchCollectionsResponse, TemplateSearchResponse, UpdateAssetBackreferencesRequest, UpdateAssetMetadataRequest, UpdateAssetMetadataResponse, UpdateAssetTagsRequest, UpdateAssetTagsResponse, UpdateBackreferencesResponse, UpdateCollectionRequest, UpdateCollectionResponse, UpdatePortalRequest, UpdatePublicLinkRequest, UpdateSavedSearchResponse } from '../models/index';
 export interface AssetManagementApiAddCollectionAssetsOperationRequest {
     collectionId: string;
     addCollectionAssetsRequest?: AddCollectionAssetsRequest;
 }
+export interface AssetManagementApiAddPortalCollectionsOperationRequest {
+    id: string;
+    addPortalCollectionsRequest?: AddPortalCollectionsRequest;
+}
 export interface AssetManagementApiAutocompleteAssetsRequest {
     term: string;
     resourceType?: AutocompleteAssetsResourceTypeEnum;
@@ -36,10 +40,32 @@ export interface AssetManagementApiCreateCollectionOperationRequest {
 export interface AssetManagementApiCreateFolderOperationRequest {
     createFolderRequest?: CreateFolderRequest;
 }
+export interface AssetManagementApiCreatePortalOperationRequest {
+    createPortalRequest?: CreatePortalRequest;
+}
+export interface AssetManagementApiCreatePublicLinkOperationRequest {
+    subjectType: string;
+    subjectId: string;
+    createPublicLinkRequest?: CreatePublicLinkRequest;
+}
+export interface AssetManagementApiCreateSavedSearchOperationRequest {
+    createSavedSearchRequest?: CreateSavedSearchRequest;
+}
 export interface AssetManagementApiDeleteFolderRequest {
     id: string;
     deleteResources?: boolean;
 }
+export interface AssetManagementApiDeletePortalRequest {
+    id: string;
+}
+export interface AssetManagementApiDeletePublicLinkRequest {
+    subjectType: string;
+    subjectId: string;
+    id: string;
+}
+export interface AssetManagementApiDeleteSavedSearchRequest {
+    id: string;
+}
 export interface AssetManagementApiDestroyCollectionRequest {
     collectionId: string;
 }
@@ -51,6 +77,9 @@ export interface AssetManagementApiDownloadCollectionRequest {
     targetPublicId?: string;
     redirect?: boolean | null;
 }
+export interface AssetManagementApiGetAssetsLastDeliveryOperationRequest {
+    getAssetsLastDeliveryRequest?: GetAssetsLastDeliveryRequest;
+}
 export interface AssetManagementApiListAssetBackreferencesRequest {
     assetId: string;
     system?: string;
@@ -81,6 +110,15 @@ export interface AssetManagementApiListCollectionsRequest {
     term?: string;
     ownerType?: string;
 }
+export interface AssetManagementApiListPublicLinksRequest {
+    subjectType: string;
+    subjectId: string;
+}
+export interface AssetManagementApiListRelatedAssetsRequest {
+    resourceType: string;
+    type: string;
+    publicId: string;
+}
 export interface AssetManagementApiListSubfoldersRequest {
     parentPath?: string;
     externalId?: string;
@@ -96,6 +134,10 @@ export interface AssetManagementApiRemoveCollectionAssetsOperationRequest {
     collectionId: string;
     removeCollectionAssetsRequest?: RemoveCollectionAssetsRequest;
 }
+export interface AssetManagementApiRemovePortalCollectionsOperationRequest {
+    id: string;
+    removePortalCollectionsRequest?: RemovePortalCollectionsRequest;
+}
 export interface AssetManagementApiSearchAssetsRequest {
     expression: string;
     maxResults?: number;
@@ -120,6 +162,12 @@ export interface AssetManagementApiShowCollectionRequest {
     nextCursor?: string;
     withMetadata?: boolean | null;
 }
+export interface AssetManagementApiShowPortalRequest {
+    id: string;
+}
+export interface AssetManagementApiShowSavedSearchRequest {
+    id: string;
+}
 export interface AssetManagementApiUpdateAssetBackreferencesOperationRequest {
     updateAssetBackreferencesRequest?: UpdateAssetBackreferencesRequest;
 }
@@ -134,6 +182,20 @@ export interface AssetManagementApiUpdateCollectionOperationRequest {
     collectionId: string;
     updateCollectionRequest?: UpdateCollectionRequest;
 }
+export interface AssetManagementApiUpdatePortalOperationRequest {
+    id: string;
+    updatePortalRequest?: UpdatePortalRequest;
+}
+export interface AssetManagementApiUpdatePublicLinkOperationRequest {
+    subjectType: string;
+    subjectId: string;
+    id: string;
+    updatePublicLinkRequest?: UpdatePublicLinkRequest;
+}
+export interface AssetManagementApiUpdateSavedSearchRequest {
+    id: string;
+    createSavedSearchRequest?: CreateSavedSearchRequest;
+}
 /**
  *
  */
@@ -148,6 +210,16 @@ export declare class AssetManagementApi extends runtime.BaseAPI {
      * Add assets to a collection
      */
     addCollectionAssets(requestParameters: AssetManagementApiAddCollectionAssetsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddCollectionAssetsResponse>;
+    /**
+     * Adds one or more collections to an existing portal by their external IDs.
+     * Add collections to a portal
+     */
+    addPortalCollectionsRaw(requestParameters: AssetManagementApiAddPortalCollectionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Portal>>;
+    /**
+     * Adds one or more collections to an existing portal by their external IDs.
+     * Add collections to a portal
+     */
+    addPortalCollections(requestParameters: AssetManagementApiAddPortalCollectionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Portal>;
     /**
      * Returns typeahead suggestions for a search term across multiple entity types. Each type param (assets, folders, tags, etc.) controls the max results returned for that category; omit a param to exclude that category.
      * Autocomplete across assets, folders, collections, tags, and metadata
@@ -188,6 +260,36 @@ export declare class AssetManagementApi extends runtime.BaseAPI {
      * Create a folder
      */
     createFolder(requestParameters?: AssetManagementApiCreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateFolderResponse>;
+    /**
+     * Creates a portal (branded share page), optionally pre-populated with collections via collection_ids.
+     * Create a portal
+     */
+    createPortalRaw(requestParameters: AssetManagementApiCreatePortalOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Portal>>;
+    /**
+     * Creates a portal (branded share page), optionally pre-populated with collections via collection_ids.
+     * Create a portal
+     */
+    createPortal(requestParameters?: AssetManagementApiCreatePortalOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Portal>;
+    /**
+     * Creates a public share link for the given entity (e.g. a collection), optionally time-limited via start_at/end_at. Anyone with the returned URL can view the shared content.
+     * Create a public link for an entity
+     */
+    createPublicLinkRaw(requestParameters: AssetManagementApiCreatePublicLinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PublicLinkResponse>>;
+    /**
+     * Creates a public share link for the given entity (e.g. a collection), optionally time-limited via start_at/end_at. Anyone with the returned URL can view the shared content.
+     * Create a public link for an entity
+     */
+    createPublicLink(requestParameters: AssetManagementApiCreatePublicLinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublicLinkResponse>;
+    /**
+     * Persists a named search definition (filters and query type), optionally shared with other users or groups.
+     * Create a saved search
+     */
+    createSavedSearchRaw(requestParameters: AssetManagementApiCreateSavedSearchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SavedSearch>>;
+    /**
+     * Persists a named search definition (filters and query type), optionally shared with other users or groups.
+     * Create a saved search
+     */
+    createSavedSearch(requestParameters?: AssetManagementApiCreateSavedSearchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavedSearch>;
     /**
      * Deletes a folder by its external ID. The upstream Console API rejects deletion when the folder still contains assets.
      * Delete a folder
@@ -198,6 +300,36 @@ export declare class AssetManagementApi extends runtime.BaseAPI {
      * Delete a folder
      */
     deleteFolder(requestParameters: AssetManagementApiDeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteFolderResponse>;
+    /**
+     * Deletes a portal. The collections included in the portal are not affected.
+     * Delete a portal
+     */
+    deletePortalRaw(requestParameters: AssetManagementApiDeletePortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Portal>>;
+    /**
+     * Deletes a portal. The collections included in the portal are not affected.
+     * Delete a portal
+     */
+    deletePortal(requestParameters: AssetManagementApiDeletePortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Portal>;
+    /**
+     * Deletes a public link. The shared URL stops working immediately; the underlying entity is not affected.
+     * Revoke a public link
+     */
+    deletePublicLinkRaw(requestParameters: AssetManagementApiDeletePublicLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Deletes a public link. The shared URL stops working immediately; the underlying entity is not affected.
+     * Revoke a public link
+     */
+    deletePublicLink(requestParameters: AssetManagementApiDeletePublicLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Deletes a saved search by ID. The assets matched by the search are not affected.
+     * Delete a saved search
+     */
+    deleteSavedSearchRaw(requestParameters: AssetManagementApiDeleteSavedSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SavedSearch>>;
+    /**
+     * Deletes a saved search by ID. The assets matched by the search are not affected.
+     * Delete a saved search
+     */
+    deleteSavedSearch(requestParameters: AssetManagementApiDeleteSavedSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavedSearch>;
     /**
      * Soft-deletes a collection. The collection\'s assets are not removed from the cloud. Caller must have write access.
      * Delete a collection
@@ -228,6 +360,16 @@ export declare class AssetManagementApi extends runtime.BaseAPI {
      * Download a collection as an archive
      */
     downloadCollection(requestParameters: AssetManagementApiDownloadCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DownloadCollectionResponse>;
+    /**
+     * Returns the most recent delivery (CDN access) date per asset for the given external IDs. Useful for delivery-recency checks such as cleanup or expiry flows.
+     * Get last delivery dates for assets
+     */
+    getAssetsLastDeliveryRaw(requestParameters: AssetManagementApiGetAssetsLastDeliveryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LastDeliveryResponse>>;
+    /**
+     * Returns the most recent delivery (CDN access) date per asset for the given external IDs. Useful for delivery-recency checks such as cleanup or expiry flows.
+     * Get last delivery dates for assets
+     */
+    getAssetsLastDelivery(requestParameters?: AssetManagementApiGetAssetsLastDeliveryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LastDeliveryResponse>;
     /**
      * Returns active backreference entries recorded on an asset. Optionally filter by system and/or tenant. Pass includeRemoved=true to include removed links. Context search matches ever-associated ref URIs; list reflects current link state.
      * List backreferences for an asset
@@ -288,6 +430,46 @@ export declare class AssetManagementApi extends runtime.BaseAPI {
      * List collections
      */
     listCollections(requestParameters?: AssetManagementApiListCollectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListCollectionsResponse>;
+    /**
+     * Returns all portals (branded share pages over collections) defined in the cloud.
+     * List portals
+     */
+    listPortalsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPortalsResponse>>;
+    /**
+     * Returns all portals (branded share pages over collections) defined in the cloud.
+     * List portals
+     */
+    listPortals(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListPortalsResponse>;
+    /**
+     * Returns all public share links created for the given entity. subject_type is the entity kind (e.g. collections) and subject_id its external ID.
+     * List public links of an entity
+     */
+    listPublicLinksRaw(requestParameters: AssetManagementApiListPublicLinksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPublicLinksResponse>>;
+    /**
+     * Returns all public share links created for the given entity. subject_type is the entity kind (e.g. collections) and subject_id its external ID.
+     * List public links of an entity
+     */
+    listPublicLinks(requestParameters: AssetManagementApiListPublicLinksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListPublicLinksResponse>;
+    /**
+     * Returns the list of assets related to a given asset (as configured via Cloudinary\'s Related Assets feature). Identifies the asset by the resource_type/type/public_id triple. Requires OAuth authentication.
+     * List related assets for an asset
+     */
+    listRelatedAssetsRaw(requestParameters: AssetManagementApiListRelatedAssetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RelatedAssetsResponse>>;
+    /**
+     * Returns the list of assets related to a given asset (as configured via Cloudinary\'s Related Assets feature). Identifies the asset by the resource_type/type/public_id triple. Requires OAuth authentication.
+     * List related assets for an asset
+     */
+    listRelatedAssets(requestParameters: AssetManagementApiListRelatedAssetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RelatedAssetsResponse>;
+    /**
+     * Returns all saved searches accessible to the caller, including their filters and sharing settings.
+     * List saved searches
+     */
+    listSavedSearchesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSavedSearchesResponse>>;
+    /**
+     * Returns all saved searches accessible to the caller, including their filters and sharing settings.
+     * List saved searches
+     */
+    listSavedSearches(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSavedSearchesResponse>;
     /**
      * Returns immediate subfolders of a given parent path or folder external ID, with pagination support.
      * List child folders
@@ -318,6 +500,16 @@ export declare class AssetManagementApi extends runtime.BaseAPI {
      * Remove assets from a collection
      */
     removeCollectionAssets(requestParameters: AssetManagementApiRemoveCollectionAssetsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RemoveCollectionAssetsResponse>;
+    /**
+     * Removes one or more collections from a portal. The collections themselves are not deleted.
+     * Remove collections from a portal
+     */
+    removePortalCollectionsRaw(requestParameters: AssetManagementApiRemovePortalCollectionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Portal>>;
+    /**
+     * Removes one or more collections from a portal. The collections themselves are not deleted.
+     * Remove collections from a portal
+     */
+    removePortalCollections(requestParameters: AssetManagementApiRemovePortalCollectionsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Portal>;
     /**
      * Full-text and field-scoped search over all assets in the cloud. Supports pagination via next_cursor, sort ordering, backend selection (relational, elastic, CLIP), and field aggregations.
      * Search assets using Cloudinary expression language
@@ -358,6 +550,26 @@ export declare class AssetManagementApi extends runtime.BaseAPI {
      * Get a single collection with its assets
      */
     showCollection(requestParameters: AssetManagementApiShowCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Collection>;
+    /**
+     * Returns a single portal by ID, including its included collection IDs and appearance settings.
+     * Get a portal
+     */
+    showPortalRaw(requestParameters: AssetManagementApiShowPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Portal>>;
+    /**
+     * Returns a single portal by ID, including its included collection IDs and appearance settings.
+     * Get a portal
+     */
+    showPortal(requestParameters: AssetManagementApiShowPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Portal>;
+    /**
+     * Returns a single saved search by ID, including its filters and sharing settings.
+     * Get a saved search
+     */
+    showSavedSearchRaw(requestParameters: AssetManagementApiShowSavedSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SavedSearch>>;
+    /**
+     * Returns a single saved search by ID, including its filters and sharing settings.
+     * Get a saved search
+     */
+    showSavedSearch(requestParameters: AssetManagementApiShowSavedSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavedSearch>;
     /**
      * Links or unlinks one or more assets to/from a location in an external system (e.g. a CMS page or design file). Each backreference is stored as versioned history in the asset\'s cld_backreference context.
      * Create, update, or remove asset backreferences
@@ -398,6 +610,36 @@ export declare class AssetManagementApi extends runtime.BaseAPI {
      * Update a collection
      */
     updateCollection(requestParameters: AssetManagementApiUpdateCollectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateCollectionResponse>;
+    /**
+     * Updates portal properties such as title, privacy, status, theme, or the full set of included collections.
+     * Update a portal
+     */
+    updatePortalRaw(requestParameters: AssetManagementApiUpdatePortalOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Portal>>;
+    /**
+     * Updates portal properties such as title, privacy, status, theme, or the full set of included collections.
+     * Update a portal
+     */
+    updatePortal(requestParameters: AssetManagementApiUpdatePortalOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Portal>;
+    /**
+     * Updates a public link\'s name, validity window (start_at/end_at), or original-download policy.
+     * Update a public link
+     */
+    updatePublicLinkRaw(requestParameters: AssetManagementApiUpdatePublicLinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PublicLinkResponse>>;
+    /**
+     * Updates a public link\'s name, validity window (start_at/end_at), or original-download policy.
+     * Update a public link
+     */
+    updatePublicLink(requestParameters: AssetManagementApiUpdatePublicLinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublicLinkResponse>;
+    /**
+     * Updates a saved search\'s name, filters, query type, or sharing. Caller must have permission on the saved search.
+     * Update a saved search
+     */
+    updateSavedSearchRaw(requestParameters: AssetManagementApiUpdateSavedSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateSavedSearchResponse>>;
+    /**
+     * Updates a saved search\'s name, filters, query type, or sharing. Caller must have permission on the saved search.
+     * Update a saved search
+     */
+    updateSavedSearch(requestParameters: AssetManagementApiUpdateSavedSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateSavedSearchResponse>;
 }
 /**
  * @export