frameio 4.1.1 → 4.2.0

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.1.0",
-        "User-Agent": "frameio/4.1.0",
+        "X-Fern-SDK-Version": "4.2.0",
+        "User-Agent": "frameio/4.2.0",
         "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

@@ -1,8 +1,10 @@
 import { AccountPermissionsClient } from "./api/resources/accountPermissions/client/Client.js";
 import { AccountsClient } from "./api/resources/accounts/client/Client.js";
 import { CommentsClient } from "./api/resources/comments/client/Client.js";
+import { CustomActionsClient } from "./api/resources/customActions/client/Client.js";
 import { FilesClient } from "./api/resources/files/client/Client.js";
 import { FoldersClient } from "./api/resources/folders/client/Client.js";
+import { GroupsClient } from "./api/resources/groups/client/Client.js";
 import { MetadataClient } from "./api/resources/metadata/client/Client.js";
 import { MetadataFieldsClient } from "./api/resources/metadataFields/client/Client.js";
 import { ProjectPermissionsClient } from "./api/resources/projectPermissions/client/Client.js";
@@ -23,6 +25,7 @@ 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;
@@ -32,6 +35,7 @@ export declare class FrameioClient {
     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;
@@ -39,6 +43,7 @@ export declare class FrameioClient {
     protected _projects: ProjectsClient | undefined;
     protected _workspaces: WorkspacesClient | undefined;
     constructor(options: FrameioClient.Options);
+    get customActions(): CustomActionsClient;
     get metadataFields(): MetadataFieldsClient;
     get projectPermissions(): ProjectPermissionsClient;
     get folders(): FoldersClient;
@@ -48,6 +53,7 @@ export declare class FrameioClient {
     get accounts(): AccountsClient;
     get webhooks(): WebhooksClient;
     get workspacePermissions(): WorkspacePermissionsClient;
+    get groups(): GroupsClient;
     get shares(): SharesClient;
     get metadata(): MetadataClient;
     get files(): FilesClient;

package/dist/cjs/Client.js

@@ -47,39 +47,45 @@ exports.FrameioClient = void 0;
 const Client_js_1 = require("./api/resources/accountPermissions/client/Client.js");
 const Client_js_2 = require("./api/resources/accounts/client/Client.js");
 const Client_js_3 = require("./api/resources/comments/client/Client.js");
-const Client_js_4 = require("./api/resources/files/client/Client.js");
-const Client_js_5 = require("./api/resources/folders/client/Client.js");
-const Client_js_6 = require("./api/resources/metadata/client/Client.js");
-const Client_js_7 = require("./api/resources/metadataFields/client/Client.js");
-const Client_js_8 = require("./api/resources/projectPermissions/client/Client.js");
-const Client_js_9 = require("./api/resources/projects/client/Client.js");
-const Client_js_10 = require("./api/resources/shares/client/Client.js");
-const Client_js_11 = require("./api/resources/users/client/Client.js");
-const Client_js_12 = require("./api/resources/versionStacks/client/Client.js");
-const Client_js_13 = require("./api/resources/webhooks/client/Client.js");
-const Client_js_14 = require("./api/resources/workspacePermissions/client/Client.js");
-const Client_js_15 = require("./api/resources/workspaces/client/Client.js");
+const Client_js_4 = require("./api/resources/customActions/client/Client.js");
+const Client_js_5 = require("./api/resources/files/client/Client.js");
+const Client_js_6 = require("./api/resources/folders/client/Client.js");
+const Client_js_7 = require("./api/resources/groups/client/Client.js");
+const Client_js_8 = require("./api/resources/metadata/client/Client.js");
+const Client_js_9 = require("./api/resources/metadataFields/client/Client.js");
+const Client_js_10 = require("./api/resources/projectPermissions/client/Client.js");
+const Client_js_11 = require("./api/resources/projects/client/Client.js");
+const Client_js_12 = require("./api/resources/shares/client/Client.js");
+const Client_js_13 = require("./api/resources/users/client/Client.js");
+const Client_js_14 = require("./api/resources/versionStacks/client/Client.js");
+const Client_js_15 = require("./api/resources/webhooks/client/Client.js");
+const Client_js_16 = require("./api/resources/workspacePermissions/client/Client.js");
+const Client_js_17 = require("./api/resources/workspaces/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const core = __importStar(require("./core/index.js"));
 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_4.CustomActionsClient(this._options)));
+    }
     get metadataFields() {
         var _a;
-        return ((_a = this._metadataFields) !== null && _a !== void 0 ? _a : (this._metadataFields = new Client_js_7.MetadataFieldsClient(this._options)));
+        return ((_a = this._metadataFields) !== null && _a !== void 0 ? _a : (this._metadataFields = new Client_js_9.MetadataFieldsClient(this._options)));
     }
     get projectPermissions() {
         var _a;
-        return ((_a = this._projectPermissions) !== null && _a !== void 0 ? _a : (this._projectPermissions = new Client_js_8.ProjectPermissionsClient(this._options)));
+        return ((_a = this._projectPermissions) !== null && _a !== void 0 ? _a : (this._projectPermissions = new Client_js_10.ProjectPermissionsClient(this._options)));
     }
     get folders() {
         var _a;
-        return ((_a = this._folders) !== null && _a !== void 0 ? _a : (this._folders = new Client_js_5.FoldersClient(this._options)));
+        return ((_a = this._folders) !== null && _a !== void 0 ? _a : (this._folders = new Client_js_6.FoldersClient(this._options)));
     }
     get versionStacks() {
         var _a;
-        return ((_a = this._versionStacks) !== null && _a !== void 0 ? _a : (this._versionStacks = new Client_js_12.VersionStacksClient(this._options)));
+        return ((_a = this._versionStacks) !== null && _a !== void 0 ? _a : (this._versionStacks = new Client_js_14.VersionStacksClient(this._options)));
     }
     get accountPermissions() {
         var _a;
@@ -95,35 +101,39 @@ class FrameioClient {
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_13.WebhooksClient(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_15.WebhooksClient(this._options)));
     }
     get workspacePermissions() {
         var _a;
-        return ((_a = this._workspacePermissions) !== null && _a !== void 0 ? _a : (this._workspacePermissions = new Client_js_14.WorkspacePermissionsClient(this._options)));
+        return ((_a = this._workspacePermissions) !== null && _a !== void 0 ? _a : (this._workspacePermissions = new Client_js_16.WorkspacePermissionsClient(this._options)));
+    }
+    get groups() {
+        var _a;
+        return ((_a = this._groups) !== null && _a !== void 0 ? _a : (this._groups = new Client_js_7.GroupsClient(this._options)));
     }
     get shares() {
         var _a;
-        return ((_a = this._shares) !== null && _a !== void 0 ? _a : (this._shares = new Client_js_10.SharesClient(this._options)));
+        return ((_a = this._shares) !== null && _a !== void 0 ? _a : (this._shares = new Client_js_12.SharesClient(this._options)));
     }
     get metadata() {
         var _a;
-        return ((_a = this._metadata) !== null && _a !== void 0 ? _a : (this._metadata = new Client_js_6.MetadataClient(this._options)));
+        return ((_a = this._metadata) !== null && _a !== void 0 ? _a : (this._metadata = new Client_js_8.MetadataClient(this._options)));
     }
     get files() {
         var _a;
-        return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new Client_js_4.FilesClient(this._options)));
+        return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new Client_js_5.FilesClient(this._options)));
     }
     get users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_11.UsersClient(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_13.UsersClient(this._options)));
     }
     get projects() {
         var _a;
-        return ((_a = this._projects) !== null && _a !== void 0 ? _a : (this._projects = new Client_js_9.ProjectsClient(this._options)));
+        return ((_a = this._projects) !== null && _a !== void 0 ? _a : (this._projects = new Client_js_11.ProjectsClient(this._options)));
     }
     get workspaces() {
         var _a;
-        return ((_a = this._workspaces) !== null && _a !== void 0 ? _a : (this._workspaces = new Client_js_15.WorkspacesClient(this._options)));
+        return ((_a = this._workspaces) !== null && _a !== void 0 ? _a : (this._workspaces = new Client_js_17.WorkspacesClient(this._options)));
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

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

@@ -0,0 +1,145 @@
+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 CustomActionsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Manage Custom Actions and related operations.
+ */
+export declare class CustomActionsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<CustomActionsClient.Options>;
+    constructor(options: CustomActionsClient.Options);
+    /**
+     * Show custom action details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} action_id
+     * @param {Frameio.ActionsShowRequest} request
+     * @param {CustomActionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.customActions.actionsShow("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "creator"
+     *     })
+     */
+    actionsShow(account_id: Frameio.Uuid, action_id: Frameio.Uuid, request?: Frameio.ActionsShowRequest, requestOptions?: CustomActionsClient.RequestOptions): core.HttpResponsePromise<Frameio.ActionWithIncludesResponse>;
+    private __actionsShow;
+    /**
+     * Delete a custom action. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} action_id
+     * @param {CustomActionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.customActions.actionsDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
+     */
+    actionsDelete(account_id: Frameio.Uuid, action_id: Frameio.Uuid, requestOptions?: CustomActionsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __actionsDelete;
+    /**
+     * Update custom action details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} action_id
+     * @param {Frameio.ActionUpdateParams} request
+     * @param {CustomActionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.customActions.actionsUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             active: true,
+     *             description: "customizing our workflow",
+     *             event: "my.event",
+     *             multi_asset: true,
+     *             name: "First Custom Action",
+     *             timeout: 7,
+     *             url: "https://example.com/custom-action"
+     *         }
+     *     })
+     */
+    actionsUpdate(account_id: Frameio.Uuid, action_id: Frameio.Uuid, request: Frameio.ActionUpdateParams, requestOptions?: CustomActionsClient.RequestOptions): core.HttpResponsePromise<Frameio.ActionResponse>;
+    private __actionsUpdate;
+    /**
+     * List actions in a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} workspace_id
+     * @param {Frameio.ActionsIndexRequest} request
+     * @param {CustomActionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.customActions.actionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "creator",
+     *         after: "<opaque_cursor>",
+     *         page_size: 10,
+     *         include_total_count: false
+     *     })
+     */
+    actionsIndex(account_id: Frameio.Uuid, workspace_id: Frameio.Uuid, request?: Frameio.ActionsIndexRequest, requestOptions?: CustomActionsClient.RequestOptions): core.HttpResponsePromise<Frameio.ActionsWithIncludesResponse>;
+    private __actionsIndex;
+    /**
+     * Create a custom action in a workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} workspace_id
+     * @param {Frameio.ActionCreateParams} request
+     * @param {CustomActionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.customActions.actionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             description: "customizing our workflow",
+     *             event: "my.event",
+     *             name: "First Custom Action",
+     *             timeout: 7,
+     *             url: "https://example.com/custom-action"
+     *         }
+     *     })
+     */
+    actionsCreate(account_id: Frameio.Uuid, workspace_id: Frameio.Uuid, request: Frameio.ActionCreateParams, requestOptions?: CustomActionsClient.RequestOptions): core.HttpResponsePromise<Frameio.ActionCreateResponse>;
+    private __actionsCreate;
+}