frameio 4.2.1 → 4.2.3

package/dist/cjs/BaseClient.js

@@ -44,8 +44,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "frameio",
-        "X-Fern-SDK-Version": "4.2.1",
-        "User-Agent": "frameio/4.2.1",
+        "X-Fern-SDK-Version": "4.2.3",
+        "User-Agent": "frameio/4.2.3",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "user-agent": (_a = options === null || options === void 0 ? void 0 : options.userAgent) !== null && _a !== void 0 ? _a : "frameio-ts",

package/dist/cjs/Client.d.ts

@@ -28,47 +28,47 @@ export declare namespace FrameioClient {
 }
 export declare class FrameioClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<FrameioClient.Options>;
-    protected _customActions: CustomActionsClient | undefined;
-    protected _metadataFields: MetadataFieldsClient | undefined;
-    protected _projectPermissions: ProjectPermissionsClient | undefined;
-    protected _folders: FoldersClient | undefined;
-    protected _versionStacks: VersionStacksClient | undefined;
-    protected _accountPermissions: AccountPermissionsClient | undefined;
+    protected _search: SearchClient | undefined;
     protected _comments: CommentsClient | undefined;
-    protected _accounts: AccountsClient | undefined;
-    protected _webhooks: WebhooksClient | undefined;
-    protected _workspacePermissions: WorkspacePermissionsClient | undefined;
-    protected _groups: GroupsClient | undefined;
     protected _shares: SharesClient | undefined;
-    protected _metadata: MetadataClient | undefined;
-    protected _files: FilesClient | undefined;
     protected _users: UsersClient | undefined;
-    protected _projects: ProjectsClient | undefined;
+    protected _collections: CollectionsClient | undefined;
+    protected _files: FilesClient | undefined;
+    protected _metadataFields: MetadataFieldsClient | undefined;
+    protected _customActions: CustomActionsClient | undefined;
+    protected _workspacePermissions: WorkspacePermissionsClient | undefined;
+    protected _versionStacks: VersionStacksClient | undefined;
     protected _folderPermissions: FolderPermissionsClient | undefined;
+    protected _metadata: MetadataClient | undefined;
+    protected _groups: GroupsClient | undefined;
+    protected _projects: ProjectsClient | undefined;
     protected _workspaces: WorkspacesClient | undefined;
-    protected _collections: CollectionsClient | undefined;
-    protected _search: SearchClient | undefined;
+    protected _accounts: AccountsClient | undefined;
+    protected _webhooks: WebhooksClient | undefined;
+    protected _folders: FoldersClient | undefined;
+    protected _accountPermissions: AccountPermissionsClient | undefined;
+    protected _projectPermissions: ProjectPermissionsClient | undefined;
     constructor(options: FrameioClient.Options);
-    get customActions(): CustomActionsClient;
-    get metadataFields(): MetadataFieldsClient;
-    get projectPermissions(): ProjectPermissionsClient;
-    get folders(): FoldersClient;
-    get versionStacks(): VersionStacksClient;
-    get accountPermissions(): AccountPermissionsClient;
+    get search(): SearchClient;
     get comments(): CommentsClient;
-    get accounts(): AccountsClient;
-    get webhooks(): WebhooksClient;
-    get workspacePermissions(): WorkspacePermissionsClient;
-    get groups(): GroupsClient;
     get shares(): SharesClient;
-    get metadata(): MetadataClient;
-    get files(): FilesClient;
     get users(): UsersClient;
-    get projects(): ProjectsClient;
+    get collections(): CollectionsClient;
+    get files(): FilesClient;
+    get metadataFields(): MetadataFieldsClient;
+    get customActions(): CustomActionsClient;
+    get workspacePermissions(): WorkspacePermissionsClient;
+    get versionStacks(): VersionStacksClient;
     get folderPermissions(): FolderPermissionsClient;
+    get metadata(): MetadataClient;
+    get groups(): GroupsClient;
+    get projects(): ProjectsClient;
     get workspaces(): WorkspacesClient;
-    get collections(): CollectionsClient;
-    get search(): SearchClient;
+    get accounts(): AccountsClient;
+    get webhooks(): WebhooksClient;
+    get folders(): FoldersClient;
+    get accountPermissions(): AccountPermissionsClient;
+    get projectPermissions(): ProjectPermissionsClient;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
      * This is useful for making requests to endpoints not yet supported in the SDK.

package/dist/cjs/Client.js

@@ -70,85 +70,85 @@ class FrameioClient {
     constructor(options) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
-    get customActions() {
-        var _a;
-        return ((_a = this._customActions) !== null && _a !== void 0 ? _a : (this._customActions = new Client_js_5.CustomActionsClient(this._options)));
-    }
-    get metadataFields() {
+    get search() {
         var _a;
-        return ((_a = this._metadataFields) !== null && _a !== void 0 ? _a : (this._metadataFields = new Client_js_11.MetadataFieldsClient(this._options)));
+        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_js_14.SearchClient(this._options)));
     }
-    get projectPermissions() {
+    get comments() {
         var _a;
-        return ((_a = this._projectPermissions) !== null && _a !== void 0 ? _a : (this._projectPermissions = new Client_js_12.ProjectPermissionsClient(this._options)));
+        return ((_a = this._comments) !== null && _a !== void 0 ? _a : (this._comments = new Client_js_4.CommentsClient(this._options)));
     }
-    get folders() {
+    get shares() {
         var _a;
-        return ((_a = this._folders) !== null && _a !== void 0 ? _a : (this._folders = new Client_js_8.FoldersClient(this._options)));
+        return ((_a = this._shares) !== null && _a !== void 0 ? _a : (this._shares = new Client_js_15.SharesClient(this._options)));
     }
-    get versionStacks() {
+    get users() {
         var _a;
-        return ((_a = this._versionStacks) !== null && _a !== void 0 ? _a : (this._versionStacks = new Client_js_17.VersionStacksClient(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_16.UsersClient(this._options)));
     }
-    get accountPermissions() {
+    get collections() {
         var _a;
-        return ((_a = this._accountPermissions) !== null && _a !== void 0 ? _a : (this._accountPermissions = new Client_js_1.AccountPermissionsClient(this._options)));
+        return ((_a = this._collections) !== null && _a !== void 0 ? _a : (this._collections = new Client_js_3.CollectionsClient(this._options)));
     }
-    get comments() {
+    get files() {
         var _a;
-        return ((_a = this._comments) !== null && _a !== void 0 ? _a : (this._comments = new Client_js_4.CommentsClient(this._options)));
+        return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new Client_js_6.FilesClient(this._options)));
     }
-    get accounts() {
+    get metadataFields() {
         var _a;
-        return ((_a = this._accounts) !== null && _a !== void 0 ? _a : (this._accounts = new Client_js_2.AccountsClient(this._options)));
+        return ((_a = this._metadataFields) !== null && _a !== void 0 ? _a : (this._metadataFields = new Client_js_11.MetadataFieldsClient(this._options)));
     }
-    get webhooks() {
+    get customActions() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_18.WebhooksClient(this._options)));
+        return ((_a = this._customActions) !== null && _a !== void 0 ? _a : (this._customActions = new Client_js_5.CustomActionsClient(this._options)));
     }
     get workspacePermissions() {
         var _a;
         return ((_a = this._workspacePermissions) !== null && _a !== void 0 ? _a : (this._workspacePermissions = new Client_js_19.WorkspacePermissionsClient(this._options)));
     }
-    get groups() {
+    get versionStacks() {
         var _a;
-        return ((_a = this._groups) !== null && _a !== void 0 ? _a : (this._groups = new Client_js_9.GroupsClient(this._options)));
+        return ((_a = this._versionStacks) !== null && _a !== void 0 ? _a : (this._versionStacks = new Client_js_17.VersionStacksClient(this._options)));
     }
-    get shares() {
+    get folderPermissions() {
         var _a;
-        return ((_a = this._shares) !== null && _a !== void 0 ? _a : (this._shares = new Client_js_15.SharesClient(this._options)));
+        return ((_a = this._folderPermissions) !== null && _a !== void 0 ? _a : (this._folderPermissions = new Client_js_7.FolderPermissionsClient(this._options)));
     }
     get metadata() {
         var _a;
         return ((_a = this._metadata) !== null && _a !== void 0 ? _a : (this._metadata = new Client_js_10.MetadataClient(this._options)));
     }
-    get files() {
-        var _a;
-        return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new Client_js_6.FilesClient(this._options)));
-    }
-    get users() {
+    get groups() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_16.UsersClient(this._options)));
+        return ((_a = this._groups) !== null && _a !== void 0 ? _a : (this._groups = new Client_js_9.GroupsClient(this._options)));
     }
     get projects() {
         var _a;
         return ((_a = this._projects) !== null && _a !== void 0 ? _a : (this._projects = new Client_js_13.ProjectsClient(this._options)));
     }
-    get folderPermissions() {
-        var _a;
-        return ((_a = this._folderPermissions) !== null && _a !== void 0 ? _a : (this._folderPermissions = new Client_js_7.FolderPermissionsClient(this._options)));
-    }
     get workspaces() {
         var _a;
         return ((_a = this._workspaces) !== null && _a !== void 0 ? _a : (this._workspaces = new Client_js_20.WorkspacesClient(this._options)));
     }
-    get collections() {
+    get accounts() {
         var _a;
-        return ((_a = this._collections) !== null && _a !== void 0 ? _a : (this._collections = new Client_js_3.CollectionsClient(this._options)));
+        return ((_a = this._accounts) !== null && _a !== void 0 ? _a : (this._accounts = new Client_js_2.AccountsClient(this._options)));
     }
-    get search() {
+    get webhooks() {
         var _a;
-        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_js_14.SearchClient(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_18.WebhooksClient(this._options)));
+    }
+    get folders() {
+        var _a;
+        return ((_a = this._folders) !== null && _a !== void 0 ? _a : (this._folders = new Client_js_8.FoldersClient(this._options)));
+    }
+    get accountPermissions() {
+        var _a;
+        return ((_a = this._accountPermissions) !== null && _a !== void 0 ? _a : (this._accountPermissions = new Client_js_1.AccountPermissionsClient(this._options)));
+    }
+    get projectPermissions() {
+        var _a;
+        return ((_a = this._projectPermissions) !== null && _a !== void 0 ? _a : (this._projectPermissions = new Client_js_12.ProjectPermissionsClient(this._options)));
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

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

@@ -14,11 +14,11 @@ export declare class CollectionsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<CollectionsClient.Options>;
     constructor(options: CollectionsClient.Options);
     /**
-     * Show collection details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     * List collections for a project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} account_id
-     * @param {Frameio.Uuid} collection_id
-     * @param {Frameio.CollectionsShowRequest} request
+     * @param {Frameio.Uuid} project_id
+     * @param {Frameio.CollectionsIndexRequest} request
      * @param {CollectionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -30,18 +30,21 @@ export declare class CollectionsClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.collections.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         include: "creator,project"
+     *     await client.collections.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "creator,project",
+     *         after: "<opaque_cursor>",
+     *         page_size: 10,
+     *         include_total_count: false
      *     })
      */
-    show(account_id: Frameio.Uuid, collection_id: Frameio.Uuid, request?: Frameio.CollectionsShowRequest, requestOptions?: CollectionsClient.RequestOptions): core.HttpResponsePromise<Frameio.CollectionResponse>;
-    private __show;
+    index(account_id: Frameio.Uuid, project_id: Frameio.Uuid, request?: Frameio.CollectionsIndexRequest, requestOptions?: CollectionsClient.RequestOptions): core.HttpResponsePromise<Frameio.CollectionsResponse>;
+    private __index;
     /**
-     * List collections for a project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     * Show collection details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} account_id
-     * @param {Frameio.Uuid} project_id
-     * @param {Frameio.CollectionsIndexRequest} request
+     * @param {Frameio.Uuid} collection_id
+     * @param {Frameio.CollectionsShowRequest} request
      * @param {CollectionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -53,13 +56,10 @@ export declare class CollectionsClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.collections.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         include: "creator,project",
-     *         after: "<opaque_cursor>",
-     *         page_size: 10,
-     *         include_total_count: false
+     *     await client.collections.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "creator,project"
      *     })
      */
-    index(account_id: Frameio.Uuid, project_id: Frameio.Uuid, request?: Frameio.CollectionsIndexRequest, requestOptions?: CollectionsClient.RequestOptions): core.HttpResponsePromise<Frameio.CollectionsResponse>;
-    private __index;
+    show(account_id: Frameio.Uuid, collection_id: Frameio.Uuid, request?: Frameio.CollectionsShowRequest, requestOptions?: CollectionsClient.RequestOptions): core.HttpResponsePromise<Frameio.CollectionResponse>;
+    private __show;
 }

package/dist/cjs/api/resources/collections/client/Client.js

@@ -59,11 +59,11 @@ class CollectionsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
-     * Show collection details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     * List collections for a project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} account_id
-     * @param {Frameio.Uuid} collection_id
-     * @param {Frameio.CollectionsShowRequest} request
+     * @param {Frameio.Uuid} project_id
+     * @param {Frameio.CollectionsIndexRequest} request
      * @param {CollectionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -75,24 +75,30 @@ class CollectionsClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.collections.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         include: "creator,project"
+     *     await client.collections.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "creator,project",
+     *         after: "<opaque_cursor>",
+     *         page_size: 10,
+     *         include_total_count: false
      *     })
      */
-    show(account_id, collection_id, request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__show(account_id, collection_id, request, requestOptions));
+    index(account_id, project_id, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__index(account_id, project_id, request, requestOptions));
     }
-    __show(account_id_1, collection_id_1) {
-        return __awaiter(this, arguments, void 0, function* (account_id, collection_id, request = {}, requestOptions) {
+    __index(account_id_1, project_id_1) {
+        return __awaiter(this, arguments, void 0, function* (account_id, project_id, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
-            const { include } = request;
+            const { include, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
             const _queryParams = {
                 include,
+                after,
+                page_size: pageSize,
+                include_total_count: includeTotalCount,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
-                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/collections/${core.url.encodePathParam(collection_id)}`),
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/projects/${core.url.encodePathParam(project_id)}/collections`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
@@ -129,15 +135,15 @@ class CollectionsClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/collections/{collection_id}");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/projects/{project_id}/collections");
         });
     }
     /**
-     * List collections for a project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     * Show collection details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} account_id
-     * @param {Frameio.Uuid} project_id
-     * @param {Frameio.CollectionsIndexRequest} request
+     * @param {Frameio.Uuid} collection_id
+     * @param {Frameio.CollectionsShowRequest} request
      * @param {CollectionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -149,30 +155,24 @@ class CollectionsClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.collections.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         include: "creator,project",
-     *         after: "<opaque_cursor>",
-     *         page_size: 10,
-     *         include_total_count: false
+     *     await client.collections.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "creator,project"
      *     })
      */
-    index(account_id, project_id, request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__index(account_id, project_id, request, requestOptions));
+    show(account_id, collection_id, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__show(account_id, collection_id, request, requestOptions));
     }
-    __index(account_id_1, project_id_1) {
-        return __awaiter(this, arguments, void 0, function* (account_id, project_id, request = {}, requestOptions) {
+    __show(account_id_1, collection_id_1) {
+        return __awaiter(this, arguments, void 0, function* (account_id, collection_id, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
-            const { include, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
+            const { include } = request;
             const _queryParams = {
                 include,
-                after,
-                page_size: pageSize,
-                include_total_count: includeTotalCount,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
-                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/projects/${core.url.encodePathParam(project_id)}/collections`),
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/collections/${core.url.encodePathParam(collection_id)}`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
@@ -209,7 +209,7 @@ class CollectionsClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/projects/{project_id}/collections");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/collections/{collection_id}");
         });
     }
 }