Referencia del SDK para Python

Enumere las funciones de usuario de una cuenta determinada.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
response = client.account_permissions.index(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    include_deactivated=True,
9
    after="<opaque_cursor>",
10
    page_size=10,
11
    include_total_count=False,
12
)
13
for item in response:
14
    yield item
15
# alternatively, you can paginate page-by-page
16
for page in response.iter_pages():
17
    yield page

Parámetros

account_id: Uuid —

include_deactivated: typing.Optional[bool] — Permite incluir usuarios desactivados en la respuesta. El valor predeterminado es false.

after: typing.Optional[RequestAfterOpaqueCursor]

Parámetro de consulta de cursor opaco para solicitudes que devuelven resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Enumere las cuentas del usuario actual.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
response = client.accounts.index(
7
    after="<opaque_cursor>",
8
    page_size=10,
9
    include_total_count=False,
10
)
11
for item in response:
12
    yield item
13
# alternatively, you can paginate page-by-page
14
for page in response.iter_pages():
15
    yield page

Parámetros

after: typing.Optional[RequestAfterOpaqueCursor]

Parámetro de consulta de cursor opaco para solicitudes que devuelven resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
response = client.accounts.auditlog_index(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    include="user",
9
    after="<opaque_cursor>",
10
    page_size=10,
11
    include_total_count=False,
12
    api_version="4.0",
13
)
14
for item in response:
15
    yield item
16
# alternatively, you can paginate page-by-page
17
for page in response.iter_pages():
18
    yield page

Parámetros

account_id: Uuid —

api_version: typing.Literal[“4.0”] —

include: typing.Optional[typing.Literal[“user”]] —

filters: typing.Optional[Filters] —

after: typing.Optional[RequestAfterOpaqueCursor]

Parámetro de consulta de cursor opaco para solicitudes que devuelven resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

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. Para el uso asíncrono, utilice AsyncServerToServerAuth.

1
from frameio import Frameio
2
from frameio.auth import ServerToServerAuth
3
4
auth = ServerToServerAuth(client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET")
5
client = Frameio(token=auth.get_token)

Parámetros

client_id: str — ID de cliente de Adobe IMS OAuth.

client_secret: str — Secreto de cliente de Adobe IMS OAuth.

scopes: str — Ámbitos separados por espacios (OAuth 2.0 RFC 6749). El valor predeterminado es openid AdobeID frame.s2s.all.

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

http_client: typing.Optional[httpx.Client]cliente httpx.Client opcionalpara proxy, TLS o agrupación de conexiones.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — Devolución de llamada opcional que se activa después de cada obtención de token.

timeout: float — Tiempo de espera de la petición HTTP en segundos. El valor predeterminado es 30.

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

refresh_buffer: int — Segundos antes de la caducidad para activar una actualización proactiva. El valor predeterminado es 60. Métodos get_token() -> str — Devuelve un token de acceso válido y lo actualiza si es necesario. Pase esta referencia de método (no una llamada) al SDK: Frameio(token=auth.get_token). authenticate() -> dict[str, Any] — Obtiene explícitamente un nuevo token de acceso. Devuelve el diccionario de respuesta del token con access_token, expires_in, etc. revoke() -> None — Revoca ambos tokens en el servidor y borra el estado local. export_tokens() -> dict[str, Any] — Exporta el estado actual de los tokens para conservarlo. import_tokens(data: dict[str, Any]) -> None — Restaura el estado de los tokens a partir de un diccionario 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. Para el uso asíncrono, utilice AsyncWebAppAuth.

1
import secrets
2
from frameio import Frameio
3
from frameio.auth import WebAppAuth
4
5
auth = WebAppAuth(
6
    client_id="YOUR_CLIENT_ID",
7
    client_secret="YOUR_CLIENT_SECRET",
8
    redirect_uri="https://myapp.com/callback",
9
)
10
url = auth.get_authorization_url(state=secrets.token_urlsafe(32))
11
# redirect user to url ...
12
auth.exchange_code(code="CODE_FROM_CALLBACK")
13
client = Frameio(token=auth.get_token)

Parámetros

client_id: str — ID de cliente de Adobe IMS OAuth.

client_secret: str — Secreto de cliente de Adobe IMS OAuth.

redirect_uri: str — URI de redireccionamiento registrado.

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

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

http_client: typing.Optional[httpx.Client]cliente httpx.Client opcionalpara proxy, TLS o agrupación de conexiones.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — Devolución de llamada opcional que se activa después de cada actualización del token.

timeout: float — Tiempo de espera de la petición HTTP en segundos. El valor predeterminado es 30.

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

refresh_buffer: int — Segundos antes de la caducidad para activar una actualización proactiva. El valor predeterminado es 60. Métodos get_token() -> str — Devuelve un token de acceso válido y lo actualiza si es necesario. Pase esta referencia de método al SDK: Frameio(token=auth.get_token). get_authorization_url(state: str) -> str — Crea la URL de autorización de Adobe IMS. Pase un valor opaco de CSRF/estado que se devolverá en la respuesta. exchange_code(code: str) -> dict[str, Any] — Intercambia un código de autorización por tokens de acceso y actualización. refresh() -> dict[str, Any] — Activa manualmente una actualización del token. revoke() -> None — Revoca ambos tokens en el servidor y borra el estado local. export_tokens() -> dict[str, Any] — Exporta el estado actual de los tokens para conservarlo. import_tokens(data: dict[str, Any]) -> None — Restaura el estado de los tokens a partir de un diccionario exportado anteriormente.

Autentíquese mediante authorization_code + PKCE, sin secreto de cliente. Use este método para aplicaciones basadas en explorador o aplicaciones nativas que no puedan almacenar de forma segura un secreto de cliente. Para el uso asíncrono, utilice AsyncSPAAuth.

1
import secrets
2
from frameio import Frameio
3
from frameio.auth import SPAAuth
4
5
auth = SPAAuth(client_id="YOUR_CLIENT_ID", redirect_uri="https://myapp.com/cb")
6
result = auth.get_authorization_url(state=secrets.token_urlsafe(32))
7
# redirect user to result.url, store result.code_verifier
8
auth.exchange_code(code="CODE_FROM_CALLBACK", code_verifier=result.code_verifier)
9
client = Frameio(token=auth.get_token)

Parámetros

client_id: str — ID de cliente de Adobe IMS OAuth.

redirect_uri: str — URI de redireccionamiento registrado.

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

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

http_client: typing.Optional[httpx.Client]cliente httpx.Client opcionalpara proxy, TLS o agrupación de conexiones.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — Devolución de llamada opcional que se activa después de cada actualización del token.

timeout: float — Tiempo de espera de la petición HTTP en segundos. El valor predeterminado es 30.

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

refresh_buffer: int — Segundos antes de la caducidad para activar una actualización proactiva. El valor predeterminado es 60. Métodos get_token() -> str — Devuelve un token de acceso válido y lo actualiza si es necesario. Pase esta referencia de método al SDK: Frameio(token=auth.get_token). get_authorization_url(state: str) -> AuthorizationUrlResult — Crea la URL de autorización de Adobe IMS con desafío PKCE. Devuelve un AuthorizationUrlResult con los atributos url y code_verifier. exchange_code(code: str, code_verifier: str) -> dict[str, Any] — Intercambia un código de autorización y el verificador PKCE por tokens. refresh() -> dict[str, Any] — Activa manualmente una actualización del token. revoke() -> None — Revoca ambos tokens en el servidor y borra el estado local. export_tokens() -> dict[str, Any] — Exporta el estado actual de los tokens para conservarlo. import_tokens(data: dict[str, Any]) -> None — Restaura el estado de los tokens a partir de un diccionario exportado anteriormente.

Clase de datos congelada que devuelven SPAAuth.get_authorization_url() y AsyncSPAAuth.get_authorization_url(). Contiene la URL de autorización y el verificador de código PKCE. Atributos url: str — URL de autorización completa a la que se redirige al usuario. code_verifier: str — Verificador de código PKCE que se debe almacenar y pasar a exchange_code().

Cierre los clientes HTTP de nivel de módulo que usa el módulo de autenticación. Llame a close_clients() en código síncrono o use await aclose_clients() en código asíncrono durante el cierre de la aplicación para liberar las conexiones.

1
from frameio.auth import close_clients
2
3
# During application shutdown
4
close_clients()

Enumera las colecciones de un proyecto.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.collections.index(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="creator,project",
10
    after="<opaque_cursor>",
11
    page_size=10,
12
    include_total_count=False,
13
)

Parámetros

account_id: Uuid —

project_id: Uuid —

include: typing.Optional[CollectionInclude] —

after: typing.Optional[RequestAfterOpaqueCursor]

Parámetro de consulta de cursor opaco para solicitudes que devuelven resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Muestra los detalles de la colección.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.collections.show(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    collection_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="creator,project",
10
)

Parámetros

account_id: Uuid —

collection_id: Uuid —

include: typing.Optional[CollectionInclude] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Muestre un solo comentario de un archivo.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.comments.show(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="owner",
10
)

Parámetros

account_id: Uuid —

comment_id: Uuid —

include: typing.Optional[CommentsShowRequestInclude] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Elimine el comentario de un activo.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.comments.delete(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
)

Parámetros

account_id: Uuid —

comment_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Actualice el comentario del activo determinado.

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

1
from frameio import Frameio
2
from frameio.comments import UpdateCommentParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.comments.update(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    timestamp_as_timecode=True,
11
    data=UpdateCommentParamsData(
12
        annotation='[{"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}]',
13
        completed=False,
14
        page=4,
15
        text="This is great!",
16
    ),
17
)

Parámetros

account_id: Uuid —

comment_id: Uuid —

data: UpdateCommentParamsData

timestamp_as_timecode: typing.Optional[bool] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Enumere los comentarios de un activo determinado.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
response = client.comments.index(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="owner",
10
    after="<opaque_cursor>",
11
    page_size=10,
12
    include_total_count=False,
13
)
14
for item in response:
15
    yield item
16
# alternatively, you can paginate page-by-page
17
for page in response.iter_pages():
18
    yield page

Parámetros

account_id: Uuid —

file_id: Uuid —

include: typing.Optional[CommentInclude] —

after: typing.Optional[RequestAfterOpaqueCursor]

Parámetro de consulta de cursor opaco para solicitudes que devuelven resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Cree un comentario en un archivo.

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

1
from frameio import Frameio
2
from frameio.comments import CreateCommentParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.comments.create(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    timestamp_as_timecode=True,
11
    data=CreateCommentParamsData(
12
        annotation='[{"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}]',
13
        completed=False,
14
        page=4,
15
        text="This is great!",
16
        timestamp="00:00:02:12",
17
    ),
18
)

Parámetros

account_id: Uuid —

file_id: Uuid —

data: CreateCommentParamsData

timestamp_as_timecode: typing.Optional[bool] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Crea un archivo adjunto para un comentario existente.

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

1
from frameio import AttachmentInput, Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.comments.create_attachment(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    data=AttachmentInput(
10
        file_size=1024000,
11
        media_type="image/png",
12
        name="screenshot.png",
13
    ),
14
)

Parámetros

account_id: Uuid —

comment_id: Uuid —

data: Attachmentinput

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Elimina un archivo adjunto de un comentario.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.comments.delete_attachment(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    attachment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
)

Parámetros

account_id: Uuid —

comment_id: Uuid —

attachment_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Enumera las acciones de un espacio de trabajo determinado.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.custom_actions.actions_index(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="creator",
10
    after="<opaque_cursor>",
11
    page_size=10,
12
    include_total_count=False,
13
)

Parámetros

account_id: Uuid —

workspace_id: Uuid —

include: typing.Optional[typing.Literal[“creator”]] —

after: typing.Optional[RequestAfterOpaqueCursor]

Parámetro de consulta de cursor opaco para solicitudes que devuelven resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Muestre los detalles de una acción personalizada.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.custom_actions.actions_show(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    action_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="creator",
10
)

Parámetros

account_id: Uuid —

action_id: Uuid —

include: typing.Optional[typing.Literal[“creator”]] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

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

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

1
from frameio import Frameio
2
from frameio.custom_actions import ActionCreateParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.custom_actions.actions_create(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=ActionCreateParamsData(
11
        description="customizing our workflow",
12
        event="my.event",
13
        name="First Custom Action",
14
        timeout=7,
15
        url="https://example.com/custom-action",
16
    ),
17
)

Parámetros

account_id: Uuid —

workspace_id: Uuid —

data: ActionCreateParamsData

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Actualice los detalles de una acción personalizada.

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

1
from frameio import Frameio
2
from frameio.custom_actions import ActionUpdateParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.custom_actions.actions_update(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    action_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=ActionUpdateParamsData(
11
        active=True,
12
        description="customizing our workflow",
13
        event="my.event",
14
        multi_asset=True,
15
        name="First Custom Action",
16
        timeout=7,
17
        url="https://example.com/custom-action",
18
    ),
19
)

Parámetros

account_id: Uuid —

action_id: Uuid —

data: ActionUpdateParamsData

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Elimine una acción personalizada.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.custom_actions.actions_delete(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    action_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
)

Parámetros

account_id: Uuid —

action_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Enumere los archivos de una carpeta determinada.

Límites de frecuencia: 5 llamadas por segundo por account_user

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.files.list(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="media_links",
10
    after="<opaque_cursor>",
11
    page_size=10,
12
    include_total_count=False,
13
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

include: typing.Optional[FileWithMediaLinksInclude] —

after: typing.Optional[RequestAfterOpaqueCursor]

Parámetro de consulta de cursor opaco para solicitudes que devuelven resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

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

1
from frameio import Frameio
2
from frameio.files import FileCreateParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.files.create(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=FileCreateParamsData(
11
        file_size=1137444,
12
        media_type="image/png",
13
        name="asset.png",
14
    ),
15
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

data: FileCreateParamsData

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Muestre los detalles del archivo.

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

Límites de frecuencia: 5 llamadas por segundo por account_user

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.files.show(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="media_links",
10
)

Parámetros

account_id: Uuid —

file_id: Uuid —

include: typing.Optional[FileWithMediaLinksInclude] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Elimine el archivo por ID.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.files.delete(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
)

Parámetros

account_id: Uuid —

file_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Actualice los detalles del archivo.

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

1
from frameio import Frameio
2
from frameio.files import FileUpdateParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.files.update(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=FileUpdateParamsData(
11
        name="asset.png",
12
    ),
13
)

Parámetros

account_id: Uuid —

file_id: Uuid —

data: FileUpdateParamsData

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Copie el archivo.

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

1
from frameio import Frameio
2
from frameio.files import FileCopyParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.files.copy(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    copy_metadata=True,
11
    copy_comments="none",
12
    data=FileCopyParamsData(
13
        parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
14
    ),
15
)

Parámetros

account_id: Uuid —

file_id: Uuid —

copy_metadata: typing.Optional[bool] — Indica si se deben copiar los valores de metadatos junto con el archivo

copy_comments: typing.Optional[FilesCopyRequestCopyComments] — Indica qué comentarios se deben copiar junto con el archivo

data: typing.Optional[FileCopyParamsData]

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

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

Límites de frecuencia: 5 llamadas por segundo por account_user

1
from frameio import Frameio
2
from frameio.files import FileCreateRemoteUploadParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.files.create_remote_upload(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=FileCreateRemoteUploadParamsData(
11
        name="asset.png",
12
        source_url="https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png",
13
    ),
14
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

data: FileCreateRemoteUploadParamsData

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Mueva el archivo a una carpeta o version_stack.

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

1
from frameio import Frameio
2
from frameio.files import FileMoveParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.files.move(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=FileMoveParamsData(
11
        parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
12
    ),
13
)

Parámetros

account_id: Uuid —

file_id: Uuid —

data: FileMoveParamsData

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

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

Límites de frecuencia: 5 llamadas por segundo por account_user

1
from frameio import Frameio
2
from frameio.files import FileCreateLocalUploadParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.files.create_local_upload(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=FileCreateLocalUploadParamsData(
11
        file_size=1137444,
12
        name="asset.png",
13
    ),
14
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

data: FileCreateLocalUploadParamsData

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Muestre los detalles del estado de carga del archivo.

Límites de frecuencia: 5 llamadas por segundo por account_user

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.files.show_file_upload_status(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
)

Parámetros

account_id: Uuid —

file_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

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

Límites de frecuencia: 5 llamadas por segundo por account_user

1
from frameio import Frameio
2
from frameio.files import FileImportParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.files.import_file(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=FileImportParamsData(
11
        key="uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
12
        name="asset.png",
13
        storage_location="123e4567-e89b-12d3-a456-426614174000",
14
    ),
15
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

data: FileImportParamsData

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Enumere las funciones de usuario de una carpeta determinada.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.folder_permissions.folder_user_roles_index(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include_deactivated=True,
10
    after="<opaque_cursor>",
11
    page_size=10,
12
    include_total_count=False,
13
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

include_deactivated: typing.Optional[bool] — Permite incluir usuarios desactivados en la respuesta. El valor predeterminado es false.

after: typing.Optional[RequestAfterOpaqueCursor]

Parámetro de consulta de cursor opaco para solicitudes que devuelven resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

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

1
from frameio import Frameio, UpdateUserRolesParamsData
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.folder_permissions.folder_user_roles_update(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=UpdateUserRolesParamsData(
11
        role="editor",
12
    ),
13
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

user_id: Uuid —

data: UpdateUserRolesParamsData

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Elimine un usuario de una carpeta determinada.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.folder_permissions.delete(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

user_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Muestre los detalles de la carpeta.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.folders.show(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="creator",
10
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

include: typing.Optional[AssetInclude] —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Elimine la carpeta por ID.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.folders.delete(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

Actualice los detalles de la carpeta.

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

1
from frameio import Frameio
2
from frameio.folders import FolderUpdateParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.folders.update(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=FolderUpdateParamsData(
11
        name="Folder name",
12
    ),
13
)

Parámetros

account_id: Uuid —

folder_id: Uuid —

data: FolderUpdateParamsData

request_options: typing.Optional[RequestOptions] — Configuración específica de la solicitud.

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.

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.folders.index(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="media_links",
10
    type="file,folder,version_stack",
11
    after="<opaque_cursor>",
12
    page_size=10,
13
    include_total_count=False,
14
)