Referencia de SDK

Referencia del SDK para TypeScript

Instalación

$npm i -s frameio

Uso

Instancie y use el cliente con lo siguiente:

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 solicitud y respuesta

El SDK exporta todos los tipos de solicitud y respuesta como interfaces de TypeScript. Solo tiene que importarlos con el siguiente espacio de nombre:

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

Gestión de excepciones

Cuando la API devuelve un código de estado que no indica éxito, como una respuesta 4xx o 5xx, se genera una subclase del siguiente error.

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}

Avanzado

Encabezados adicionales

Si desea enviar encabezados adicionales como parte de la solicitud, use la opción de solicitud headers.

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

Parámetros de cadena de consulta adicionales

Si desea enviar parámetros de cadena de consulta adicionales como parte de la solicitud, use la opción de solicitud queryParams.

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

Reintentos

El SDK incorpora reintentos automáticos con espera exponencial. Una solicitud se reintenta siempre que se considere apta para ello y el número de intentos no supere el límite configurado, cuyo valor predeterminado es 2.

Una solicitud se considera apta para reintento cuando se devuelve alguno de los siguientes códigos de estado HTTP:

  • 408 (tiempo de espera agotado)
  • 429 (demasiadas solicitudes)
  • 5XX (errores internos del servidor)


Use la opción de solicitud maxRetries para configurar este comportamiento.

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

Tiempos de espera

El SDK tiene un tiempo de espera predeterminado de 60 segundos. Use la opción timeoutInSeconds para configurar este comportamiento.

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

Anulación de solicitudes

El SDK permite anular solicitudes en cualquier momento pasando una señal de anulación.

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

Acceso a datos de respuesta sin procesar

El SDK proporciona acceso a los datos de respuesta sin procesar, incluidos los encabezados, mediante el método .withRawResponse(). El método .withRawResponse() devuelve una promesa que da como resultado un objeto con una propiedad data y una propiedad rawResponse.

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

Compatibilidad en tiempo de ejecución

El SDK funciona en los siguientes tiempos de ejecución:

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

Personalización del cliente Fetch

El SDK permite personalizar el cliente HTTP subyacente o la función Fetch. Si se ejecuta en un entorno no compatible, esto permite recurrir a una solución alternativa y garantizar que el SDK funcione.

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

Referencia

Permisos de cuenta

Enumere las funciones de usuario de una cuenta determinada.

Límites de frecuencia: 100 llamadas cada 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

Cuentas

Enumere las cuentas del usuario actual.

Límites de frecuencia: 100 llamadas cada 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

Enumera los registros de auditoría con funciones de filtrado mediante parámetros de consulta.

Límites de frecuencia: 100 llamadas cada 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

Autorización

Autentíquese mediante la concesión client_credentials de OAuth 2.0. Este flujo no implica a ningún usuario y no devuelve ningún token de actualización. Cuando el token de acceso caduca, el SDK solicita automáticamente uno nuevo con las credenciales 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 de Adobe IMS Oauth.

clientSecret: string — Secreto de cliente de Adobe IMS Oauth.

scopes: string — Ámbitos separados por espacios (OAuth 2.0 RFC 6749). El valor predeterminado es el ámbito de servidor a servidor.

imsBaseUrl: string — URL base de IMS para entornos de ensayo o alternativos. El valor predeterminado es producción.

fetch: typeof fetch — Implementación de fetch personalizada (para proxy, TLS, etc.).

onTokenRefreshed: OnTokenRefreshed — Devolución de llamada opcional que se activa después de cada obtención de token.

timeout: number — Tiempo de espera de la petición HTTP en milisegundos. El valor predeterminado es 30000.

maxRetries: number — Número máximo de reintentos ante errores transitorios. El valor predeterminado es 2.

refreshBuffer: number — Segundos antes de la caducidad para activar una actualización proactiva. El valor predeterminado es 60.

logger: Logger — Instancia de registrador para la salida de diagnóstico. Methods getToken(): Promise<string> — Devuelve un token de acceso válido y lo actualiza si es necesario. Pass it to the client: new FrameioClient({ token: () => auth.getToken() }). authenticate(): Promise<TokenResponse> — Obtiene explícitamente un nuevo token de acceso. revoke(): Promise<void> — Revoca los tokens en el servidor y borra el estado local. exportTokens(): ExportedTokens — Exporta el estado actual de los tokens para conservarlo. importTokens(data: ExportedTokens): void — Restaura el estado de los tokens a partir de un objeto exportado anteriormente.

Autentíquese mediante la concesión authorization_code de OAuth 2.0. Use este método para aplicaciones del lado del servidor que puedan almacenar de forma segura un secreto de cliente.

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 de Adobe IMS Oauth.

clientSecret: string — Secreto de cliente de Adobe IMS Oauth.

redirectUri: string — URI de redireccionamiento registrado.

scopes: string — Ámbitos separados por espacios (OAuth 2.0 RFC 6749).

imsBaseUrl: string — URL base de IMS para entornos de ensayo o alternativos. El valor predeterminado es producción.

fetch: typeof fetch — Implementación de fetch personalizada (para proxy, TLS, etc.).

onTokenRefreshed: OnTokenRefreshed — Devolución de llamada opcional que se activa después de cada actualización del token.

timeout: number — Tiempo de espera de la petición HTTP en milisegundos. El valor predeterminado es 30000.

maxRetries: number — Número máximo de reintentos ante errores transitorios. El valor predeterminado es 2.

refreshBuffer: number — Segundos antes de la caducidad para activar una actualización proactiva. El valor predeterminado es 60.

logger: Logger — Instancia de registrador para la salida de diagnóstico. Methods getToken(): Promise<string> — Devuelve un token de acceso válido y lo actualiza si es necesario. getAuthorizationUrl({ state }): string — Crea la URL de autorización de Adobe IMS. Pase un valor opaco de CSRF/estado que se devolverá en la respuesta. exchangeCode(code: string): Promise<TokenResponse> — Intercambia un código de autorización por tokens de acceso y actualización. refresh(): Promise<TokenResponse> — Activa manualmente una actualización del token. revoke(): Promise<void> — Revoca los tokens en el servidor y borra el estado local. exportTokens(): ExportedTokens — Exporta el estado actual de los tokens para conservarlo. importTokens(data: ExportedTokens): void — Restaura el estado de los tokens a partir de un objeto exportado anteriormente.

Autentíquese mediante authorization_code + PKCE, sin secreto de cliente. Use este método para aplicaciones basadas en explorador o aplicaciones de una sola página que no puedan almacenar de forma segura un secreto de cliente.

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 de Adobe IMS Oauth.

redirectUri: string — URI de redireccionamiento registrado.

scopes: string — Ámbitos separados por espacios (OAuth 2.0 RFC 6749).

imsBaseUrl: string — URL base de IMS para entornos de ensayo o alternativos. El valor predeterminado es producción.

fetch: typeof fetch — Implementación de fetch personalizada (para proxy, TLS, etc.).

onTokenRefreshed: OnTokenRefreshed — Devolución de llamada opcional que se activa después de cada actualización del token.

timeout: number — Tiempo de espera de la petición HTTP en milisegundos. El valor predeterminado es 30000.

maxRetries: number — Número máximo de reintentos ante errores transitorios. El valor predeterminado es 2.

refreshBuffer: number — Segundos antes de la caducidad para activar una actualización proactiva. El valor predeterminado es 60.

logger: Logger — Instancia de registrador para la salida de diagnóstico. Methods getToken(): Promise<string> — Devuelve un token de acceso válido y lo actualiza si es necesario. getAuthorizationUrl({ state }): Promise<AuthorizationUrlResult> — Crea la URL de autorización de Adobe IMS con un desafío PKCE. Devuelve un AuthorizationUrlResult con url y codeVerifier. exchangeCode({ code, codeVerifier }): Promise<TokenResponse> — Intercambia un código de autorización y el verificador PKCE por tokens. refresh(): Promise<TokenResponse> — Activa manualmente una actualización del token. revoke(): Promise<void> — Revoca los tokens en el servidor y borra el estado local. exportTokens(): ExportedTokens — Exporta el estado actual de los tokens para conservarlo. importTokens(data: ExportedTokens): void — Restaura el estado de los tokens a partir de un objeto exportado anteriormente.

Autentíquese mediante authorization_code + PKCE para aplicaciones móviles y de escritorio. Comparte la misma API que SPAAuth; utilice un URI de redireccionamiento de esquema personalizado (por ejemplo, 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 de Adobe IMS Oauth.

RedirectUri: string — URI de redireccionamiento registrado (admite esquema personalizado).

scopes: string — Ámbitos separados por espacios (OAuth 2.0 RFC 6749).

imsBaseUrl: string — URL base de IMS para entornos de ensayo o alternativos. El valor predeterminado es producción.

fetch: typeof fetch — Implementación de fetch personalizada (para proxy, TLS, etc.).

onTokenRefreshed: OnTokenRefreshed — Devolución de llamada opcional que se activa después de cada actualización del token.

timeout: number — Tiempo de espera de la petición HTTP en milisegundos. El valor predeterminado es 30000.

maxRetries: number — Número máximo de reintentos ante errores transitorios. El valor predeterminado es 2.

refreshBuffer: number — Segundos antes de la caducidad para activar una actualización proactiva. El valor predeterminado es 60.

logger: Logger — Instancia de registrador para la salida de diagnóstico. Methods Same as SPAAuth: getToken(), getAuthorizationUrl({ state }), exchangeCode({ code, codeVerifier }), refresh(), revoke(), exportTokens(), importTokens(data).

Objeto devuelto por SPAAuth.getAuthorizationUrl() y NativeAppAuth.getAuthorizationUrl(). Contiene la URL de autorización y el verificador de código PKCE. Properties url: string — URL de autorización completa a la que se redirige al usuario. codeVerifier: string — Verificador de código PKCE que se debe almacenar y pasar a exchangeCode().

Excepciones de autenticación

Todos los errores de autenticación se extienden a FrameioAuthError y se pueden importar desde frameio.

ExcepciónDescripción
FrameioAuthErrorError base para todos los errores de auth-SDK.
AuthenticationErrorError al intercambiar o actualizar el token. Tiene las propiedades errorCode y errorDescription.
TokenExpiredErrorEl token de actualización ha caducado; es necesario volver a autenticarse.
NetworkErrorError en la solicitud de red (tiempo de espera agotado, error de conexión, etc.).
RateLimitErrorAdobe IMS ha devuelto 429 y se han agotado los reintentos. Tiene una propiedad retryAfter.
PKCEErrorError en la verificación de PKCE.
ConfigurationErrorFalta la configuración necesaria o no es válida.

Colecciones

Enumera las colecciones de un proyecto.

Límites de frecuencia: 100 llamadas cada 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

Muestra los detalles de la colección.

Límites de frecuencia: 100 llamadas cada 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

Comentarios

Muestre un solo comentario de un archivo.

Límites de frecuencia: 100 llamadas cada 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

Elimine el comentario de un activo.

Límites de frecuencia: 60 llamadas cada 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

Actualice el comentario del activo determinado.

Límites de frecuencia: 10 llamadas cada 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

Enumere los comentarios de un activo determinado.

Límites de frecuencia: 100 llamadas cada 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

Cree un comentario en un archivo.

Límites de frecuencia: 100 llamadas cada 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

Crea un archivo adjunto para un comentario existente.

Límites de frecuencia: 60 llamadas cada 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

Elimina un archivo adjunto de un comentario.

Límites de frecuencia: 60 llamadas cada 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

Acciones personalizadas

Enumera las acciones de un espacio de trabajo determinado.

Límites de frecuencia: 100 llamadas cada 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

Muestre los detalles de una acción personalizada.

Límites de frecuencia: 100 llamadas cada 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

Cree una acción personalizada en un espacio de trabajo.

Límites de frecuencia: 10 llamadas cada 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

Actualice los detalles de una acción personalizada.

Límites de frecuencia: 10 llamadas cada 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

Elimine una acción personalizada.

Límites de frecuencia: 60 llamadas cada 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

Archivos

Enumere los archivos de una carpeta determinada.

Límites de frecuencia: 5 llamadas por segundo 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

Cree un archivo nuevo en la carpeta principal. Crear archivo (carga local) y Crear archivo (carga remota) han sustituido a este punto final.

Límites de frecuencia: 5 llamadas por segundo 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

Muestre los detalles del archivo.

Use el parámetro de consulta include para incluir de forma selectiva propiedades adicionales en la respuesta.

Si incluye media_links.original y el usuario no tiene permiso para descargar el archivo, este punto final responderá con un error 403 Forbidden. Si no se puede acceder al contenido porque se requiere marca de agua para este usuario y los media_links solicitados no la admiten, la solicitud se completará correctamente, pero los vínculos de medios no compatibles se definirán como null. Del mismo modo, si un vínculo de transcodificación solicitado no existe para un archivo concreto (por ejemplo, si se incluye media_links.video_h264_180 en un archivo de imagen estática) o si el proceso de transcodificación no se ha completado (es decir, el estado del archivo es “uploaded” en lugar de “transcoded”), el vínculo también se definirá como null en la carga útil de respuesta. En resumen, el cliente debe gestionar correctamente los vínculos de medios.

Límites de frecuencia: 5 llamadas por segundo 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

Elimine el archivo por ID.

Límites de frecuencia: 100 llamadas cada 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

Actualice los detalles del archivo.

Límites de frecuencia: 100 llamadas cada 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

Copie el archivo.

Límites de frecuencia: 100 llamadas cada 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

Cree un archivo nuevo en la carpeta principal mediante carga remota.

Límites de frecuencia: 5 llamadas por segundo 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

Mueva el archivo a una carpeta o version_stack.

Límites de frecuencia: 100 llamadas cada 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

Cree un archivo nuevo en la carpeta principal mediante carga local.

Límites de frecuencia: 5 llamadas por segundo 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

Muestre los detalles del estado de carga del archivo.

Límites de frecuencia: 5 llamadas por segundo 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

Importe un archivo desde una ubicación de almacenamiento configurada en la cuenta.

Límites de frecuencia: 5 llamadas por segundo 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

Permisos de carpeta

Enumere las funciones de usuario de una carpeta determinada.

Límites de frecuencia: 100 llamadas cada 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

Actualice las funciones de usuario de la carpeta determinada si el usuario ya se ha añadido a la carpeta. Si el usuario no se ha añadido a la carpeta, se añadirá con la función indicada.

Límites de frecuencia: 10 llamadas cada 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

Elimine un usuario de una carpeta determinada.

Límites de frecuencia: 60 llamadas cada 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

Carpetas

Muestre los detalles de la carpeta.

Límites de frecuencia: 100 llamadas cada 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

Elimine la carpeta por ID.

Límites de frecuencia: 60 llamadas cada 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

Actualice los detalles de la carpeta.

Límites de frecuencia: 10 llamadas cada 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

Enumere los elementos secundarios de la carpeta determinada.

Use el parámetro de consulta include para incluir de forma selectiva propiedades adicionales en la respuesta.

Si incluye media_links.original y el usuario no tiene permiso para descargar archivos en el proyecto correspondiente, este punto final responderá con un error 403 Forbidden. Si no se puede acceder al contenido porque se requiere marca de agua para este usuario y los media_links solicitados no la admiten, la solicitud se completará correctamente, pero los vínculos de medios no compatibles se definirán como null. Del mismo modo, si un vínculo de transcodificación solicitado no existe para un archivo concreto (por ejemplo, si se incluye media_links.video_h264_180 en un archivo de imagen estática) o si el proceso de transcodificación no ha finalizado (es decir, el estado del archivo es “uploaded” en lugar de “transcoded”), el vínculo de medios también se definirá como null en la carga útil de respuesta. En resumen, el cliente debe gestionar correctamente los vínculos de medios.

Límites de frecuencia: 100 llamadas cada 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

Copie la carpeta.

Límites de frecuencia: 10 llamadas cada 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

Enumere las carpetas de una carpeta determinada.

Límites de frecuencia: 5 llamadas por segundo 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

Cree una carpeta nueva dentro del parámetro de ruta folder_id determinado.

Límites de frecuencia: 3 llamadas por segundo 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

Mueva la carpeta a otra carpeta.

Límites de frecuencia: 10 llamadas cada 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

Enumere los grupos de la cuenta.

Límites de frecuencia: 100 llamadas cada 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

Muestra los detalles del grupo.

Límites de frecuencia: 100 llamadas cada 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

Cree un grupo para la cuenta actual.

Límites de frecuencia: 10 llamadas cada 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

Actualice los detalles del grupo.

Límites de frecuencia: 10 llamadas cada 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

Metadatos

Actualice los valores de metadatos en varios archivos.

Límites de frecuencia: 10 llamadas cada 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

Muestre los metadatos de un archivo.

Límites de frecuencia: 100 llamadas cada 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 metadatos

Elimine las definiciones de campos personalizados a nivel de cuenta.

Límites de frecuencia: 60 llamadas cada 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

Actualice las definiciones de campos personalizados a nivel de cuenta.

Límites de frecuencia: 10 llamadas cada 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

Enumere las definiciones de campos a nivel de cuenta.

Límites de frecuencia: 100 llamadas cada 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

Cree definiciones de campos a nivel de cuenta.

Límites de frecuencia: 10 llamadas cada 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

Permisos del proyecto

Enumere las funciones de usuario de un proyecto determinado.

Límites de frecuencia: 100 llamadas cada 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

Elimine un usuario de un proyecto determinado.

Límites de frecuencia: 60 llamadas cada 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

Actualice las funciones de usuario del proyecto determinado si el usuario ya se ha añadido al proyecto. Si el usuario no se ha añadido al proyecto, se añadirá con la función indicada.

Límites de frecuencia: 10 llamadas cada 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

Proyectos

Muestre los detalles del proyecto.

Límites de frecuencia: 100 llamadas cada 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

Elimine un proyecto.

Límites de frecuencia: 60 llamadas cada 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

Actualice los detalles del proyecto.

Límites de frecuencia: 10 llamadas cada 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

Enumere los proyectos de un espacio de trabajo determinado.

Límites de frecuencia: 100 llamadas cada 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

Cree un proyecto en un espacio de trabajo determinado.

Límites de frecuencia: 10 llamadas cada 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

Enumera todos los proyectos a los que tiene acceso el usuario autenticado en la cuenta especificada.

Límites de frecuencia: 100 llamadas cada 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

Enumere los proyectos a los que se ha invitado al usuario actual en la cuenta especificada, pero a los que no tiene acceso de nivel de espacio de trabajo. Se trata de proyectos en los que el usuario tiene acceso de colaborador específico del proyecto sin permisos de equipo o espacio de trabajo más amplios.

Límites de frecuencia: 100 llamadas cada 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

Búsqueda

Busque entre activos, carpetas y proyectos dentro de una cuenta.

Límites de frecuencia: 100 llamadas cada 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

Usos compartidos

Muestre un solo elemento de uso compartido.

Límites de frecuencia: 100 llamadas cada 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

Elimine un elemento de uso compartido.

Límites de frecuencia: 60 llamadas cada 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

Actualice un elemento de uso compartido.

Límites de frecuencia: 10 llamadas cada 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

Enumere los revisores del elemento de uso compartido.

Límites de frecuencia: 10 llamadas cada 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

Añada revisores al elemento de uso compartido seguro mediante tres tipos de identificador: adobe_user_id, email y user_id.

Una solicitud solo puede incluir un parámetro de tipo de identificador.

email es el único identificador que permite añadir revisores sin cuenta de Frame al elemento de uso compartido en la cuenta a la que pertenece.

Límites de frecuencia: 10 llamadas cada 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

Elimina revisores del elemento de uso compartido seguro mediante tres tipos de identificador: adobe_user_id, email y user_id.

Una solicitud solo puede incluir un parámetro de tipo de identificador.

Límites de frecuencia: 10 llamadas cada 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

Elimine de ese elemento de uso compartido un activo incluido actualmente en él.

Límites de frecuencia: 10 llamadas cada 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

Añada un elemento de uso compartido de un activo nuevo.

Límites de frecuencia: 10 llamadas cada 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

Enumere los elementos de uso compartido de un proyecto.

Límites de frecuencia: 100 llamadas cada 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

Cree un elemento de uso compartido.

Límites de frecuencia: 10 llamadas cada 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

Usuarios

Inspeccione los detalles del usuario asociado al token de portador.

Límites de frecuencia: 100 llamadas cada 1,00 minuto(s) por account_user

usage
1await client.users.show();

Parámetros

requestOptions: Users.RequestOptions

Pilas de versiones

Enumere los elementos secundarios (archivos) de una pila de versiones determinada.

Use el parámetro de consulta include para incluir de forma selectiva propiedades adicionales en la respuesta.

Si incluye media_links.originaly el usuario no tiene permiso para descargar archi vos en el proyecto correspondiente, este punto final responderá con un error403 Forbidden. Si no se puede acceder al contenido porque se requiere marca de agua para este usuario y los media_links solicitados no la admiten, la solicitud se completará correctamente, pero los vínculos de medios no compatibles se definirán como null. Del mismo modo, si un vínculo de transcodificación solicitado no existe para un archivo concreto (por ejemplo, si se incluye media_links.video_h264_180 en un archivo de imagen estática) o si el proceso de transcodificación no ha finalizado (es decir, el estado del archivo es "uploaded" en lugar de "transcoded"), el vínculo de medios también se definirá como null en la carga útil de respuesta. En resumen, el cliente debe gestionar correctamente los vínculos de medios.

Límites de frecuencia: 100 llamadas cada 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

Muestre los detalles de la pila de versiones.

Límites de frecuencia: 100 llamadas cada 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

Copie la pila de versiones.

Límites de frecuencia: 10 llamadas cada 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

Enumere las pilas de versiones de una carpeta determinada.

Límites de frecuencia: 5 llamadas por segundo 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

Cree una pila de versiones nueva en la carpeta principal.

Límites de frecuencia: 10 llamadas cada 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

Mueva la pila de versiones a una carpeta.

Límites de frecuencia: 10 llamadas cada 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

Enumere los webhooks del espacio de trabajo determinado.

Límites de frecuencia: 100 llamadas cada 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

Crea un solo webhook con secreto.

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

Límites de frecuencia: 10 llamadas cada 1,00 minuto(s) por cuenta

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

Muestre los detalles del webhook.

Límites de frecuencia: 100 llamadas cada 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

Elimine un webhook.

Límites de frecuencia: 60 llamadas cada 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

Actualice los detalles del webhook.

Límites de frecuencia: 10 llamadas cada 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

Permisos del espacio de trabajo

Enumere las funciones de usuario de un espacio de trabajo determinado.

Límites de frecuencia: 100 llamadas cada 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

Elimine un usuario de un espacio de trabajo determinado.

Límites de frecuencia: 60 llamadas cada 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

Actualice las funciones de usuario del espacio de trabajo determinado si el usuario ya se ha añadido al espacio de trabajo. Si el usuario no se ha añadido al espacio de trabajo, se añadirá con la función indicada.

Límites de frecuencia: 10 llamadas cada 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

Espacios de trabajo

Muestre los detalles del espacio de trabajo.

Límites de frecuencia: 100 llamadas cada 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

Elimine el espacio de trabajo de la cuenta.

Límites de frecuencia: 60 llamadas cada 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

Actualice un espacio de trabajo.

Límites de frecuencia: 10 llamadas cada 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

Enumere los espacios de trabajo de una cuenta determinada.

Límites de frecuencia: 100 llamadas cada 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

Cree un espacio de trabajo a partir de una cuenta.

Límites de frecuencia: 10 llamadas cada 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

Ver en npm

¿Te fue útil esta página?