Referência da SDK

Referência do SDK para TypeScript

Instalação

$npm i -s frameio

Uso

Instancie e use o cliente com o seguinte:

1import { FrameioClient } from "frameio";
2
3const client = new FrameioClient({ token: "YOUR_TOKEN" });
4await 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});

Tipos de solicitação e resposta

O SDK exporta todos os tipos de solicitação e resposta como interfaces TypeScript. Basta importá-los com o seguinte namespace:

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

Tratamento de exceções

Quando a API retorna um código de status sem sucesso (resposta 4xx ou 5xx), uma subclasse do erro a seguir será gerada.

1import { FrameioError } from "frameio";
2
3try {
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}

Avançado

Cabeçalhos adicionais

Se quiser enviar cabeçalhos adicionais como parte da solicitação, use a opção de solicitação headers.

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

Parâmetros adicionais da string de consulta

Se quiser enviar parâmetros adicionais da string de consulta como parte da solicitação, use a opção de solicitação queryParams.

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

Tentativas

O SDK é instrumentado com novas tentativas automáticas com backoff exponencial. Uma solicitação será repetida enquanto a solicitação for considerada repetível e o número de tentativas não tiver ultrapassado o limite configurado de novas tentativas (padrão: 2).

Uma solicitação é considerada repetível quando qualquer um dos seguintes códigos de status HTTP é retornado:

  • 408 (Tempo-limite)
  • 429 (Muitas solicitações)
  • 5XX (Erros internos do servidor)


Use a opção de solicitação maxRetries para configurar esse comportamento.

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

Tempos-limite

O SDK usa um tempo-limite padrão de 60 segundos. Use a opção timeoutInSeconds para configurar esse comportamento.

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

Cancelamento de solicitações

O SDK permite que os usuários cancelem solicitações a qualquer momento passando um sinal de cancelamento.

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

Acessar dados brutos da resposta

O SDK fornece acesso aos dados brutos da resposta, incluindo cabeçalhos, por meio do método .withRawResponse().O método .withRawResponse() retorna uma promise que resulta em um objeto com uma propriedade data e uma propriedade rawResponse.

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

Compatibilidade de tempo de execução

O SDK funciona nos seguintes tempos de execução:

  • Node.js 18+
  • Vercel
  • Cloudflare Workers
  • Deno v1.25+
  • Bun 1.0+
  • React Native

Personalização do cliente Fetch

O SDK fornece uma forma de personalizar o cliente HTTP / função Fetch subjacente. Se você estiver executando em um ambiente sem suporte, isso oferece uma forma de contornar a limitação e garantir que o SDK funcione.

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

Referência

Permissões da conta

Listar funções de usuário para uma determinada conta.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1const 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});
7for await (const item of response) {
8    console.log(item);
9}
10
11// Or you can manually iterate page-by-page
12let 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});
18while (page.hasNextPage()) {
19    page = page.getNextPage();
20}

Parâmetros

accountId: Frameio.Uuid —

request: Frameio.AccountPermissionsIndexRequest

requestOptions: AccountPermissions.RequestOptions

Contas

Listar contas do usuário atual.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

request: Frameio.AccountsIndexRequest

requestOptions: Accounts.RequestOptions

Listar logs de auditoria com recursos de filtragem por meio de parâmetros de consulta*

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.FrameOrAdobeId —

request: Frameio.AuditlogIndexRequest

requestOptions: Accounts.RequestOptions

Autenticação

Autentica usando a concessão OAuth 2.0 client_credentials.Esse fluxo não envolve um usuário e não retorna um token de atualização. Quando o token de acesso expira, o SDK solicita automaticamente um novo usando as credenciais de cliente.

usage
1import { FrameioClient, ServerToServerAuth } from "frameio";
2
3const auth = new ServerToServerAuth({
4    clientId: "YOUR_CLIENT_ID",
5    clientSecret: "YOUR_CLIENT_SECRET",
6});
7const client = new FrameioClient({ token: () => auth.getToken() });

Parâmetros

clientId: string — ID de cliente OAuth do Adobe IMS.

clientSecret: string — Client secret OAuth do Adobe IMS.

scopes: string — Escopos separados por espaços (OAuth 2.0 RFC 6749).O padrão são os escopos Server-to-Server.

imsBaseUrl: string — URL base do IMS para ambientes de staging/alternativos.O padrão é produção.

fetch: typeof fetch — Implementação de fetch personalizada (para proxy, TLS, etc.).

onTokenRefreshed: OnTokenRefreshed — Callback opcional disparado após cada busca de token.

timeout: number — Tempo-limite de solicitação HTTP em segundos.O padrão é 30000.

maxRetries: number — Máximo de repetições para falhas transitórias.O padrão é 2.

refreshBuffer: number — Segundos antes da expiração para acionar atualização proativa.O padrão é 60.

logger: Logger — Instância de logger para saída de diagnóstico.

Métodos

getToken(): Promise<string> — Retorna um token de acesso válido, atualizando-o se necessário. Passe-o ao cliente: new FrameioClient({ token: () => auth.getToken() }).

authenticate(): Promise<TokenResponse> — Busca explicitamente um novo token de acesso.

revoke(): Promise<void> — Revoga tokens no lado do servidor e limpa o estado local.

exportTokens(): ExportedTokens — Exporta o estado atual de tokens para persistência.

importTokens(data: ExportedTokens): void — Restaura o estado de tokens de um objeto exportado anteriormente.

Autentica usando a concessão OAuth 2.0 authorization_code.Use isso para aplicativos do lado do servidor que podem armazenar um client secret com segurança.

usage
1import { randomBytes } from "crypto";
2import { FrameioClient, WebAppAuth } from "frameio";
3
4const auth = new WebAppAuth({
5    clientId: "YOUR_CLIENT_ID",
6    clientSecret: "YOUR_CLIENT_SECRET",
7    redirectUri: "https://myapp.com/callback",
8});
9const url = auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") });
10// redirect the user to url ...
11await auth.exchangeCode("CODE_FROM_CALLBACK");
12const client = new FrameioClient({ token: () => auth.getToken() });

Parâmetros

clientId: string — ID de cliente OAuth do Adobe IMS.

clientSecret: string — Client secret OAuth do Adobe IMS.

redirectUri: string — URI de redirecionamento registrado.

scopes: string — Escopos separados por espaços (OAuth 2.0 RFC 6749).

imsBaseUrl: string — URL base do IMS para ambientes de staging/alternativos.O padrão é produção.

fetch: typeof fetch — Implementação de fetch personalizada (para proxy, TLS, etc.).

onTokenRefreshed: OnTokenRefreshed — Callback opcional acionado após cada atualização de token

timeout: number — Tempo-limite de solicitação HTTP em segundos.O padrão é 30000.

maxRetries: number — Máximo de repetições para falhas transitórias.O padrão é 2.

refreshBuffer: number — Segundos antes da expiração para acionar atualização proativa.O padrão é 60.

logger: Logger — Instância de logger para saída de diagnóstico.

Métodos

getToken(): Promise<string> — Retorna um token de acesso válido, atualizando-o se necessário.

getAuthorizationUrl({ state }): string — Cria o URL de autorização do Adobe IMS. Passe um valor CSRF/state opaco que será ecoado de volta.

exchangeCode(code: string): Promise<TokenResponse> — Troca um código de autorização + verificador PKCE por tokens.

refresh(): Promise<TokenResponse> — Aciona manualmente uma atualização de token.

revoke(): Promise<void> — Revoga tokens no lado do servidor e limpa o estado local.

exportTokens(): ExportedTokens — Exporta o estado atual de tokens para persistência.

importTokens(data: ExportedTokens): void — Restaura o estado de tokens de um objeto exportado anteriormente.

Autentica usando authorization_code + PKCE para aplicativos desktop e móveis.Use isto para aplicativos de página única baseados em navegador que não podem armazenar um Client Secret com segurança.

usage
1import { randomBytes } from "crypto";
2import { FrameioClient, SPAAuth } from "frameio";
3
4const auth = new SPAAuth({
5    clientId: "YOUR_CLIENT_ID",
6    redirectUri: "https://myapp.com/cb",
7});
8const result = await auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") });
9// redirect the user to result.url, store result.codeVerifier ...
10await auth.exchangeCode({ code: "CODE_FROM_CALLBACK", codeVerifier: result.codeVerifier });
11const client = new FrameioClient({ token: () => auth.getToken() });

Parâmetros

clientId: string — ID de cliente OAuth do Adobe IMS.

redirectUri: string — URI de redirecionamento registrado.

scopes: string — Escopos separados por espaços (OAuth 2.0 RFC 6749).

imsBaseUrl: string — URL base do IMS para ambientes de staging/alternativos.O padrão é produção.

fetch: typeof fetch — Implementação de fetch personalizada (para proxy, TLS, etc.).

onTokenRefreshed: OnTokenRefreshed — Callback opcional acionado após cada atualização de token

timeout: number — Tempo-limite de solicitação HTTP em segundos.O padrão é 30000.

maxRetries: number — Máximo de repetições para falhas transitórias.O padrão é 2.

refreshBuffer: number — Segundos antes da expiração para acionar atualização proativa.O padrão é 60.

logger: Logger — Instância de logger para saída de diagnóstico.

Métodos

getToken(): Promise<string> — Retorna um token de acesso válido, atualizando-o se necessário.

getAuthorizationUrl({ state }): Promise<AuthorizationUrlResult> — Crie o URL de autorização do Adobe IMS com um desafio PKCE. Retorna um AuthorizationUrlResult com url e codeVerifier.

exchangeCode({ code, codeVerifier }): Promise<TokenResponse> — Troque um código de autorização + verificador PKCE por tokens.

refresh(): Promise<TokenResponse> — Aciona manualmente uma atualização de token.

revoke(): Promise<void> — Revoga tokens no lado do servidor e limpa o estado local.

exportTokens(): ExportedTokens — Exporta o estado atual de tokens para persistência.

importTokens(data: ExportedTokens): void — Restaura o estado de tokens de um objeto exportado anteriormente.

Autentique usando authorization_code + PKCE para aplicativos desktop e para dispositivos móveis. Compartilha a mesma API que SPAAuth; use um URI de redirecionamento de esquema personalizado (por exemplo, myapp://callback).

usage
1import { randomBytes } from "crypto";
2import { FrameioClient, NativeAppAuth } from "frameio";
3
4const auth = new NativeAppAuth({
5    clientId: "YOUR_CLIENT_ID",
6    redirectUri: "myapp://callback",
7});
8const result = await auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") });
9// open result.url in the system browser, store result.codeVerifier ...
10await auth.exchangeCode({ code: "CODE_FROM_CALLBACK", codeVerifier: result.codeVerifier });
11const client = new FrameioClient({ token: () => auth.getToken() });

Parâmetros

clientId: string — ID de cliente OAuth do Adobe IMS.

redirectUri: string – URI de redirecionamento registrado (esquema personalizado suportado).

scopes: string — Escopos separados por espaços (OAuth 2.0 RFC 6749).

imsBaseUrl: string — URL base do IMS para ambientes de staging/alternativos.O padrão é produção.

fetch: typeof fetch — Implementação de fetch personalizada (para proxy, TLS, etc.).

onTokenRefreshed: OnTokenRefreshed — Callback opcional acionado após cada atualização de token

timeout: number — Tempo-limite de solicitação HTTP em segundos.O padrão é 30000.

maxRetries: number — Máximo de repetições para falhas transitórias.O padrão é 2.

refreshBuffer: number — Segundos antes da expiração para acionar atualização proativa.O padrão é 60.

logger: Logger — Instância de logger para saída de diagnóstico.

Métodos

Igual ao SPAAuth: getToken(), getAuthorizationUrl({ state }), exchangeCode({ code, codeVerifier }), refresh(), revoke(), exportTokens(), importTokens(data).

Objeto retornado por SPAAuth.getAuthorizationUrl() e NativeAppAuth.getAuthorizationUrl(). Mantém a URL de autorização e o verificador de código PKCE.

Propriedades

url: string — A URL de autorização completa para a qual redirecionar o usuário.

codeVerifier: string — O verificador de código PKCE a ser armazenado e passado para exchangeCode().

Exceções de autenticação

Todos os erros de autenticação estendem FrameioAuthError e podem ser importados de frameio.

ExceçãoDescrição
FrameioAuthErrorErro base para todos os erros do SDK de autenticação.
AuthenticationErrorFalha na troca ou atualização de token. Tem propriedades errorCode e errorDescription.
TokenExpiredErrorToken de atualização expirado; é necessária nova autenticação.
NetworkErrorUma solicitação de rede falhou (tempo-limite, erro de conexão etc.).
RateLimitErrorAdobe IMS retornou 429 e as tentativas foram esgotadas.Tem uma propriedade retryAfter.
PKCEErrorFalha na verificação PKCE.
ConfigurationErrorA configuração obrigatória está ausente ou é inválida.

Coleções

Listar coleções de um projeto.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.CollectionsIndexRequest

requestOptions: Collections.RequestOptions

Mostrar detalhes da coleção.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

collectionId: Frameio.Uuid —

request: Frameio.CollectionsShowRequest

requestOptions: Collections.RequestOptions

Comentários

Mostrar um único comentário em um arquivo.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

commentId: Frameio.Uuid —

request: Frameio.CommentsShowRequest

requestOptions: Comments.RequestOptions

Excluir comentário de um ativo.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

commentId: Frameio.Uuid —

requestOptions: Comments.RequestOptions

Atualizar comentário no ativo fornecido.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

commentId: Frameio.Uuid —

request: Frameio.UpdateCommentParams

requestOptions: Comments.RequestOptions

Listar comentários em um determinado ativo.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1const 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);
11for await (const item of response) {
12    console.log(item);
13}
14
15// Or you can manually iterate page-by-page
16let 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});
22while (page.hasNextPage()) {
23    page = page.getNextPage();
24}

Parâmetros

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.CommentsIndexRequest

requestOptions: Comments.RequestOptions

Criar um comentário em um arquivo.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.CreateCommentParams

requestOptions: Comments.RequestOptions

Criar um anexo para um comentário existente.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

usage
1await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        file_size: 1024000,
4        media_type: "image/png",
5        name: "screenshot.png",
6    },
7});

Parâmetros

accountId: Frameio.FrameOrAdobeId —

commentId: Frameio.Uuid —

request: Frameio.CreateAttachmentParams

requestOptions: Comments.RequestOptions

Excluir anexo de comentário.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.FrameOrAdobeId —

commentId: Frameio.Uuid —

attachmentId: Frameio.Uuid —

requestOptions: Comments.RequestOptions

Ações personalizadas

Listar ações em um determinado espaço de trabalho.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await client.customActions.actionsIndex("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});

Parâmetros

accountId: Frameio.FrameOrAdobeId —

workspaceId: Frameio.Uuid —

request: Frameio.ActionsIndexRequest

requestOptions: CustomActions.RequestOptions

Expandir detalhes de ação personalizada.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.FrameOrAdobeId —

actionId: Frameio.Uuid —

request: Frameio.ActionsShowRequest

requestOptions: CustomActions.RequestOptions

Cria uma ação personalizada em um espaço de trabalho.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await client.customActions.actionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        description: "customizing our workflow",
4        event: "my.event",
5        name: "First Custom Action",
6        timeout: 7,
7        url: "https://example.com/custom-action",
8    },
9});

Parâmetros

accountId: Frameio.FrameOrAdobeId —

workspaceId: Frameio.Uuid —

request: Frameio.ActionCreateParams

requestOptions: CustomActions.RequestOptions

Atualizar detalhes da ação personalizada.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await client.customActions.actionsUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        active: true,
4        description: "customizing our workflow",
5        event: "my.event",
6        multi_asset: true,
7        name: "First Custom Action",
8        timeout: 7,
9        url: "https://example.com/custom-action",
10    },
11});

Parâmetros

accountId: Frameio.FrameOrAdobeId —

actionId: Frameio.Uuid —

request: Frameio.ActionUpdateParams

requestOptions: CustomActions.RequestOptions

Excluir uma ação personalizada.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

usage
1await client.customActions.actionsDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Parâmetros

accountId: Frameio.FrameOrAdobeId —

actionId: Frameio.Uuid —

requestOptions: CustomActions.RequestOptions

Arquivos

Listar arquivos de uma pasta específica.

Limites de taxa: 5 chamadas por 1 segundo(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FilesListRequest

requestOptions: Files.RequestOptions

Criar novo arquivo na pasta principal.Criar arquivo (fazer upload local) e Criar arquivo (fazer upload remoto) substituíram este ponto de acesso.

Limites de taxa: 5 chamadas por 1 segundo(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FileCreateParams

requestOptions: Files.RequestOptions

Mostrar detalhes do arquivo.

Use o parâmetro de consulta include para incluir seletivamente propriedades adicionais na resposta.

Se você incluir media_links.original e o usuário não tiver permissão para fazer download do arquivo, esse ponto de acesso responderá com um erro 403 Forbidden.Se o conteúdo estiver inacessível porque a marca-d’água é obrigatória para esse usuário e não é compatível com os media_links solicitados, a solicitação será bem-sucedida, mas os links de mídia incompatíveis serão definidos como null. Da mesma forma, se um link de transcodificação solicitado não existir para um arquivo específico (por exemplo, incluir media_links.video_h264_180 em um arquivo de imagem estática) ou se o processo de transcodificação não tiver sido concluído (ou seja, o status do arquivo for “uploaded”, em vez de “transcoded”), o link também será definido como null no conteúdo da resposta. Em resumo, o cliente deve lidar corretamente com links de mídia null.

Limites de taxa: 5 chamadas por 1 segundo(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FilesShowRequest

requestOptions: Files.RequestOptions

Excluir arquivo por ID.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

requestOptions: Files.RequestOptions

Atualizar detalhes do arquivo.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.FileUpdateParams

requestOptions: Files.RequestOptions

Copiar arquivo.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.FileCopyParams

requestOptions: Files.RequestOptions

Criar novo arquivo na pasta principal por meio de upload remoto.

Limites de taxa: 5 chamadas por 1 segundo(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FileCreateRemoteUploadParams

requestOptions: Files.RequestOptions

Mover arquivo para uma pasta ou version_stack.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.FileMoveParams

requestOptions: Files.RequestOptions

Criar novo arquivo na pasta principal por meio de upload local.

Limites de taxa: 5 chamadas por 1 segundo(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FileCreateLocalUploadParams

requestOptions: Files.RequestOptions

Mostrar detalhes do status de upload do arquivo.

Limites de taxa: 5 chamadas por 1 segundo(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

requestOptions: Files.RequestOptions

Importar um arquivo de um local de armazenamento configurado na conta.

Limites de taxa: 5 chamadas por 1 segundo(s) por account_user

usage
1await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
4        name: "asset.png",
5        storage_location: "123e4567-e89b-12d3-a456-426614174000",
6    },
7});

Parâmetros

accountId: Frameio.FrameOrAdobeId —

folderId: Frameio.FrameOrAdobeId —

request: Frameio.FileImportParams

requestOptions: Files.RequestOptions

Permissões da pasta

Listar funções de usuário de uma determinada pasta.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await client.folderPermissions.folderUserRolesIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    include_deactivated: true,
3    after: "<opaque_cursor>",
4    page_size: 10,
5    include_total_count: false,
6});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderUserRolesIndexRequest

requestOptions: FolderPermissions.RequestOptions

Atualizar funções de usuário para a pasta especificada se o usuário já tiver sido adicionado à pasta.Se o usuário não tiver sido adicionado à pasta, ele será adicionado com a função especificada.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await client.folderPermissions.folderUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        role: "editor",
4    },
5});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

userId: Frameio.Uuid —

request: Frameio.UpdateUserRolesParams

requestOptions: FolderPermissions.RequestOptions

Remover um usuário de uma determinada pasta.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

userId: Frameio.Uuid —

requestOptions: FolderPermissions.RequestOptions

Pastas

Mostrar detalhes da pasta.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.FoldersShowRequest

requestOptions: Folders.RequestOptions

Excluir pasta por ID.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

requestOptions: Folders.RequestOptions

Atualizar detalhes da pasta.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderUpdateParams

requestOptions: Folders.RequestOptions

Listar as tarefas derivadas na pasta especificada.

Use o parâmetro de consulta include para incluir seletivamente propriedades adicionais na resposta.

Se você incluir media_links.original e o usuário não tiver permissão para fazer download de arquivos no projeto correspondente, esse ponto de acesso responderá com um erro 403 Forbidden.Se o conteúdo estiver inacessível porque a marca-d’água é obrigatória para esse usuário e não é compatível com os media_links solicitados, a solicitação será bem-sucedida, mas os links de mídia incompatíveis serão definidos como null. Da mesma forma, se um link de transcodificação solicitado não existir para um arquivo específico (por exemplo, incluir media_links.video_h264_180 em um arquivo de imagem estática) ou o processo de transcodificação não tiver sido concluído (ou seja, o status do arquivo é “uploaded”, em vez de “transcoded”), um link de mídia também será definido como null no conteúdo da resposta. Em resumo, o cliente deve lidar corretamente com links de mídia null.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderIndexRequest

requestOptions: Folders.RequestOptions

Copiar pasta.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderCopyParams

requestOptions: Folders.RequestOptions

Listar pastas em determinada pasta.

Limites de taxa: 5 chamadas por 1 segundo(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FoldersListRequest

requestOptions: Folders.RequestOptions

Criar uma nova pasta dentro do parâmetro de caminho folder_id especificado*

Limites de taxa: 3 chamadas por 1 segundo(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderCreateParams

requestOptions: Folders.RequestOptions

Mover pasta para uma pasta.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderMoveParams

requestOptions: Folders.RequestOptions

Grupos

Listar grupos na conta.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.FrameOrAdobeId —

request: Frameio.GroupsIndexRequest

requestOptions: Groups.RequestOptions

Mostrar detalhes do grupo.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.FrameOrAdobeId —

groupId: Frameio.Uuid —

request: Frameio.GroupsShowRequest

requestOptions: Groups.RequestOptions

Criar grupo para a conta atual.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await client.groups.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        emoji: "smile",
4        name: "group-1",
5    },
6});

Parâmetros

accountId: Frameio.FrameOrAdobeId —

request: Frameio.CreateGroupParams

requestOptions: Groups.RequestOptions

Atualizar detalhes do grupo.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await client.groups.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        emoji: "smile",
4        name: "group-1",
5    },
6});

Parâmetros

accountId: Frameio.FrameOrAdobeId —

groupId: Frameio.Uuid —

request: Frameio.UpdateGroupParams

requestOptions: Groups.RequestOptions

Metadados

Atualizar valores de metadados em vários arquivos.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.BulkUpdateMetadataParams

requestOptions: Metadata.RequestOptions

Mostrar os metadados de um arquivo.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.MetadataShowRequest

requestOptions: Metadata.RequestOptions

Campos de metadados

Excluir definições de campos personalizados no nível da conta.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

fieldDefinitionId: Frameio.Uuid —

requestOptions: MetadataFields.RequestOptions

Atualizar definições de campos personalizados no nível da conta.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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);

Parâmetros

accountId: Frameio.Uuid —

fieldDefinitionId: Frameio.Uuid —

request: Frameio.UpdateFieldDefinitionParams

requestOptions: MetadataFields.RequestOptions

Listar definições de campos no nível da conta.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

request: Frameio.MetadataFieldDefinitionsIndexRequest

requestOptions: MetadataFields.RequestOptions

Criar definições de campos no nível da conta.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

request: Frameio.CreateFieldDefinitionParams

requestOptions: MetadataFields.RequestOptions

Permissões do projeto

Listar funções de usuário para determinado projeto.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1const 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);
11for await (const item of response) {
12    console.log(item);
13}
14
15// Or you can manually iterate page-by-page
16let 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);
26while (page.hasNextPage()) {
27    page = page.getNextPage();
28}

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.ProjectPermissionsIndexRequest

requestOptions: ProjectPermissions.RequestOptions

Remover um usuário de determinado projeto.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

userId: Frameio.Uuid —

requestOptions: ProjectPermissions.RequestOptions

Atualizar funções de usuário para determinado projeto se o usuário já tiver sido adicionado ao projeto. Se o usuário não tiver sido adicionado ao projeto, ele será adicionado com a função especificada.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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);

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

UserId: Frameio.Uuid —

request: Frameio.UpdateUserRolesParams

requestOptions: ProjectPermissions.RequestOptions

Projetos

Mostrar detalhes do projeto.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.ProjectsShowRequest

requestOptions: Projects.RequestOptions

Excluir um projeto.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

requestOptions: Projects.RequestOptions

Atualizar detalhes do projeto.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.ProjectUpdateParams

requestOptions: Projects.RequestOptions

Listar projetos em determinado espaço de trabalho.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1const 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);
11for await (const item of response) {
12    console.log(item);
13}
14
15// Or you can manually iterate page-by-page
16let 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});
22while (page.hasNextPage()) {
23    page = page.getNextPage();
24}

Parâmetros

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.ProjectsIndexRequest

requestOptions: Projects.RequestOptions

Criar projeto em determinado espaço de trabalho.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.ProjectsParams

requestOptions: Projects.RequestOptions

Listar todos os projetos aos quais o usuário autenticado tem acesso dentro da conta especificada.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await client.projects.accountProjectsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    include: "owner",
3    sort: "name_asc",
4    after: "<opaque_cursor>",
5    page_size: 10,
6    include_total_count: false,
7});

Parâmetros

accountId: Frameio.FrameOrAdobeId —

request: Frameio.AccountProjectsIndexRequest

requestOptions: Projects.RequestOptions

Listar projetos para os quais o usuário atual foi convidado dentro da conta especificada, mas para os quais não tem acesso no nível do espaço de trabalho.Esses são projetos nos quais o usuário tem acesso de colaborador específico do projeto, sem permissões mais amplas de equipe/espaço de trabalho.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await client.projects.invitedProjectsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    include: "owner",
3    sort: "name_asc",
4    after: "<opaque_cursor>",
5    page_size: 10,
6    include_total_count: false,
7});

Parâmetros

accountId: Frameio.FrameOrAdobeId —

request: Frameio.InvitedProjectsIndexRequest

requestOptions: Projects.RequestOptions

Pesquisa

Pesquisar ativos, pastas e projetos em uma conta.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await client.search.search("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    engine: "nlp",
3    query: "red car driving on highway",
4    filters: {
5        files_and_version_stacks: true,
6        folders: false,
7        projects: false,
8    },
9    after: "<opaque_cursor>",
10    page_size: 10,
11    include_total_count: false,
12});

Parâmetros

accountId: Frameio.Uuid —

request: Frameio.SearchParams

requestOptions: Search.RequestOptions

Compartilhamentos

Mostrar um único Compartilhamento.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

requestOptions: Shares.RequestOptions

Excluir um compartilhamento.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

requestOptions: Shares.RequestOptions

Atualizar compartilhamento.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.UpdateShareParams

requestOptions: Shares.RequestOptions

Listar revisores de compartilhamento.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1const 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);
10for await (const item of response) {
11    console.log(item);
12}
13
14// Or you can manually iterate page-by-page
15let 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);
24while (page.hasNextPage()) {
25    page = page.getNextPage();
26}

Parâmetros

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.SharesListReviewersRequestreParams

requestOptions: Shares.RequestOptions

Adicionar revisores ao compartilhamento seguro por três tipos de identificador: adobe_user_id, email e user_id.

Uma solicitação pode incluir apenas um parâmetro de tipo de identificador.

email é o único identificador capaz de adicionar revisores a um Compartilhamento que não tenham uma conta de membro do Frame na conta à qual o Compartilhamento pertence.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.AddReviewersToShareParams

requestOptions: Shares.RequestOptions

Remove revisores do Compartilhar seguro por três tipos de identificador: adobe_user_id, email e user_id.

Uma solicitação pode incluir apenas um parâmetro de tipo de identificador.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.RemoveReviewerParams

requestOptions: Shares.RequestOptions

Remover desse compartilhamento um ativo que está atualmente no compartilhamento.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

assetId: Frameio.Uuid —

requestOptions: Shares.RequestOptions

Adicionar novo compartilhamento de ativo.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.AddAssetParams

requestOptions: Shares.RequestOptions

Listar compartilhamentos em um projeto.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1const 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);
10for await (const item of response) {
11    console.log(item);
12}
13
14// Or you can manually iterate page-by-page
15let 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});
20while (page.hasNextPage()) {
21    page = page.getNextPage();
22}

Parâmetros

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.SharesIndexRequest

requestOptions: Shares.RequestOptions

Criar compartilhamento.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.CreateShareParams

requestOptions: Shares.RequestOptions

Usuários

Inspecionar detalhes do usuário associado ao token bearer.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await client.users.show();

Parâmetros

requestOptions: Users.RequestOptions

Pilhas de versões

Listar as tarefas derivadas (arquivos) em uma pilha de versões especificada.

Use o parâmetro de consulta include para incluir seletivamente propriedades adicionais na resposta.

Se você incluirmedia_links.originale o usuário não tiver permissão para fazer download de arquivos no projeto correspondente, esse ponto de acesso responderá com um erro403 Forbidden. Se o conteúdo estiver inacessível porque a marca-d’água é obrigatória para esse usuário e não é compatível com os media_links solicitados, a solicitação será bem-sucedida, mas os links de mídia incompatíveis serão definidos como null. Da mesma forma, se um link de transcodificação solicitado não existir para um arquivo específico (por exemplo, incluir media_links.video_h264_180 em um arquivo de imagem estática) ou o processo de transcodificação não tiver sido concluído (ou seja, o status do arquivo é "uploaded", em vez de "transcoded"), um link de mídia também será definido como null no conteúdo da resposta. Em resumo, o cliente deve lidar com links de mídia null corretamente.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.VersionStacksIndexRequest

requestOptions: VersionStacks.RequestOptions

Mostrar detalhes da pilha de versão.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

versionStackId: Frameio.Uuid —

request: Frameio.VersionStacksShowRequest

requestOptions: VersionStacks.RequestOptions

Copiar pilha de versões.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

versionStackId: Frameio.Uuid —

request: Frameio.VersionStackCopyParams

requestOptions: VersionStacks.RequestOptions

Listar pilhas de versões em uma pasta especificada.

Limites de taxa: 5 chamadas por 1 segundo(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.VersionStacksListRequest

requestOptions: VersionStacks.RequestOptions

Criar uma nova Pilha de versões na pasta principal.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.VersionStackCreateParams

requestOptions: VersionStacks.RequestOptions

Mover pilha de versões para uma pasta.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.VersionStackMoveParams

requestOptions: VersionStacks.RequestOptions

Webhooks

Listar webhooks para determinado espaço de trabalho.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1const 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);
11for await (const item of response) {
12    console.log(item);
13}
14
15// Or you can manually iterate page-by-page
16let 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});
22while (page.hasNextPage()) {
23    page = page.getNextPage();
24}

Parâmetros

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WebhooksIndexRequest

requestOptions: Webhooks.RequestOptions

Cria um único webhook com segredo.

Eventos válidos:

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

Limites de taxa: 10 chamadas por 1,00 minuto(s) por conta

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WebhookCreateParams

requestOptions: Webhooks.RequestOptions

Mostrar detalhes do webhook.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

webhookId: Frameio.Uuid —

request: Frameio.WebhooksShowRequest

requestOptions: Webhooks.RequestOptions

Excluir um webhook.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

webhookId: Frameio.Uuid —

requestOptions: Webhooks.RequestOptions

Atualizar detalhes do webhook.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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});

Parâmetros

accountId: Frameio.Uuid —

webhookId: Frameio.Uuid—

request: Frameio.WebhookUpdateParams

requestOptions: Webhooks.RequestOptions

Permissões do espaço de trabalho

Listar funções de usuário para determinado espaço de trabalho.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1const 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);
11for await (const item of response) {
12    console.log(item);
13}
14
15// Or you can manually iterate page-by-page
16let 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);
26while (page.hasNextPage()) {
27    page = page.getNextPage();
28}

Parâmetros

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WorkspacePermissionsIndexRequest

requestOptions: WorkspacePermissions.RequestOptions

Remove um usuário de determinado espaço de trabalho.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

userId: Frameio.Uuid —

requestOptions: WorkspacePermissions.RequestOptions

Atualizar funções de usuário para determinado espaço de trabalho se o usuário já tiver sido adicionado ao espaço de trabalho. Se o usuário não tiver sido adicionado ao espaço de trabalho, ele será adicionado com a função especificada.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

usage
1await 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);

Parâmetros

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

userId: Frameio.Uuid —

request: Frameio.UpdateUserRolesParams

requestOptions: WorkspacePermissions.RequestOptions

Espaços de trabalho

Mostrar detalhes do espaço de trabalho.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WorkspacesShowRequest

requestOptions: Workspaces.RequestOptions

Excluir espaço de trabalho da conta.

Limites de taxa: 60 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

requestOptions: Workspaces.RequestOptions

Atualizar um espaço de trabalho.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WorkspaceParams

requestOptions: Workspaces.RequestOptions

Listar espaços de trabalho para determinada conta.

Limites de taxa: 100 chamadas por 1,00 minuto(s) por account_user

usage
1const 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});
7for await (const item of response) {
8    console.log(item);
9}
10
11// Or you can manually iterate page-by-page
12let 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});
18while (page.hasNextPage()) {
19    page = page.getNextPage();
20}

Parâmetros

accountId: Frameio.Uuid —

request: Frameio.WorkspacesIndexRequest

requestOptions: Workspaces.RequestOptions

Criar espaço de trabalho a partir de uma conta.

Limites de taxa: 10 chamadas por 1,00 minuto(s) por account_user

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

Parâmetros

accountId: Frameio.Uuid —

request: Frameio.WorkspaceParams

requestOptions: Workspaces.RequestOptions

npm

Visualizar em npm