@cloudinary/apps-api 2.2605.49

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

@@ -0,0 +1,206 @@
+/**
+ * Cloudinary API Proxy
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2605.49
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AnalyticsResponse, AppStorageGetResponse, AppStorageSetResponse, AuthCredentialsResponse, CreateNamespaceTokenRequest, Customer, DamAppResponse, DeployApp200Response, ListCustomersResponse, NamespaceTokenCreateResponse, RefreshTokenResponse, SetAppStorageValueRequest, TrackAnalyticsEventRequest, UpdateAppRequest, ValidateTokenResponse } from '../models/index';
+export interface PlatformApiCreateNamespaceTokenOperationRequest {
+    createNamespaceTokenRequest?: CreateNamespaceTokenRequest;
+}
+export interface PlatformApiDeployAppRequest {
+    appId: string;
+    bundle: Blob;
+    env: string;
+    version: string;
+    updateAppUrl?: string;
+}
+export interface PlatformApiGetAppRequest {
+    appId: string;
+}
+export interface PlatformApiGetAppStorageValueRequest {
+    namespaceToken: string;
+    level: GetAppStorageValueLevelEnum;
+    key: string;
+}
+export interface PlatformApiGetCustomerByCloudRequest {
+    cloudName: string;
+}
+export interface PlatformApiListCustomersRequest {
+    nameContains?: string;
+    cloudName?: string;
+    product?: string;
+    sortBy?: string;
+    sortOrder?: string;
+}
+export interface PlatformApiRefreshCloudinaryTokenRequest {
+    type: RefreshCloudinaryTokenTypeEnum;
+}
+export interface PlatformApiSetAppStorageValueOperationRequest {
+    namespaceToken: string;
+    level: SetAppStorageValueOperationLevelEnum;
+    key: string;
+    setAppStorageValueRequest?: SetAppStorageValueRequest;
+}
+export interface PlatformApiTrackAnalyticsEventOperationRequest {
+    trackAnalyticsEventRequest?: TrackAnalyticsEventRequest;
+}
+export interface PlatformApiUpdateAppOperationRequest {
+    appId: string;
+    updateAppRequest?: UpdateAppRequest;
+}
+/**
+ *
+ */
+export declare class PlatformApi extends runtime.BaseAPI {
+    /**
+     * Mints an encrypted namespace token for app storage. Pass the token as the namespace_token path segment on get/set endpoints. Requires the mint secret.
+     * Create a namespace token for shared app storage
+     */
+    createNamespaceTokenRaw(requestParameters: PlatformApiCreateNamespaceTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamespaceTokenCreateResponse>>;
+    /**
+     * Mints an encrypted namespace token for app storage. Pass the token as the namespace_token path segment on get/set endpoints. Requires the mint secret.
+     * Create a namespace token for shared app storage
+     */
+    createNamespaceToken(requestParameters?: PlatformApiCreateNamespaceTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamespaceTokenCreateResponse>;
+    /**
+     * deploy a DAM app to https://dam.cloudinary.app/{app_id}/{env}/{version}/ and optionally updates the app\'s appUrl and manifest from cloudinary.app.json in the bundle.
+     * Deploy a DAM app bundle
+     */
+    deployAppRaw(requestParameters: PlatformApiDeployAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeployApp200Response>>;
+    /**
+     * deploy a DAM app to https://dam.cloudinary.app/{app_id}/{env}/{version}/ and optionally updates the app\'s appUrl and manifest from cloudinary.app.json in the bundle.
+     * Deploy a DAM app bundle
+     */
+    deployApp(requestParameters: PlatformApiDeployAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeployApp200Response>;
+    /**
+     * Returns custom action metadata for a DAM app by ID from the Custom Actions service.
+     * Get a DAM app
+     */
+    getAppRaw(requestParameters: PlatformApiGetAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DamAppResponse>>;
+    /**
+     * Returns custom action metadata for a DAM app by ID from the Custom Actions service.
+     * Get a DAM app
+     */
+    getApp(requestParameters: PlatformApiGetAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DamAppResponse>;
+    /**
+     * Retrieves a previously stored JSON value by key. Storage is namespaced by a validated namespace_token path segment. Personal level is scoped to the user; shared level is scoped to the customer (cloud). Requires OAuth authentication.
+     * Get a value from app persistent storage
+     */
+    getAppStorageValueRaw(requestParameters: PlatformApiGetAppStorageValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AppStorageGetResponse>>;
+    /**
+     * Retrieves a previously stored JSON value by key. Storage is namespaced by a validated namespace_token path segment. Personal level is scoped to the user; shared level is scoped to the customer (cloud). Requires OAuth authentication.
+     * Get a value from app persistent storage
+     */
+    getAppStorageValue(requestParameters: PlatformApiGetAppStorageValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AppStorageGetResponse>;
+    /**
+     * Returns the authenticated user profile and associated customer (cloud) record. Use to confirm session identity and cloud context.
+     * Get current user and cloud identity
+     */
+    getAuthCredentialsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthCredentialsResponse>>;
+    /**
+     * Returns the authenticated user profile and associated customer (cloud) record. Use to confirm session identity and cloud context.
+     * Get current user and cloud identity
+     */
+    getAuthCredentials(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthCredentialsResponse>;
+    /**
+     * Looks up a specific customer record by its Cloudinary cloud_name. Returns the full customer object or null if not found.
+     * Get a customer by cloud name
+     */
+    getCustomerByCloudRaw(requestParameters: PlatformApiGetCustomerByCloudRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Customer>>;
+    /**
+     * Looks up a specific customer record by its Cloudinary cloud_name. Returns the full customer object or null if not found.
+     * Get a customer by cloud name
+     */
+    getCustomerByCloud(requestParameters: PlatformApiGetCustomerByCloudRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Customer>;
+    /**
+     * 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
+     */
+    listCustomersRaw(requestParameters: PlatformApiListCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListCustomersResponse>>;
+    /**
+     * 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
+     */
+    listCustomers(requestParameters?: PlatformApiListCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListCustomersResponse>;
+    /**
+     * 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
+     */
+    refreshCloudinaryTokenRaw(requestParameters: PlatformApiRefreshCloudinaryTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RefreshTokenResponse>>;
+    /**
+     * 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
+     */
+    refreshCloudinaryToken(requestParameters: PlatformApiRefreshCloudinaryTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RefreshTokenResponse>;
+    /**
+     * Stores an arbitrary JSON value under the specified key. Storage is namespaced by a validated namespace_token path segment. Personal level: any user can write. Shared level: only admins (master_admin role) can write. Requires OAuth authentication.
+     * Set a value in app persistent storage
+     */
+    setAppStorageValueRaw(requestParameters: PlatformApiSetAppStorageValueOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AppStorageSetResponse>>;
+    /**
+     * Stores an arbitrary JSON value under the specified key. Storage is namespaced by a validated namespace_token path segment. Personal level: any user can write. Shared level: only admins (master_admin role) can write. Requires OAuth authentication.
+     * Set a value in app persistent storage
+     */
+    setAppStorageValue(requestParameters: PlatformApiSetAppStorageValueOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AppStorageSetResponse>;
+    /**
+     * Accepts a batch of client-side analytics events for server-side processing and forwarding. Each event is an opaque JSON object; the gateway enriches events with IP and user-agent before logging.
+     * Submit analytics events
+     */
+    trackAnalyticsEventRaw(requestParameters: PlatformApiTrackAnalyticsEventOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnalyticsResponse>>;
+    /**
+     * Accepts a batch of client-side analytics events for server-side processing and forwarding. Each event is an opaque JSON object; the gateway enriches events with IP and user-agent before logging.
+     * Submit analytics events
+     */
+    trackAnalyticsEvent(requestParameters?: PlatformApiTrackAnalyticsEventOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnalyticsResponse>;
+    /**
+     * Updates app configuration fields for a DAM app. Currently supports appUrl and manifest.
+     * Update DAM app configuration
+     */
+    updateAppRaw(requestParameters: PlatformApiUpdateAppOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DamAppResponse>>;
+    /**
+     * Updates app configuration fields for a DAM app. Currently supports appUrl and manifest.
+     * Update DAM app configuration
+     */
+    updateApp(requestParameters: PlatformApiUpdateAppOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DamAppResponse>;
+    /**
+     * Verifies that the provided API gateway bearer token is well-formed, correctly signed, and not expired. Returns {ok: 1} on success or a 401 error with a descriptive message on failure.
+     * Validate a gateway token
+     */
+    validateTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ValidateTokenResponse>>;
+    /**
+     * Verifies that the provided API gateway bearer token is well-formed, correctly signed, and not expired. Returns {ok: 1} on success or a 401 error with a descriptive message on failure.
+     * Validate a gateway token
+     */
+    validateToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ValidateTokenResponse>;
+}
+/**
+ * @export
+ */
+export declare const GetAppStorageValueLevelEnum: {
+    readonly Personal: "personal";
+    readonly Shared: "shared";
+};
+export type GetAppStorageValueLevelEnum = typeof GetAppStorageValueLevelEnum[keyof typeof GetAppStorageValueLevelEnum];
+/**
+ * @export
+ */
+export declare const RefreshCloudinaryTokenTypeEnum: {
+    readonly Oauth: "oauth";
+    readonly Console: "console";
+};
+export type RefreshCloudinaryTokenTypeEnum = typeof RefreshCloudinaryTokenTypeEnum[keyof typeof RefreshCloudinaryTokenTypeEnum];
+/**
+ * @export
+ */
+export declare const SetAppStorageValueOperationLevelEnum: {
+    readonly Personal: "personal";
+    readonly Shared: "shared";
+};
+export type SetAppStorageValueOperationLevelEnum = typeof SetAppStorageValueOperationLevelEnum[keyof typeof SetAppStorageValueOperationLevelEnum];