frameio 4.1.1 → 4.2.0

package/dist/cjs/api/types/GroupsSort.d.ts

@@ -0,0 +1,10 @@
+/** Sort query parameter for Groups. */
+export declare const GroupsSort: {
+    readonly CreatorAsc: "creator_asc";
+    readonly CreatorDesc: "creator_desc";
+    readonly NameAsc: "name_asc";
+    readonly NameDesc: "name_desc";
+    readonly CreatedAtAsc: "created_at_asc";
+    readonly CreatedAtDesc: "created_at_desc";
+};
+export type GroupsSort = (typeof GroupsSort)[keyof typeof GroupsSort];

package/dist/cjs/api/types/GroupsSort.js

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupsSort = void 0;
+/** Sort query parameter for Groups. */
+exports.GroupsSort = {
+    CreatorAsc: "creator_asc",
+    CreatorDesc: "creator_desc",
+    NameAsc: "name_asc",
+    NameDesc: "name_desc",
+    CreatedAtAsc: "created_at_asc",
+    CreatedAtDesc: "created_at_desc",
+};

package/dist/cjs/api/types/GroupsWithIncludesResponse.d.ts

@@ -0,0 +1,8 @@
+import type * as Frameio from "../index.js";
+export interface GroupsWithIncludesResponse {
+    /** Groups */
+    data: Frameio.GroupWithIncludes[];
+    links: Frameio.Links;
+    /** Total count */
+    total_count?: number | undefined;
+}

package/dist/cjs/api/types/GroupsWithIncludesResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/SingleUserValue.d.ts

@@ -1,6 +1,6 @@
 import type * as Frameio from "../index.js";
 export interface SingleUserValue extends Frameio.FieldValueCommon {
-    /** Populated with costum member options only if `member_options_type` is set to 'custom'. */
+    /** Populated with custom member options only if `member_options_type` is set to 'custom'. */
     custom_members?: Frameio.UserValue[] | undefined;
     member_options_type?: SingleUserValue.MemberOptionsType | undefined;
     value: Frameio.UserValue[];

package/dist/cjs/api/types/SyncGroupWithIncludes.d.ts

@@ -0,0 +1,15 @@
+import type * as Frameio from "../index.js";
+export interface SyncGroupWithIncludes extends Frameio.GroupCommonWithIncludes {
+    /** Imported group sync status */
+    sync_status: SyncGroupWithIncludes.SyncStatus;
+}
+export declare namespace SyncGroupWithIncludes {
+    /** Imported group sync status */
+    const SyncStatus: {
+        readonly NotStarted: "not_started";
+        readonly InProgress: "in_progress";
+        readonly Completed: "completed";
+        readonly Error: "error";
+    };
+    type SyncStatus = (typeof SyncStatus)[keyof typeof SyncStatus];
+}

package/dist/cjs/api/types/SyncGroupWithIncludes.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyncGroupWithIncludes = void 0;
+var SyncGroupWithIncludes;
+(function (SyncGroupWithIncludes) {
+    /** Imported group sync status */
+    SyncGroupWithIncludes.SyncStatus = {
+        NotStarted: "not_started",
+        InProgress: "in_progress",
+        Completed: "completed",
+        Error: "error",
+    };
+})(SyncGroupWithIncludes || (exports.SyncGroupWithIncludes = SyncGroupWithIncludes = {}));

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

@@ -2,6 +2,13 @@ export * from "./Account.js";
 export * from "./AccountsResponse.js";
 export * from "./AccountUserRole.js";
 export * from "./AccountUserRolesResponse.js";
+export * from "./Action.js";
+export * from "./ActionCreateResponse.js";
+export * from "./ActionInclude.js";
+export * from "./ActionResponse.js";
+export * from "./ActionsWithIncludesResponse.js";
+export * from "./ActionWithIncludes.js";
+export * from "./ActionWithIncludesResponse.js";
 export * from "./AddAssetResponse.js";
 export * from "./Anchor.js";
 export * from "./AssetCommon.js";
@@ -60,6 +67,14 @@ export * from "./FoldersWithIncludesResponse.js";
 export * from "./FolderWithIncludes.js";
 export * from "./FolderWithIncludesResponse.js";
 export * from "./Forbidden.js";
+export * from "./GroupCommon.js";
+export * from "./GroupCommonWithIncludes.js";
+export * from "./GroupResponse.js";
+export * from "./GroupsInclude.js";
+export * from "./GroupsSort.js";
+export * from "./GroupsWithIncludesResponse.js";
+export * from "./GroupWithIncludes.js";
+export * from "./GroupWithIncludesResponse.js";
 export * from "./Include.js";
 export * from "./IncludeTotalCount.js";
 export * from "./IntegerValue.js";
@@ -114,6 +129,7 @@ export * from "./ShareResponse.js";
 export * from "./ShareReviewersResponse.js";
 export * from "./SharesResponse.js";
 export * from "./SingleUserValue.js";
+export * from "./SyncGroupWithIncludes.js";
 export * from "./TextDefinition.js";
 export * from "./TextDefinitionParams.js";
 export * from "./TextDefinitionWithIncludes.js";

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

@@ -18,6 +18,13 @@ __exportStar(require("./Account.js"), exports);
 __exportStar(require("./AccountsResponse.js"), exports);
 __exportStar(require("./AccountUserRole.js"), exports);
 __exportStar(require("./AccountUserRolesResponse.js"), exports);
+__exportStar(require("./Action.js"), exports);
+__exportStar(require("./ActionCreateResponse.js"), exports);
+__exportStar(require("./ActionInclude.js"), exports);
+__exportStar(require("./ActionResponse.js"), exports);
+__exportStar(require("./ActionsWithIncludesResponse.js"), exports);
+__exportStar(require("./ActionWithIncludes.js"), exports);
+__exportStar(require("./ActionWithIncludesResponse.js"), exports);
 __exportStar(require("./AddAssetResponse.js"), exports);
 __exportStar(require("./Anchor.js"), exports);
 __exportStar(require("./AssetCommon.js"), exports);
@@ -76,6 +83,14 @@ __exportStar(require("./FoldersWithIncludesResponse.js"), exports);
 __exportStar(require("./FolderWithIncludes.js"), exports);
 __exportStar(require("./FolderWithIncludesResponse.js"), exports);
 __exportStar(require("./Forbidden.js"), exports);
+__exportStar(require("./GroupCommon.js"), exports);
+__exportStar(require("./GroupCommonWithIncludes.js"), exports);
+__exportStar(require("./GroupResponse.js"), exports);
+__exportStar(require("./GroupsInclude.js"), exports);
+__exportStar(require("./GroupsSort.js"), exports);
+__exportStar(require("./GroupsWithIncludesResponse.js"), exports);
+__exportStar(require("./GroupWithIncludes.js"), exports);
+__exportStar(require("./GroupWithIncludesResponse.js"), exports);
 __exportStar(require("./Include.js"), exports);
 __exportStar(require("./IncludeTotalCount.js"), exports);
 __exportStar(require("./IntegerValue.js"), exports);
@@ -130,6 +145,7 @@ __exportStar(require("./ShareResponse.js"), exports);
 __exportStar(require("./ShareReviewersResponse.js"), exports);
 __exportStar(require("./SharesResponse.js"), exports);
 __exportStar(require("./SingleUserValue.js"), exports);
+__exportStar(require("./SyncGroupWithIncludes.js"), exports);
 __exportStar(require("./TextDefinition.js"), exports);
 __exportStar(require("./TextDefinitionParams.js"), exports);
 __exportStar(require("./TextDefinitionWithIncludes.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "4.1.0";
+export declare const SDK_VERSION = "4.2.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "4.1.0";
+exports.SDK_VERSION = "4.2.0";

package/dist/esm/BaseClient.mjs

@@ -7,8 +7,8 @@ export function normalizeClientOptions(options) {
     const headers = 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/esm/Client.d.mts

@@ -1,8 +1,10 @@
 import { AccountPermissionsClient } from "./api/resources/accountPermissions/client/Client.mjs";
 import { AccountsClient } from "./api/resources/accounts/client/Client.mjs";
 import { CommentsClient } from "./api/resources/comments/client/Client.mjs";
+import { CustomActionsClient } from "./api/resources/customActions/client/Client.mjs";
 import { FilesClient } from "./api/resources/files/client/Client.mjs";
 import { FoldersClient } from "./api/resources/folders/client/Client.mjs";
+import { GroupsClient } from "./api/resources/groups/client/Client.mjs";
 import { MetadataClient } from "./api/resources/metadata/client/Client.mjs";
 import { MetadataFieldsClient } from "./api/resources/metadataFields/client/Client.mjs";
 import { ProjectPermissionsClient } from "./api/resources/projectPermissions/client/Client.mjs";
@@ -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/esm/Client.mjs

@@ -11,8 +11,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { AccountPermissionsClient } from "./api/resources/accountPermissions/client/Client.mjs";
 import { AccountsClient } from "./api/resources/accounts/client/Client.mjs";
 import { CommentsClient } from "./api/resources/comments/client/Client.mjs";
+import { CustomActionsClient } from "./api/resources/customActions/client/Client.mjs";
 import { FilesClient } from "./api/resources/files/client/Client.mjs";
 import { FoldersClient } from "./api/resources/folders/client/Client.mjs";
+import { GroupsClient } from "./api/resources/groups/client/Client.mjs";
 import { MetadataClient } from "./api/resources/metadata/client/Client.mjs";
 import { MetadataFieldsClient } from "./api/resources/metadataFields/client/Client.mjs";
 import { ProjectPermissionsClient } from "./api/resources/projectPermissions/client/Client.mjs";
@@ -29,6 +31,10 @@ export class FrameioClient {
     constructor(options) {
         this._options = normalizeClientOptionsWithAuth(options);
     }
+    get customActions() {
+        var _a;
+        return ((_a = this._customActions) !== null && _a !== void 0 ? _a : (this._customActions = new CustomActionsClient(this._options)));
+    }
     get metadataFields() {
         var _a;
         return ((_a = this._metadataFields) !== null && _a !== void 0 ? _a : (this._metadataFields = new MetadataFieldsClient(this._options)));
@@ -65,6 +71,10 @@ export class FrameioClient {
         var _a;
         return ((_a = this._workspacePermissions) !== null && _a !== void 0 ? _a : (this._workspacePermissions = new WorkspacePermissionsClient(this._options)));
     }
+    get groups() {
+        var _a;
+        return ((_a = this._groups) !== null && _a !== void 0 ? _a : (this._groups = new GroupsClient(this._options)));
+    }
     get shares() {
         var _a;
         return ((_a = this._shares) !== null && _a !== void 0 ? _a : (this._shares = new SharesClient(this._options)));

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

@@ -0,0 +1,145 @@
+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 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;
+}