frameio 2.0.3 → 3.0.0

package/dist/esm/api/resources/shares/client/Client.d.mts

@@ -1,41 +1,24 @@
-import * as environments from "../../../../environments.mjs";
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as Frameio from "../../../index.mjs";
-export declare namespace Shares {
-    interface Options {
-        environment?: core.Supplier<environments.FrameioEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        token: core.Supplier<core.BearerToken>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional query string parameters to include in the request. */
-        queryParams?: Record<string, unknown>;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+export declare namespace SharesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
     }
 }
 /**
  * Manage Shares and related operations.
  */
-export declare class Shares {
-    protected readonly _options: Shares.Options;
-    constructor(_options: Shares.Options);
+export declare class SharesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<SharesClient.Options>;
+    constructor(options: SharesClient.Options);
     /**
      * Show a single Share. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} shareId -
-     * @param {Shares.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} share_id
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -48,14 +31,14 @@ export declare class Shares {
      * @example
      *     await client.shares.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
      */
-    show(accountId: Frameio.Uuid, shareId: Frameio.Uuid, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
+    show(account_id: Frameio.Uuid, share_id: Frameio.Uuid, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
     private __show;
     /**
      * Delete a share. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} shareId -
-     * @param {Shares.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} share_id
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -68,15 +51,15 @@ export declare class Shares {
      * @example
      *     await client.shares.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
      */
-    delete(accountId: Frameio.Uuid, shareId: Frameio.Uuid, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<void>;
+    delete(account_id: Frameio.Uuid, share_id: Frameio.Uuid, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
      * Update share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} shareId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} share_id
      * @param {Frameio.UpdateShareParams} request
-     * @param {Shares.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -98,15 +81,15 @@ export declare class Shares {
      *         }
      *     })
      */
-    update(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request: Frameio.UpdateShareParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
+    update(account_id: Frameio.Uuid, share_id: Frameio.Uuid, request: Frameio.UpdateShareParams, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
     private __update;
     /**
      * List share reviewers. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} shareId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} share_id
      * @param {Frameio.SharesListReviewersRequest} request
-     * @param {Shares.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -123,8 +106,7 @@ export declare class Shares {
      *         include_total_count: false
      *     })
      */
-    listReviewers(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request?: Frameio.SharesListReviewersRequest, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.ShareReviewersResponse>;
-    private __listReviewers;
+    listReviewers(account_id: Frameio.Uuid, share_id: Frameio.Uuid, _request?: Frameio.SharesListReviewersRequest, requestOptions?: SharesClient.RequestOptions): Promise<core.Page<Frameio.User, Frameio.ShareReviewersResponse>>;
     /**
      * Add reviewers to secure share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
      * <br/>
@@ -133,10 +115,10 @@ export declare class Shares {
      * `email` is the only identifier able to add reviewers to a Share who don't have a Frame account member on the account where the Share belongs.
      * <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} shareId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} share_id
      * @param {Frameio.AddReviewersToShareParams} request
-     * @param {Shares.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -156,7 +138,7 @@ export declare class Shares {
      *         }
      *     })
      */
-    addReviewers(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request: Frameio.AddReviewersToShareParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<void>;
+    addReviewers(account_id: Frameio.Uuid, share_id: Frameio.Uuid, request: Frameio.AddReviewersToShareParams, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<void>;
     private __addReviewers;
     /**
      * Removes reviewers from secure Share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
@@ -164,10 +146,10 @@ export declare class Shares {
      * A request can only include one identifier type parameter.
      * <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} shareId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} share_id
      * @param {Frameio.RemoveReviewerParams} request
-     * @param {Shares.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -186,15 +168,15 @@ export declare class Shares {
      *         }
      *     })
      */
-    removeReviewers(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request: Frameio.RemoveReviewerParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<void>;
+    removeReviewers(account_id: Frameio.Uuid, share_id: Frameio.Uuid, request: Frameio.RemoveReviewerParams, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<void>;
     private __removeReviewers;
     /**
      * Remove an asset currently in the share from that share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} shareId -
-     * @param {Frameio.Uuid} assetId -
-     * @param {Shares.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} share_id
+     * @param {Frameio.Uuid} asset_id
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -207,15 +189,15 @@ export declare class Shares {
      * @example
      *     await client.shares.removeAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
      */
-    removeAsset(accountId: Frameio.Uuid, shareId: Frameio.Uuid, assetId: Frameio.Uuid, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.RemoveAssetResponse>;
+    removeAsset(account_id: Frameio.Uuid, share_id: Frameio.Uuid, asset_id: Frameio.Uuid, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<Frameio.RemoveAssetResponse>;
     private __removeAsset;
     /**
      * Add new asset share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} shareId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} share_id
      * @param {Frameio.AddAssetParams} request
-     * @param {Shares.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -232,15 +214,15 @@ export declare class Shares {
      *         }
      *     })
      */
-    addAsset(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request: Frameio.AddAssetParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.AddAssetResponse>;
+    addAsset(account_id: Frameio.Uuid, share_id: Frameio.Uuid, request: Frameio.AddAssetParams, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<Frameio.AddAssetResponse>;
     private __addAsset;
     /**
      * List shares on a project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} projectId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} project_id
      * @param {Frameio.SharesIndexRequest} request
-     * @param {Shares.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -257,15 +239,14 @@ export declare class Shares {
      *         include_total_count: false
      *     })
      */
-    index(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request?: Frameio.SharesIndexRequest, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.SharesResponse>;
-    private __index;
+    index(account_id: Frameio.Uuid, project_id: Frameio.Uuid, _request?: Frameio.SharesIndexRequest, requestOptions?: SharesClient.RequestOptions): Promise<core.Page<Frameio.Share, Frameio.SharesResponse>>;
     /**
      * Create share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} projectId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} project_id
      * @param {Frameio.CreateShareParams} request
-     * @param {Shares.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {SharesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -288,7 +269,6 @@ export declare class Shares {
      *         }
      *     })
      */
-    create(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request: Frameio.CreateShareParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
+    create(account_id: Frameio.Uuid, project_id: Frameio.Uuid, request: Frameio.CreateShareParams, requestOptions?: SharesClient.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
     private __create;
-    protected _getAuthorizationHeader(): Promise<string>;
 }