TypeScript SDK リファレンス

インストール

1 npm i -s frameio

使用方法

クライアントをインスタンス化し、次とともに使用します。

1 import { FrameioClient } from "frameio";
2 
3 const client = new FrameioClient({ token: "YOUR_TOKEN" });
4 await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5     data: {
6         field_type: "select",
7         field_configuration: {
8             enable_add_new: false,
9             options: [
10                 {
11                     display_name: "Option 1",
12                 },
13                 {
14                     display_name: "Option 2",
15                 },
16             ],
17         },
18         name: "Fields definition name",
19     },
20 });

リクエストおよびレスポンスタイプ

SDK は、すべてのリクエストおよびレスポンスタイプを TypeScript インターフェイスとして書き出します。次の名前空間で読み込むだけです。

1 import { Frameio } from "frameio";
2 
3 const request: Frameio.UpdateFieldDefinitionParams = {
4     ...
5 };

例外処理

API が成功していないステータスコード（4xx または 5xx レスポンス）を返すと、次のエラーのサブクラスがスローされます。

1 import { FrameioError } from "frameio";
2 
3 try {
4     await client.metadataFields.metadataFieldDefinitionsCreate(...);
5 } catch (err) {
6     if (err instanceof FrameioError) {
7         console.log(err.statusCode);
8         console.log(err.message);
9         console.log(err.body);
10         console.log(err.rawResponse);
11     }
12 }

高度

その他のヘッダー

リクエストの一部としてその他のヘッダーを送信する場合は、ヘッダーリクエストオプションを使用します。

1 const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2     headers: {
3         'X-Custom-Header': 'custom value'
4     }
5 });

その他のクエリ文字列パラメーター

リクエストの一部として追加のクエリ文字列パラメーターを送信する場合は、QueryParams リクエストオプションを使用します。

1 const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2     queryParams: {
3         'customQueryParamKey': 'custom query param value'
4     }
5 });

再試行

この SDK には、指数バックオフでの自動的な再試行が搭載されています。リクエストは、再試行可能と見なされる限り、再試行され、再試行の回数が設定された再試行制限より大きくはなっていません（デフォルト：2）。

次のいずれかの HTTP ステータスコードが返されると、リクエストは再試行可能と見なされます。

408（タイムアウト）
429（リクエストが多すぎます）
5xx（内部サーバーエラー）

この動作を設定するには、maxRetries リクエストオプションを使用します。

1 const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2     maxRetries: 0 // override maxRetries at the request level
3 });

タイムアウト

この SDK のデフォルトでは、60 秒のタイムアウトです。この動作を設定するには、timeoutInSeconds オプションを使用します。

1 const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2     timeoutInSeconds: 30 // override timeout to 30s
3 });

リクエストの中止

この SDK を使用すると、ユーザーは中止シグナルを渡すことで、いつでもリクエストを中止できます。

const controller = new AbortController();

1 const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2     abortSignal: controller.signal
3 });
4 controller.abort(); // aborts the request

Raw レスポンスデータへのアクセス

この SDK では、.withRawResponse() メソッドを通じて、raw レスポンスデータ（ヘッダーを含む）にアクセスできます。.withRawResponse() メソッドは、data および rawResponse プロパティとともにオブジェクトに結果のプロミスを返します。

1 const { data, rawResponse } = await client.metadataFields.metadataFieldDefinitionsCreate(...).withRawResponse();
2 
3 console.log(data);
4 console.log(rawResponse.headers['X-My-Header']);

ランタイムの互換性

SDK は、次のランタイムで動作します。

Node.js 18 以降
Vercel
Cloudflare Workers
Deno v1.25 以降
Bun 1.0 以降
React Native

取得クライアントのカスタマイズ

この SDK は、基盤となる HTTP クライアント / 取得機能をカスタマイズする方法を提供します。サポートされていない環境で実行している場合は、これにより SDK が正しく動作することを確認できる方法が提供されます。

1 import { FrameioClient } from "frameio";
2 
3 const client = new FrameioClient({
4     ...
5     fetcher: // provide your implementation here
6 });

リファレンス

メタデータ

client.metadata.bulkUpdate(accountId, projectId, { ...params }) -> void

複数のファイルにわたってメタデータ値を更新します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         file_ids: ["09b31c2a-04de-464a-a593-643a36ef0d98", "b967fc36-4e18-4b48-a3ab-c790100e2baa"],
4         values: [
5             {
6                 field_definition_id: "ff41ce50-269b-4624-8306-aac10e28ab94",
7                 value: [
8                     {
9                         id: "e60f47b4-cf8e-4273-96d5-3258a830a0aa",
10                         type: "user",
11                     },
12                     {
13                         id: "24eeaf7e-ce27-4555-bc77-cce39900626d",
14                         type: "account_user_group",
15                     },
16                 ],
17             },
18         ],
19     },
20 });

パラメーター accountId：Frameio.Uuid —

projectId：Frameio.Uuid —

request：Frameio.BulkUpdateMetadataParams

requestOptions：Metadata.RequestOptions

client.metadata.show(accountId, fileId, { ...params }) -> Frameio.MetadataResponse

ファイルのメタデータを表示します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.metadata.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     show_null: true,
3 });

パラメーター accountId：Frameio.Uuid —

fileId：Frameio.Uuid —

request：Frameio.MetadataShowRequest

requestOptions：Metadata.RequestOptions

メタデータフィールド

client.metadataFields.metadataFieldDefinitionsDelete(accountId, fieldDefinitionId) -> void

アカウントレベルのカスタムフィールド定義を削除します。
レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 await client.metadataFields.metadataFieldDefinitionsDelete(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4 );

パラメーター

accountId：Frameio.Uuid —

fieldDefinitionId：Frameio.Uuid —

requestOptions：MetadataFields.RequestOptions

client.metadataFields.metadataFieldDefinitionsUpdate(accountId, fieldDefinitionId, { ...params }) -> Frameio.FieldDefinitionResponse

アカウントレベルのカスタムフィールド定義を更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.metadataFields.metadataFieldDefinitionsUpdate(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         data: {
6             field_type: "select",
7             field_configuration: {
8                 enable_add_new: false,
9                 options: [
10                     {
11                         display_name: "Option 1",
12                     },
13                     {
14                         display_name: "Option 2",
15                     },
16                 ],
17             },
18             name: "Updated-Field-Name",
19         },
20     },
21 );

パラメーター

accountId：Frameio.Uuid` —

fieldDefinitionId：Frameio.Uuid —

request：Frameio.UpdateFieldDefinitionParams

requestOptions: MetadataFields.RequestOptions

client.metadataFields.metadataFieldDefinitionsIndex(accountId, { ...params }) -> Frameio.FieldDefinitionsWithIncludesResponse

アカウントレベルのフィールド定義をリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

パラメーター

accountId：Frameio.Uuid —

request：Frameio.MetadataFieldDefinitionsIndexRequest

requestOptions：MetadataFields.RequestOptions

client.metadataFields.metadataFieldDefinitionsCreate(accountId, { ...params }) -> Frameio.FieldDefinitionResponse

アカウントレベルのフィールド定義を作成します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         field_type: "select",
4         field_configuration: {
5             enable_add_new: false,
6             options: [
7                 {
8                     display_name: "Option 1",
9                 },
10                 {
11                     display_name: "Option 2",
12                 },
13             ],
14         },
15         name: "Fields definition name",
16     },
17 });

パラメーター

accountId：Frameio.Uuid —

request：Frameio.CreateFieldDefinitionParams

requestOptions：MetadataFields.RequestOptions

プロジェクト権限

client.projectPermissions.index(accountId, projectId, { ...params }) -> core.Page<Frameio.UserRole

特定のプロジェクトのユーザーロールをリストします。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 const response = await client.projectPermissions.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         include_deactivated: true,
6         after: "<opaque_cursor>",
7         page_size: 10,
8         include_total_count: false,
9     },
10 );
11 for await (const item of response) {
12     console.log(item);
13 }
14 
15 // Or you can manually iterate page-by-page
16 let page = await client.projectPermissions.index(
17     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
18     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
19     {
20         include_deactivated: true,
21         after: "<opaque_cursor>",
22         page_size: 10,
23         include_total_count: false,
24     },
25 );
26 while (page.hasNextPage()) {
27     page = page.getNextPage();
28 }

パラメーター

accountId：Frameio.Uuid —

projectId：Frameio.Uuid —

request：Frameio.ProjectPermissionsIndexRequest

requestOptions：ProjectPermissions.RequestOptions

client.projectPermissions.delete(accountId, projectId, userId) -> void

特定のプロジェクトからユーザーを削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 await client.projectPermissions.delete(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5 );

パラメーター

accountId：Frameio.Uuid` —

projectId：Frameio.Uuid —

userId：Frameio.Uuid —

requestOptions：ProjectPermissions.RequestOptions

client.projectPermissions.projectUserRolesUpdate(accountId, projectId, userId, { ...params }) -> Frameio.UpdateUserRolesResponse

ユーザーが既にプロジェクトに追加されている場合は、指定されたプロジェクトのユーザーロールを更新します。プロジェクトに追加されていないユーザーは、指定されたロールで追加されます。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.projectPermissions.projectUserRolesUpdate(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5     {
6         data: {
7             role: "editor",
8         },
9     },
10 );

パラメーター

accountId：Frameio.Uuid —

projectId：Frameio.Uuid —

UserId：Frameio.Uuid —

request：Frameio.UpdateUserRolesParams

requestOptions：ProjectPermissions.RequestOptions

プロジェクト

client.projects.show(accountId, projectId, { ...params }) -> Frameio.ProjectWithIncludesResponse

プロジェクトの詳細を表示します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.projects.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "owner",
3 });

パラメーター

accountId：Frameio.Uuid —

projectId：Frameio.Uuid —

request：Frameio.ProjectsShowRequest

requestOptions：Projects.RequestOptions

client.projects.delete(accountId, projectId) -> void

プロジェクトを削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 await client.projects.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメーター

accountId：Frameio.Uuid` —

projectId：Frameio.Uuid —

requestOptions：Projects.RequestOptions

client.projects.update(accountId, projectId, { ...params }) -> Frameio.ProjectResponse

プロジェクトの詳細を更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "Project Name",
4         restricted: true,
5         status: "active",
6     },
7 });

パラメーター

accountId：Frameio.Uuid —

projectId：Frameio.Uuid —

request：Frameio.ProjectUpdateParams

requestOptions：Projects.RequestOptions

client.projects.index(accountId, workspaceId, { ...params }) -> core.Page<Frameio.ProjectWithIncludes>

特定のワークスペース内のプロジェクトをリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 const response = await client.projects.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         include: "owner",
6         after: "<opaque_cursor>",
7         page_size: 10,
8         include_total_count: false,
9     },
10 );
11 for await (const item of response) {
12     console.log(item);
13 }
14 
15 // Or you can manually iterate page-by-page
16 let page = await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
17     include: "owner",
18     after: "<opaque_cursor>",
19     page_size: 10,
20     include_total_count: false,
21 });
22 while (page.hasNextPage()) {
23     page = page.getNextPage();
24 }

パラメーター

accountId：Frameio.Uuid —

workspaceId：Frameio.Uuid —

request：Frameio.ProjectsIndexRequest

requestOptions：Projects.RequestOptions

client.projects.create(accountId, workspaceId, { ...params }) -> Frameio.ProjectResponse

特定のワークスペースにプロジェクトを作成します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.projects.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "Project Name",
4         restricted: true,
5     },
6 });

パラメーター

accountId：Frameio.Uuid —

workspaceId：Frameio.Uuid —

request：Frameio.ProjectsParams

requestOptions：Projects.RequestOptions

フォルダー

client.folders.show(accountId, folderId, { ...params }) -> Frameio.FolderWithIncludesResponse

フォルダーの詳細を表示します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3 });

パラメーター

accountId：Frameio.Uuid —

projectId：Frameio.Uuid —

request：Frameio.FoldersShowRequest

requestOptions：Folders.RequestOptions

client.folders.delete(accountId, folderId) -> void

id でフォルダーを削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメーター

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

requestOptions：Folders.RequestOptions

client.folders.update(accountId, folderId, { ...params }) -> Frameio.FolderResponse

フォルダーの詳細を更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "Folder name",
4     },
5 });

パラメーター

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FolderUpdateParams

requestOptions：Folders.RequestOptions

client.folders.index(accountId, folderId, { ...params }) -> Frameio.AssetsWithIncludesResponse

指定されたフォルダー内の子をリストします。 include クエリパラメーターを使用して、レスポンスに追加のプロパティを選択的に含めます。

media_links.original が含まれ、ユーザーが対応するプロジェクト内のファイルをダウンロードする権限を持っていない場合、このエンドポイントは 403 Forbidden エラーで応答します。このユーザーに透かしが必要であり、リクエストされた media_links でサポートされていないためにコンテンツにアクセスできない場合、リクエストは成功しますが、サポートされていないメディアリンクは null に設定されます。同様に、特定のファイルのリクエストされたトランスコードリンクが存在しない場合（例：静的な画像ファイルに media_links.video_h264_180 を含む場合）またはトランスコードプロセスが完了していない場合（ファイルのステータスが「transcoded」ではなく「uploaded」である場合）、レスポンスペイロードでメディアリンクも null に設定されます。つまり、クライアントが null メディアリンクを適切に処理する必要があります。

レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3     type: "file,folder,version_stack",
4     after: "<opaque_cursor>",
5     page_size: 10,
6     include_total_count: false,
7 });

パラメーター

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FolderIndexRequest

requestOptions：Folders.RequestOptions

client.folders.copy(accountId, folderId, { ...params }) -> Frameio.FolderCopyResponse

フォルダーをコピーします。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     copy_metadata: true,
3     data: {
4         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
5     },
6 });

パラメーター

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FolderCopyParams

requestOptions：Folders.RequestOptions

client.folders.list(accountId, folderId, { ...params }) -> Frameio.FoldersWithIncludesResponse

特定のフォルダー内のフォルダーをリストします。レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

パラメーター

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FoldersListRequest

requestOptions：Folders.RequestOptions

client.folders.create(accountId, folderId, { ...params }) -> Frameio.FolderResponse

指定された folder_id パスパラメーター内に新しいフォルダーを作成します。レート制限：account_user あたり 1 秒ごとに 3 呼び出し

usage

1 await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "Folder name",
4     },
5 });

パラメーター

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FolderCreateParams

requestOptions：Folders.RequestOptions

client.folders.move(accountId, folderId, { ...params }) -> Frameio.FolderResponse

フォルダーを特定のフォルダーに移動します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
4     },
5 });

パラメーター

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FolderMoveParams

requestOptions：Folders.RequestOptions

バージョンスタック

client.versionStacks.index(accountId, versionStackId, { ...params }) -> Frameio.AssetsWithIncludesResponse

特定のバージョンスタック内の子（ファイル）をリストします。
include クエリパラメーターを使用して、レスポンスに追加のプロパティを選択的に含めます。

media_links.original が含まれ、ユーザーが対応するプロジェクト内のファイルをダウンロードする権限を持っていない場合、このエンドポイントは 403 Forbidden エラーで応答します。このユーザーに透かしが必要であり、リクエストされた media_links でサポートされていないためにコンテンツにアクセスできない場合、リクエストは成功しますが、サポートされていないメディアリンクは null に設定されます。同様に、特定のファイルのリクエストされたトランスコードリンクが存在しない場合（例：静的な画像ファイルに including media_links.video_h264_180 がある場合）またはトランスコードプロセスが完了していない場合（ファイルのステータスが「transcoded」ではなく「uploaded」である場合）、レスポンスペイロードでメディアリンクも null に設定されます。つまり、クライアントが null メディアリンクを適切に処理する必要があります。

レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

パラメーター

accountId：Frameio.Uuid —

projectId：Frameio.Uuid —

request：Frameio.VersionStacksIndexRequest

requestOptions：VersionStacks.RequestOptions

client.versionStacks.show(accountId, versionStackId, { ...params }) -> Frameio.VersionStackWithIncludesResponse

バージョンスタックの詳細を表示します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3 });

パラメーター

accountId：Frameio.Uuid —

versionStackId：Frameio.Uuid —

request：Frameio.VersionStacksShowRequest

requestOptions：VersionStacks.RequestOptions

client.versionStacks.copy(accountId, versionStackId, { ...params }) -> Frameio.VersionStackCopyResponse

バージョンスタックをコピーします。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     copy_metadata: true,
3     data: {
4         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
5     },
6 });

パラメーター

accountId：Frameio.Uuid —

versionStackId：Frameio.Uuid —

request：Frameio.VersionStackCopyParams

requestOptions：VersionStacks.RequestOptions

client.versionStacks.list(accountId, folderId, { ...params }) -> Frameio.VersionStacksWithIncludesResponse

特定のフォルダー内のバージョンスタックをリストします。
レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

パラメーター

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.VersionStacksListRequest

requestOptions：VersionStacks.RequestOptions

client.versionStacks.create(accountId, folderId, { ...params }) -> Frameio.VersionStackWithIncludesResponse

親フォルダーの下に新しいバージョンスタックを作成します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         file_ids: ["dd2a3cdd-fc90-41bd-a7b8-8a0447aec6d4", "79fed48a-8372-496e-8dcb-5e959b9b9fcf"],
4     },
5 });

パラメーター

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.VersionStackCreateParams

requestOptions：VersionStacks.RequestOptions

client.versionStacks.move(accountId, versionStackId, { ...params }) -> Frameio.VersionStackResponse

バージョンスタックをフォルダーに移動します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
4     },
5 });

パラメーター

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.VersionStackMoveParams

requestOptions：VersionStacks.RequestOptions

アカウント権限

client.accountPermissions.index(accountId, { ...params }) -> core.Page<Frameio.AccountUserRole>

特定のアカウントのユーザーロールをリストします。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 const response = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include_deactivated: true,
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });
7 for await (const item of response) {
8     console.log(item);
9 }
10 
11 // Or you can manually iterate page-by-page
12 let page = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
13     include_deactivated: true,
14     after: "<opaque_cursor>",
15     page_size: 10,
16     include_total_count: false,
17 });
18 while (page.hasNextPage()) {
19     page = page.getNextPage();
20 }

パラメーター

accountId：Frameio.Uuid —

request：Frameio.AccountPermissionsIndexRequest

requestOptions：AccountPermissions.RequestOptions

アカウント

client.accounts.index({ ...params }) -> core.Page<Frameio.Account>

現在のユーザーのアカウントをリストします。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 const response = await client.accounts.index({
2     after: "<opaque_cursor>",
3     page_size: 10,
4     include_total_count: false,
5 });
6 for await (const item of response) {
7     console.log(item);
8 }
9 
10 // Or you can manually iterate page-by-page
11 let page = await client.accounts.index({
12     after: "<opaque_cursor>",
13     page_size: 10,
14     include_total_count: false,
15 });
16 while (page.hasNextPage()) {
17     page = page.getNextPage();
18 }

パラメーター

request：Frameio.AccountsIndexRequest

requestOptions：Accounts.RequestOptions

client.comments.show(accountId, commentId, { ...params }) -> Frameio.CommentWithIncludesResponse

ファイルへの単一コメントを表示します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "owner",
3 });

パラメーター accountId：Frameio.Uuid —

commentId：Frameio.Uuid —

request：Frameio.CommentsShowRequest

requestOptions：Comments.RequestOptions

client.comments.delete(accountId, commentId) -> void

アセットからコメントを削除します。
レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメーター accountId：Frameio.Uuid —

commentId：Frameio.Uuid —

requestOptions：Comments.RequestOptions

client.comments.update(accountId, commentId, { ...params }) -> Frameio.CommentResponse

指定されたアセットへのコメントを更新します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     timestamp_as_timecode: true,
3     data: {
4         annotation:
5             '[{"tool":"rect","color":"#F22237","size":8,"x":0.277726001863933,"y":0.12909555568499534,"w":0.3153168321877913,"h":0.5308131407269339,"ix":0.277726001863933,"iy":0.12909555568499534,"radius":8}]',
6         completed: false,
7         page: 4,
8         text: "This is great!",
9     },
10 });

パラメーター accountId：Frameio.Uuid —

commentId：Frameio.Uuid —

request：Frameio.UpdateCommentParams

requestOptions：Comments.RequestOptions

client.comments.index(accountId, fileId, { ...params }) -> core.Page<Frameio.CommentWithIncludes>

特定のアセットへのコメントをリストします。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 const response = await client.comments.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         include: "owner",
6         after: "<opaque_cursor>",
7         page_size: 10,
8         include_total_count: false,
9     },
10 );
11 for await (const item of response) {
12     console.log(item);
13 }
14 
15 // Or you can manually iterate page-by-page
16 let page = await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
17     include: "owner",
18     after: "<opaque_cursor>",
19     page_size: 10,
20     include_total_count: false,
21 });
22 while (page.hasNextPage()) {
23     page = page.getNextPage();
24 }

パラメーター accountId：Frameio.Uuid —

fileId：Frameio.Uuid —

request：Frameio.CommentsIndexRequest

requestOptions：Comments.RequestOptions

client.comments.create(accountId, fileId, { ...params }) -> Frameio.CommentResponse

ファイルへのコメントを作成します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     timestamp_as_timecode: true,
3     data: {
4         annotation:
5             '[{"tool":"rect","color":"#F22237","size":8,"x":0.277726001863933,"y":0.12909555568499534,"w":0.3153168321877913,"h":0.5308131407269339,"ix":0.277726001863933,"iy":0.12909555568499534,"radius":8}]',
6         completed: false,
7         page: 4,
8         text: "This is great!",
9         timestamp: "00:00:02:12",
10     },
11 });

パラメーター accountId：Frameio.Uuid —

fileId：Frameio.Uuid —

request：Frameio.CreateCommentParams

requestOptions：Comments.RequestOptions

Webhook

client.webhooks.index(accountId, workspaceId, { ...params }) -> core.Page<Frameio.WebhookWithIncludes>

指定されたワークスペースの webhook をリストします。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 const response = await client.webhooks.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         include: "creator",
6         after: "<opaque_cursor>",
7         page_size: 10,
8         include_total_count: false,
9     },
10 );
11 for await (const item of response) {
12     console.log(item);
13 }
14 
15 // Or you can manually iterate page-by-page
16 let page = await client.webhooks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
17     include: "creator",
18     after: "<opaque_cursor>",
19     page_size: 10,
20     include_total_count: false,
21 });
22 while (page.hasNextPage()) {
23     page = page.getNextPage();
24 }

パラメーター accountId：Frameio.Uuid —

workspaceId：Frameio.Uuid —

request：Frameio.WebhooksIndexRequest

requestOptions：Webhooks.RequestOptions

client.webhooks.create(accountId, workspaceId, { ...params }) -> Frameio.WebhookCreateResponse

シークレットで単一 webhook を作成します。
有効なイベント：

file.created、 file.deleted、 file.ready、 file.updated、 file.upload.completed、 file.versioned、 file.copied、 folder.created、 folder.deleted、 folder.updated、 folder.copied、 comment.completed、 comment.created、 comment.deleted、 comment.uncompleted、 comment.updated、 customfield.created、 customfield.updated、 customfield.deleted、 metadata.value.updated、 project.created、 project.deleted、 project.updated、 collection.created、 collection.updated、 collection.deleted、 share.created、 share.updated、 share.deleted、 share.viewed レート制限：アカウントあたり 1.00 分ごとに 10 呼び出し

usage

1 await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         events: [
4             "file.created",
5             "file.deleted",
6             "file.ready",
7             "file.updated",
8             "file.upload.completed",
9             "file.versioned",
10             "file.copied",
11             "folder.created",
12             "folder.deleted",
13             "folder.updated",
14             "folder.copied",
15             "comment.completed",
16             "comment.created",
17             "comment.deleted",
18             "comment.uncompleted",
19             "comment.updated",
20             "customfield.created",
21             "customfield.updated",
22             "customfield.deleted",
23             "metadata.value.updated",
24             "project.created",
25             "project.deleted",
26             "project.updated",
27             "collection.created",
28             "collection.updated",
29             "collection.deleted",
30             "share.created",
31             "share.updated",
32             "share.deleted",
33             "share.viewed",
34         ],
35         name: "New Webhook",
36         url: "https://url.example.com",
37     },
38 });

パラメーター accountId：Frameio.Uuid —

workspaceId：Frameio.Uuid —

request：Frameio.WebhookCreateParams

requestOptions：Webhooks.RequestOptions

client.webhooks.show(accountId, webhookId, { ...params }) -> Frameio.WebhookWithIncludesResponse

Webhook の詳細を表示します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3 });

パラメーター accountId：Frameio.Uuid —

webhookId：Frameio.Uuid —

request：Frameio.WebhooksShowRequest

requestOptions：Webhooks.RequestOptions

client.webhooks.delete(accountId, webhookId) -> void

Webhook を削除します。
レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメーター accountId：Frameio.Uuid —

webhookId：Frameio.Uuid —

requestOptions：Webhooks.RequestOptions

client.webhooks.update(accountId, webhookId, { ...params }) -> Frameio.WebhookResponse

Webhook の詳細を更新します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         active: true,
4         events: [
5             "file.created",
6             "file.deleted",
7             "file.ready",
8             "file.updated",
9             "file.upload.completed",
10             "file.versioned",
11             "file.copied",
12             "folder.created",
13             "folder.deleted",
14             "folder.updated",
15             "folder.copied",
16             "comment.completed",
17             "comment.created",
18             "comment.deleted",
19             "comment.uncompleted",
20             "comment.updated",
21             "customfield.created",
22             "customfield.updated",
23             "customfield.deleted",
24             "metadata.value.updated",
25             "project.created",
26             "project.deleted",
27             "project.updated",
28             "collection.created",
29             "collection.updated",
30             "collection.deleted",
31             "share.created",
32             "share.updated",
33             "share.deleted",
34             "share.viewed",
35         ],
36         name: "Updated Webhook",
37         url: "https://url.example.com",
38     },
39 });

パラメーター accountId：Frameio.Uuid —

webhookId：Frameio.Uuid — request: Frameio.WebhookUpdateParams`

requestOptions：Webhooks.RequestOptions

ワークスペースの権限

client.workspacePermissions.index(accountId, workspaceId, { ...params }) -> core.Page<Frameio.UserRole>

特定のワークスペースのユーザーロールをリストします。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 const response = await client.workspacePermissions.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         include_deactivated: true,
6         after: "<opaque_cursor>",
7         page_size: 10,
8         include_total_count: false,
9     },
10 );
11 for await (const item of response) {
12     console.log(item);
13 }
14 
15 // Or you can manually iterate page-by-page
16 let page = await client.workspacePermissions.index(
17     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
18     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
19     {
20         include_deactivated: true,
21         after: "<opaque_cursor>",
22         page_size: 10,
23         include_total_count: false,
24     },
25 );
26 while (page.hasNextPage()) {
27     page = page.getNextPage();
28 }

パラメーター accountId：Frameio.Uuid —

workspaceId：Frameio.Uuid —

request：Frameio.WorkspacePermissionsIndexRequest

requestOptions：WorkspacePermissions.RequestOptions

client.workspacePermissions.workspaceUserRolesDelete(accountId, workspaceId, userId) -> void

特定のワークスペースからユーザーを削除します。
レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 await client.workspacePermissions.workspaceUserRolesDelete(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5 );

パラメーター accountId：Frameio.Uuid —

workspaceId：Frameio.Uuid —

userId：Frameio.Uuid —

requestOptions：WorkspacePermissions.RequestOptions

client.workspacePermissions.workspaceUserRolesUpdate(accountId, workspaceId, userId, { ...params }) -> Frameio.UpdateUserRolesResponse

ユーザーが既にワークスペースに追加されている場合は、指定されたワークスペースのユーザーロールを更新します。ワークスペースに追加されていないユーザーは、指定されたロールで追加されます。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.workspacePermissions.workspaceUserRolesUpdate(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5     {
6         data: {
7             role: "editor",
8         },
9     },
10 );

パラメーター accountId：Frameio.Uuid —

workspaceId：Frameio.Uuid —

userId：Frameio.Uuid —

request：Frameio.UpdateUserRolesParams

requestOptions：WorkspacePermissions.RequestOptions

ワークスペース

client.workspaces.show(accountId, workspaceId, { ...params }) -> Frameio.WorkspaceWithIncludesResponse

ワークスペースの詳細を表示します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.workspaces.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3 });

パラメーター accountId：Frameio.Uuid —

workspaceId：Frameio.Uuid —

request：Frameio.WorkspacesShowRequest

requestOptions：Workspaces.RequestOptions

client.workspaces.delete(accountId, workspaceId) -> void

アカウントからワークスペースを削除します。
レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 await client.workspaces.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメーター accountId：Frameio.Uuid —

workspaceId：Frameio.Uuid —

requestOptions：Workspaces.RequestOptions

client.workspaces.update(accountId, workspaceId, { ...params }) -> Frameio.WorkspaceResponse

ワークスペースを更新します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.workspaces.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "My Workspace",
4     },
5 });

パラメーター accountId：Frameio.Uuid —

workspaceId：Frameio.Uuid —

request：Frameio.WorkspaceParams

requestOptions：Workspaces.RequestOptions

client.workspaces.index(accountId, { ...params }) -> core.Page<Frameio.WorkspaceWithIncludes>

特定のアカウントのワークスペースをリストします。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 const response = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });
7 for await (const item of response) {
8     console.log(item);
9 }
10 
11 // Or you can manually iterate page-by-page
12 let page = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
13     include: "creator",
14     after: "<opaque_cursor>",
15     page_size: 10,
16     include_total_count: false,
17 });
18 while (page.hasNextPage()) {
19     page = page.getNextPage();
20 }

パラメーター accountId：Frameio.Uuid —

request：Frameio.WorkspacesIndexRequest

requestOptions：Workspaces.RequestOptions

client.workspaces.create(accountId, { ...params }) -> Frameio.WorkspaceResponse

アカウントからワークスペースを作成します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.workspaces.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "My Workspace",
4     },
5 });

パラメーター accountId：Frameio.Uuid —

request：Frameio.WorkspaceParams

requestOptions：Workspaces.RequestOptions

client.shares.show(accountId, shareId) -> Frameio.ShareResponse

単一共有を表示します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.shares.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメーター accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

requestOptions：Shares.RequestOptions

client.shares.delete(accountId, shareId) -> void

共有を削除します。
レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 await client.shares.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメーター accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

requestOptions：Shares.RequestOptions

client.shares.update(accountId, shareId, { ...params }) -> Frameio.ShareResponse

共有を更新します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.shares.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         access: "public",
4         description: "A descriptive summary of the share",
5         downloading_enabled: true,
6         expiration: "2026-01-22T17:04:53Z",
7         name: "Share Name",
8         passphrase: "as!dfj39sd(*",
9     },
10 });

パラメーター accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

request：Frameio.UpdateShareParams

requestOptions：Shares.RequestOptions

client.shares.listReviewers(accountId, shareId, { ...params }) -> core.Page<Frameio.User>

共有レビュアーをリストします。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 const response = await client.shares.listReviewers(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         after: "<opaque_cursor>",
6         page_size: 10,
7         include_total_count: false,
8     },
9 );
10 for await (const item of response) {
11     console.log(item);
12 }
13 
14 // Or you can manually iterate page-by-page
15 let page = await client.shares.listReviewers(
16     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
17     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
18     {
19         after: "<opaque_cursor>",
20         page_size: 10,
21         include_total_count: false,
22     },
23 );
24 while (page.hasNextPage()) {
25     page = page.getNextPage();
26 }

パラメーター accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

request：Frameio.SharesListReviewersRequestreParams

requestOptions：Shares.RequestOptions

client.shares.addReviewers(accountId, shareId, { ...params }) -> void

次の 3 つの識別子タイプにより、レビュアーを安全な共有に追加します：adobe_user_id、email、user_id。リクエストには、識別子タイプパラメーターを 1 つのみ含めることができます。 email は、共有が属しているアカウントで Frame アカウントメンバーを持たないレビュアーを共有に追加できる唯一の識別子です。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.shares.addReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         message: "Please join my share!",
4         reviewers: {
5             emails: ["email1@domain.com", "email2@domain.com"],
6         },
7     },
8 });

パラメーター accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

request：Frameio.AddReviewersToShareParams

requestOptions：Shares.RequestOptions

client.shares.removeReviewers(accountId, shareId, { ...params }) -> void

次の 3 つの識別子タイプにより、安全な共有からレビュアーを削除します：adobe_user_id、email、user_id。リクエストには、識別子タイプパラメーターを 1 つのみ含めることができます。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.shares.removeReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         reviewers: {
4             adobe_user_ids: ["2A3C1A3D66C621B20A494021@176719f5667c82b4499999.e"],
5         },
6     },
7 });

パラメーター accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

request：Frameio.RemoveReviewerParams

requestOptions：Shares.RequestOptions

client.shares.removeAsset(accountId, shareId, assetId) -> Frameio.RemoveAssetResponse

共有から現在、その共有にあるアセットを削除します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.shares.removeAsset(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5 );

パラメーター accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

assetId：Frameio.Uuid —

requestOptions：Shares.RequestOptions

client.shares.addAsset(accountId, shareId, { ...params }) -> Frameio.AddAssetResponse

新しいアセット共有を追加します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         asset_id: "0cc1cb59-1d7c-4176-8532-afe099897318",
4     },
5 });

パラメーター accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

request：Frameio.AddAssetParams

requestOptions：Shares.RequestOptions

client.shares.index(accountId, projectId, { ...params }) -> core.Page<Frameio.Share>

プロジェクト上の共有をリストします。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 const response = await client.shares.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         after: "<opaque_cursor>",
6         page_size: 10,
7         include_total_count: false,
8     },
9 );
10 for await (const item of response) {
11     console.log(item);
12 }
13 
14 // Or you can manually iterate page-by-page
15 let page = await client.shares.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
16     after: "<opaque_cursor>",
17     page_size: 10,
18     include_total_count: false,
19 });
20 while (page.hasNextPage()) {
21     page = page.getNextPage();
22 }

パラメーター accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

request：Frameio.SharesIndexRequest

requestOptions：Shares.RequestOptions

client.shares.create(accountId, projectId, { ...params }) -> Frameio.ShareResponse

共有を作成します。
レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 await client.shares.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         type: "asset",
4         access: "public",
5         asset_ids: ["12eb1446-5736-4f93-85fc-3b636f156211", "f23a3b3e-7b1f-4655-b91a-acf0566e5bb9"],
6         downloading_enabled: true,
7         expiration: "2026-01-22T17:04:53Z",
8         name: "Share Name",
9         passphrase: "as!dfj39sd(*",
10     },
11 });

パラメーター accountId：Frameio.Uuid —

projectId：Frameio.Uuid —

request：Frameio.CreateShareParams

requestOptions：Shares.RequestOptions

ファイル

client.files.list(accountId, folderId, { ...params }) -> Frameio.AssetsWithIncludesResponse

指定されたフォルダー内のファイルをリストします。
レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

パラメーター accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FilesListRequest

requestOptions：Files.RequestOptions

client.files.create(accountId, folderId, { ...params }) -> Frameio.FileWithUploadUrlsResponse

親フォルダーの下に新しいファイルを作成します。Create file (local upload) および Create file (remote upload) は、このエンドポイントを置換しています。
レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         file_size: 1137444,
4         media_type: "image/png",
5         name: "asset.png",
6     },
7 });

パラメーター accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FileCreateParams

requestOptions：Files.RequestOptions

client.files.show(accountId, fileId, { ...params }) -> Frameio.FileWithIncludesResponse

ファイルの詳細を表示します。
include クエリパラメーターを使用して、レスポンスに追加のプロパティを選択的に含めます。

media_links.original が含まれ、ユーザーがファイルをダウンロードする権限を持っていない場合、このエンドポイントは 403 Forbidden エラーで応答します。このユーザーに透かしが必要であり、リクエストされた media_links でサポートされていないためにコンテンツにアクセスできない場合、リクエストは成功しますが、サポートされていないメディアリンクは null に設定されます。同様に、特定のファイルのリクエストされたトランスコードリンクが存在しない場合（例：静的な画像ファイルに media_links.video_h264_180 を含む場合）またはトランスコードプロセスが完了していない場合（ファイルのステータスが「transcoded」ではなく「uploaded」である場合）、レスポンスペイロードでリンクも null に設定されます。つまり、クライアントが null メディアリンクを適切に処理する必要があります。

レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3 });

パラメーター accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FilesShowRequest

requestOptions：Files.RequestOptions

client.files.delete(accountId, fileId) -> void

ID でファイルを削除します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメーター accountId：Frameio.Uuid —

fileId：Frameio.Uuid —

requestOptions：Files.RequestOptions

client.files.update(accountId, fileId, { ...params }) -> Frameio.FileResponse

ファイルの詳細を更新します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "asset.png",
4     },
5 });

パラメーター accountId：Frameio.Uuid —

fileId：Frameio.Uuid —

request：Frameio.FileUpdateParams

requestOptions：Files.RequestOptions

client.files.copy(accountId, fileId, { ...params }) -> Frameio.FileCopyResponse

ファイルをコピーします。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     copy_metadata: true,
3     copy_comments: "none",
4     data: {
5         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
6     },
7 });

パラメーター accountId：Frameio.Uuid —

fileId：Frameio.Uuid —

request：Frameio.FileCopyParams

requestOptions：Files.RequestOptions

client.files.createRemoteUpload(accountId, folderId, { ...params }) -> Frameio.FileRemoteUploadResponse

リモートアップロードを通じて、親フォルダーの下に新しいファイルを作成します。
レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 await client.files.createRemoteUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "asset.png",
4         source_url: "https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png",
5     },
6 });

パラメーター accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FileCreateRemoteUploadParams

requestOptions：Files.RequestOptions

client.files.move(accountId, fileId, { ...params }) -> Frameio.FileResponse

ファイルをフォルダーまたは version_stack に移動します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
4     },
5 });

パラメーター accountId：Frameio.Uuid —

fileId：Frameio.Uuid —

request：Frameio.FileMoveParams

requestOptions：Files.RequestOptions

client.files.createLocalUpload(accountId, folderId, { ...params }) -> Frameio.FileWithUploadUrlsResponse

ローカルアップロードを通じて、親フォルダーの下に新しいファイルを作成します。
レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         file_size: 1137444,
4         name: "asset.png",
5     },
6 });

パラメーター accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FileCreateLocalUploadParams

requestOptions：Files.RequestOptions

client.files.showFileUploadStatus(accountId, fileId) -> Frameio.FileUploadStatusResponse

ファイルアップロードステータスの詳細を表示します。
レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメーター accountId：Frameio.Uuid —

fileId：Frameio.Uuid —

requestOptions：Files.RequestOptions

ユーザー

client.users.show() -> Frameio.ProfileResponse

ベアラートークンに関連付けられているユーザーの詳細を確認します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 await client.users.show();

パラメーター requestOptions：Users.RequestOptions

npm

npm での表示

1	import { FrameioClient } from "frameio";
2
3	const client = new FrameioClient({ token: "YOUR_TOKEN" });
4	await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5	data: {
6	field_type: "select",
7	field_configuration: {
8	enable_add_new: false,
9	options: [
10	{
11	display_name: "Option 1",
12	},
13	{
14	display_name: "Option 2",
15	},
16	],
17	},
18	name: "Fields definition name",
19	},
20	});

1	import { Frameio } from "frameio";
2
3	const request: Frameio.UpdateFieldDefinitionParams = {
4	...
5	};

1	import { FrameioError } from "frameio";
2
3	try {
4	await client.metadataFields.metadataFieldDefinitionsCreate(...);
5	} catch (err) {
6	if (err instanceof FrameioError) {
7	console.log(err.statusCode);
8	console.log(err.message);
9	console.log(err.body);
10	console.log(err.rawResponse);
11	}
12	}

1	const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2	headers: {
3	'X-Custom-Header': 'custom value'
4	}
5	});

1	const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2	queryParams: {
3	'customQueryParamKey': 'custom query param value'
4	}
5	});

1	const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2	maxRetries: 0 // override maxRetries at the request level
3	});

1	const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2	timeoutInSeconds: 30 // override timeout to 30s
3	});

1	const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2	abortSignal: controller.signal
3	});
4	controller.abort(); // aborts the request

1	const { data, rawResponse } = await client.metadataFields.metadataFieldDefinitionsCreate(...).withRawResponse();
2
3	console.log(data);
4	console.log(rawResponse.headers['X-My-Header']);

1	import { FrameioClient } from "frameio";
2
3	const client = new FrameioClient({
4	...
5	fetcher: // provide your implementation here
6	});

1	await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	data: {
3	file_ids: ["09b31c2a-04de-464a-a593-643a36ef0d98", "b967fc36-4e18-4b48-a3ab-c790100e2baa"],
4	values: [
5	{
6	field_definition_id: "ff41ce50-269b-4624-8306-aac10e28ab94",
7	value: [
8	{
9	id: "e60f47b4-cf8e-4273-96d5-3258a830a0aa",
10	type: "user",
11	},
12	{
13	id: "24eeaf7e-ce27-4555-bc77-cce39900626d",
14	type: "account_user_group",
15	},
16	],
17	},
18	],
19	},
20	});

1	await client.metadata.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	show_null: true,
3	});

1	await client.metadataFields.metadataFieldDefinitionsDelete(
2	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4	);

1	await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	include: "creator",
3	after: "<opaque_cursor>",
4	page_size: 10,
5	include_total_count: false,
6	});

1	const response = await client.projectPermissions.index(
2	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4	{
5	include_deactivated: true,
6	after: "<opaque_cursor>",
7	page_size: 10,
8	include_total_count: false,
9	},
10	);
11	for await (const item of response) {
12	console.log(item);
13	}
14
15	// Or you can manually iterate page-by-page
16	let page = await client.projectPermissions.index(
17	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
18	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
19	{
20	include_deactivated: true,
21	after: "<opaque_cursor>",
22	page_size: 10,
23	include_total_count: false,
24	},
25	);
26	while (page.hasNextPage()) {
27	page = page.getNextPage();
28	}

1	await client.projectPermissions.delete(
2	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5	);

1	await client.projectPermissions.projectUserRolesUpdate(
2	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5	{
6	data: {
7	role: "editor",
8	},
9	},
10	);

1	await client.projects.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	include: "owner",
3	});

1	await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	data: {
3	name: "Project Name",
4	restricted: true,
5	status: "active",
6	},
7	});

1	const response = await client.projects.index(
2	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3	"b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4	{
5	include: "owner",
6	after: "<opaque_cursor>",
7	page_size: 10,
8	include_total_count: false,
9	},
10	);
11	for await (const item of response) {
12	console.log(item);
13	}
14
15	// Or you can manually iterate page-by-page
16	let page = await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
17	include: "owner",
18	after: "<opaque_cursor>",
19	page_size: 10,
20	include_total_count: false,
21	});
22	while (page.hasNextPage()) {
23	page = page.getNextPage();
24	}

1	await client.projects.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	data: {
3	name: "Project Name",
4	restricted: true,
5	},
6	});

1	await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	include: "creator",
3	});

1	await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	data: {
3	name: "Folder name",
4	},
5	});

1	await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	include: "media_links",
3	type: "file,folder,version_stack",
4	after: "<opaque_cursor>",
5	page_size: 10,
6	include_total_count: false,
7	});

1	await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	copy_metadata: true,
3	data: {
4	parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
5	},
6	});

1	await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	include: "creator",
3	after: "<opaque_cursor>",
4	page_size: 10,
5	include_total_count: false,
6	});

1	await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	data: {
3	name: "Folder name",
4	},
5	});

1	await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	data: {
3	parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
4	},
5	});

1	await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	include: "media_links",
3	after: "<opaque_cursor>",
4	page_size: 10,
5	include_total_count: false,
6	});

1	await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2	include: "media_links",
3	});