frameio 2.0.2 → 3.0.0

package/dist/cjs/api/resources/files/client/index.d.ts

@@ -1,2 +1 @@
-export {};
 export * from "./requests/index.js";

package/dist/cjs/api/resources/files/client/requests/FileCopyParams.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../../../../index.js";
+import type * as Frameio from "../../../../index.js";
 /**
  * @example
  *     {
@@ -19,6 +19,6 @@ export interface FileCopyParams {
 export declare namespace FileCopyParams {
     interface Data {
         /** Destination folder ID. Defaults to file parent ID. */
-        parent_id?: string;
+        parent_id?: string | undefined;
     }
 }

package/dist/cjs/api/resources/files/client/requests/FileCreateParams.d.ts

@@ -23,6 +23,6 @@ export declare namespace FileCreateParams {
         /** File name */
         name: string;
         /** Source URL - Initiates a remote upload from the given URL when present */
-        source_url?: string;
+        source_url?: string | undefined;
     }
 }

package/dist/cjs/api/resources/files/client/requests/FileMoveParams.d.ts

@@ -12,6 +12,6 @@ export interface FileMoveParams {
 export declare namespace FileMoveParams {
     interface Data {
         /** Destination folder or version stack ID */
-        parent_id?: string;
+        parent_id?: string | undefined;
     }
 }

package/dist/cjs/api/resources/files/client/requests/FileUpdateParams.d.ts

@@ -12,6 +12,6 @@ export interface FileUpdateParams {
 export declare namespace FileUpdateParams {
     interface Data {
         /** File name */
-        name?: string;
+        name?: string | undefined;
     }
 }

package/dist/cjs/api/resources/files/client/requests/FilesListRequest.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../../../../index.js";
+import type * as Frameio from "../../../../index.js";
 /**
  * @example
  *     {
@@ -10,7 +10,6 @@ import * as Frameio from "../../../../index.js";
  *     }
  */
 export interface FilesListRequest {
-    /** */
     include?: Frameio.FilesListRequestInclude;
     /** Sort files by query params */
     sort?: Frameio.FilesListRequestSort;
@@ -20,8 +19,6 @@ export interface FilesListRequest {
      * NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
      */
     after?: Frameio.RequestAfterOpaqueCursor | undefined;
-    /** */
     page_size?: Frameio.RequestPageSize;
-    /** */
     include_total_count?: Frameio.IncludeTotalCount;
 }

package/dist/cjs/api/resources/files/client/requests/FilesShowRequest.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../../../../index.js";
+import type * as Frameio from "../../../../index.js";
 /**
  * @example
  *     {
@@ -6,6 +6,5 @@ import * as Frameio from "../../../../index.js";
  *     }
  */
 export interface FilesShowRequest {
-    /** */
     include?: Frameio.FilesShowRequestInclude;
 }

package/dist/cjs/api/resources/files/client/requests/index.d.ts

@@ -1,9 +1,9 @@
-export { type FilesListRequest } from "./FilesListRequest.js";
-export { type FileCreateParams } from "./FileCreateParams.js";
-export { type FilesShowRequest } from "./FilesShowRequest.js";
-export { type FileUpdateParams } from "./FileUpdateParams.js";
-export { type FileCopyParams } from "./FileCopyParams.js";
-export { type FileCreateRemoteUploadParams } from "./FileCreateRemoteUploadParams.js";
-export { type FileMoveParams } from "./FileMoveParams.js";
-export { type FileCreateLocalUploadParams } from "./FileCreateLocalUploadParams.js";
-export { type FileImportParams } from "./FileImportParams.js";
+export type { FileCopyParams } from "./FileCopyParams.js";
+export type { FileCreateLocalUploadParams } from "./FileCreateLocalUploadParams.js";
+export type { FileCreateParams } from "./FileCreateParams.js";
+export type { FileCreateRemoteUploadParams } from "./FileCreateRemoteUploadParams.js";
+export type { FileImportParams } from "./FileImportParams.js";
+export type { FileMoveParams } from "./FileMoveParams.js";
+export type { FilesListRequest } from "./FilesListRequest.js";
+export type { FilesShowRequest } from "./FilesShowRequest.js";
+export type { FileUpdateParams } from "./FileUpdateParams.js";

package/dist/cjs/api/resources/files/exports.d.ts

@@ -0,0 +1,2 @@
+export { FilesClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/cjs/api/resources/files/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilesClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "FilesClient", { enumerable: true, get: function () { return Client_js_1.FilesClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/files/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./types/index.js";
 export * from "./client/index.js";
+export * from "./types/index.js";

package/dist/cjs/api/resources/files/index.js

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types/index.js"), exports);
 __exportStar(require("./client/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/resources/files/types/index.d.ts

@@ -1,4 +1,4 @@
+export * from "./FilesCopyRequestCopyComments.js";
 export * from "./FilesListRequestInclude.js";
 export * from "./FilesListRequestSort.js";
 export * from "./FilesShowRequestInclude.js";
-export * from "./FilesCopyRequestCopyComments.js";

package/dist/cjs/api/resources/files/types/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./FilesCopyRequestCopyComments.js"), exports);
 __exportStar(require("./FilesListRequestInclude.js"), exports);
 __exportStar(require("./FilesListRequestSort.js"), exports);
 __exportStar(require("./FilesShowRequestInclude.js"), exports);
-__exportStar(require("./FilesCopyRequestCopyComments.js"), exports);

package/dist/cjs/api/resources/folders/client/Client.d.ts

@@ -1,42 +1,25 @@
-import * as environments from "../../../../environments.js";
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import * as Frameio from "../../../index.js";
-export declare namespace Folders {
-    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 FoldersClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
     }
 }
 /**
  * Manage Folders and related operations.
  */
-export declare class Folders {
-    protected readonly _options: Folders.Options;
-    constructor(_options: Folders.Options);
+export declare class FoldersClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<FoldersClient.Options>;
+    constructor(options: FoldersClient.Options);
     /**
      * Show folder details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FoldersShowRequest} request
-     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FoldersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -51,14 +34,14 @@ export declare class Folders {
      *         include: "creator"
      *     })
      */
-    show(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FoldersShowRequest, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FolderWithIncludesResponse>;
+    show(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request?: Frameio.FoldersShowRequest, requestOptions?: FoldersClient.RequestOptions): core.HttpResponsePromise<Frameio.FolderWithIncludesResponse>;
     private __show;
     /**
      * Delete folder by id. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
-     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
+     * @param {FoldersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -71,15 +54,15 @@ export declare class Folders {
      * @example
      *     await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
      */
-    delete(accountId: Frameio.Uuid, folderId: Frameio.Uuid, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<void>;
+    delete(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, requestOptions?: FoldersClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
      * Update folder details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FolderUpdateParams} request
-     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FoldersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -96,7 +79,7 @@ export declare class Folders {
      *         }
      *     })
      */
-    update(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FolderUpdateParams, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FolderResponse>;
+    update(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request: Frameio.FolderUpdateParams, requestOptions?: FoldersClient.RequestOptions): core.HttpResponsePromise<Frameio.FolderResponse>;
     private __update;
     /**
      * List the children in the given folder.
@@ -113,10 +96,10 @@ export declare class Folders {
      * null in the response payload. In short, the client must handle null media links gracefully.
      * <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FoldersIndexRequest} request
-     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FoldersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -135,15 +118,15 @@ export declare class Folders {
      *         include_total_count: false
      *     })
      */
-    index(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FoldersIndexRequest, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FolderAssetsWithIncludesResponse>;
+    index(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request?: Frameio.FoldersIndexRequest, requestOptions?: FoldersClient.RequestOptions): core.HttpResponsePromise<Frameio.FolderAssetsWithIncludesResponse>;
     private __index;
     /**
      * Copy folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FolderCopyParams} request
-     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FoldersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -161,15 +144,15 @@ export declare class Folders {
      *         }
      *     })
      */
-    copy(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FolderCopyParams, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FolderCopyResponse>;
+    copy(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request?: Frameio.FolderCopyParams, requestOptions?: FoldersClient.RequestOptions): core.HttpResponsePromise<Frameio.FolderCopyResponse>;
     private __copy;
     /**
      * List folders in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FoldersListRequest} request
-     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FoldersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -187,15 +170,15 @@ export declare class Folders {
      *         include_total_count: false
      *     })
      */
-    list(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FoldersListRequest, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FoldersWithIncludesResponse>;
+    list(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request?: Frameio.FoldersListRequest, requestOptions?: FoldersClient.RequestOptions): core.HttpResponsePromise<Frameio.FoldersWithIncludesResponse>;
     private __list;
     /**
      * Create a new folder inside the given <i>folder_id</i> path param. <br/>Rate Limits: 3 calls per 1 second(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FolderCreateParams} request
-     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FoldersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -212,15 +195,15 @@ export declare class Folders {
      *         }
      *     })
      */
-    create(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FolderCreateParams, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FolderResponse>;
+    create(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request: Frameio.FolderCreateParams, requestOptions?: FoldersClient.RequestOptions): core.HttpResponsePromise<Frameio.FolderResponse>;
     private __create;
     /**
      * Move folder to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FolderMoveParams} request
-     * @param {Folders.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FoldersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -237,7 +220,6 @@ export declare class Folders {
      *         }
      *     })
      */
-    move(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FolderMoveParams, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FolderResponse>;
+    move(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request: Frameio.FolderMoveParams, requestOptions?: FoldersClient.RequestOptions): core.HttpResponsePromise<Frameio.FolderResponse>;
     private __move;
-    protected _getAuthorizationHeader(): Promise<string>;
 }