Referência do SDK para Python

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

Limites de taxa: 100 chamadas por 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] — Suporte para incluir usuários desativados na resposta.O padrão é false.

after: typing.Optional[RequestAfterOpaqueCursor]

Parâmetro de consulta de cursor opaco para solicitações que retornam resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuração específica da solicitação.

Listar contas do usuário atual.

Limites de taxa: 100 chamadas por 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 solicitações que retornam resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuração específica da solicitação.

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

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

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 solicitações que retornam resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuração específica da solicitação.

Autentica usando a concessão OAuth 2.0 client_credentials. Esse fluxo não envolve um usuário e não retorna um token de atualização. Quando o token de acesso expira, o SDK solicita automaticamente um novo usando as credenciais de cliente. Para uso assíncrono, use 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 do cliente OAuth do Adobe IMS.

client_secret: str — Client secret OAuth do Adobe IMS.

scopes: str — Escopos separados por espaços (OAuth 2.0 RFC 6749). O padrão é openid AdobeID frame.s2s.all.

ims_base_url: str — URL base do IMS para ambientes de preparação/alternativos. O padrão é produção.

http_client: typing.Optional[httpx.Client] — httpx opcional.Cliente para proxy, TLS ou pooling de conexão.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — Callback opcional disparado após cada busca de token.

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

max_retries: int — Número máximo de novas tentativas para falhas transitórias. O padrão é 2.

refresh_buffer: int — Segundos antes da expiração para acionar a atualização proativa. O padrão é 60. Métodosget_token() -> str — Retorna um token de acesso válido, atualizando se necessário. Passe esta referência de método (não uma chamada) para o SDK: Frameio(token=auth.get_token). authenticate() -> dict[str, Any] — Busca explicitamente um novo token de acesso. Retorna o dict de resposta do token com access_token, expires_in, etc. revoke() -> None — Revoga ambos os tokens no lado do servidor e limpa o estado local. export_tokens() -> dict[str, Any] — Exporta o estado atual do token para persistência. import_tokens(data: dict[str, Any]) -> None — Restaura o estado do token a partir de um dict exportado anteriormente.

Autentica usando a concessão OAuth 2.0 authorization_code. Use isso para aplicativos do lado do servidor que podem armazenar um client secret com segurança. Para uso assíncrono, use 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 do cliente OAuth do Adobe IMS.

client_secret: str — Client secret OAuth do Adobe IMS.

redirect_uri: str — URI de redirecionamento registrado.

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

ims_base_url: str — URL base do IMS para ambientes de preparação/alternativos. O padrão é produção.

http_client: typing.Optional[httpx.Client] — httpx opcional.Cliente para proxy, TLS ou pooling de conexão.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — Retorno de chamada opcional acionado após cada atualização de token.

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

max_retries: int — Número máximo de novas tentativas para falhas transitórias. O padrão é 2.

refresh_buffer: int — Segundos antes da expiração para acionar a atualização proativa. O padrão é 60. Métodosget_token() -> str — Retorna um token de acesso válido, atualizando se necessário. Passe esta referência de método para o SDK: Frameio(token=auth.get_token). get_authorization_url(state: str) -> str — Cria a URL de autorização do Adobe IMS. Passe um valor CSRF/state opaco que será ecoado de volta. exchange_code(code: str) -> dict[str, Any] — Troca um código de autorização por tokens de acesso e atualização. refresh() -> dict[str, Any] — Aciona manualmente uma atualização de token. revoke() -> None — Revoga ambos os tokens no lado do servidor e limpa o estado local. export_tokens() -> dict[str, Any] — Exporta o estado atual do token para persistência. import_tokens(data: dict[str, Any]) -> None — Restaura o estado do token a partir de um dict exportado anteriormente.

Autentica usando authorization_code + PKCE (sem client secret). Use isso para aplicativos baseados em navegador ou aplicativos nativos que não conseguem armazenar um client secret com segurança. Para uso assíncrono, use 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 do cliente OAuth do Adobe IMS.

redirect_uri: str — URI de redirecionamento registrado.

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

ims_base_url: str — URL base do IMS para ambientes de preparação/alternativos. O padrão é produção.

http_client: typing.Optional[httpx.Client] — httpx opcional.Cliente para proxy, TLS ou pooling de conexão.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — Retorno de chamada opcional acionado após cada atualização de token.

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

max_retries: int — Número máximo de novas tentativas para falhas transitórias. O padrão é 2.

refresh_buffer: int — Segundos antes da expiração para acionar a atualização proativa. O padrão é 60. Métodosget_token() -> str — Retorna um token de acesso válido, atualizando se necessário. Passe esta referência de método para o SDK: Frameio(token=auth.get_token). get_authorization_url(state: str) -> AuthorizationUrlResult — Cria a URL de autorização do Adobe IMS com desafio PKCE. Retorna um AuthorizationUrlResult com atributos url e code_verifier. exchange_code(code: str, code_verifier: str) -> dict[str, Any] — Troca um código de autorização + verificador PKCE por tokens. refresh() -> dict[str, Any] — Aciona manualmente uma atualização de token. revoke() -> None — Revoga ambos os tokens no lado do servidor e limpa o estado local. export_tokens() -> dict[str, Any] — Exporta o estado atual do token para persistência. import_tokens(data: dict[str, Any]) -> None — Restaura o estado do token a partir de um dict exportado anteriormente.

Dataclass congelada retornada por SPAAuth.get_authorization_url() e AsyncSPAAuth.get_authorization_url(). Mantém a URL de autorização e o verificador de código PKCE. Atributosurl: str — A URL de autorização completa para a qual redirecionar o usuário. code_verifier: str — O verificador de código PKCE a ser armazenado e passado para exchange_code().

Fecha os clientes HTTP em nível de módulo usados pelo módulo de autenticação. Chame close_clients() em código síncrono ou await aclose_clients() em código assíncrono durante o encerramento do aplicativo para liberar conexões.

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

Listar coleções de um projeto.

Limites de taxa: 100 chamadas por 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 solicitações que retornam resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuração específica da solicitação.

Mostrar detalhes da coleção.

Limites de taxa: 100 chamadas por 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] — Configuração específica da solicitação.

Mostrar um único comentário em um arquivo.

Limites de taxa: 100 chamadas por 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] — Configuração específica da solicitação.

Excluir comentário de um ativo.

Limites de taxa: 60 chamadas por 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] — Configuração específica da solicitação.

Atualizar comentário no ativo fornecido.

Limites de taxa: 10 chamadas por 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] — Configuração específica da solicitação.

Listar comentários em um determinado ativo.

Limites de taxa: 100 chamadas por 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 solicitações que retornam resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuração específica da solicitação.

Criar um comentário em um arquivo.

Limites de taxa: 100 chamadas por 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] — Configuração específica da solicitação.

Criar um anexo para um comentário existente.

Limites de taxa: 60 chamadas por 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] — Configuração específica da solicitação.

Excluir anexo de comentário.

Limites de taxa: 60 chamadas por 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] — Configuração específica da solicitação.

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

Limites de taxa: 100 chamadas por 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 solicitações que retornam resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuração específica da solicitação.

Expandir detalhes de ação personalizada.

Limites de taxa: 100 chamadas por 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] — Configuração específica da solicitação.

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

Limites de taxa: 10 chamadas por 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] — Configuração específica da solicitação.

Atualizar detalhes da ação personalizada.

Limites de taxa: 10 chamadas por 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] — Configuração específica da solicitação.

Excluir uma ação personalizada.

Limites de taxa: 60 chamadas por 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] — Configuração específica da solicitação.

Listar arquivos de uma pasta específica.

Limites de taxa: 5 chamadas por 1 segundo(s) 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 solicitações que retornam resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuração específica da solicitação.

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

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

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] — Configuração específica da solicitação.

Mostrar detalhes do arquivo.

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

Limites de taxa: 5 chamadas por 1 segundo(s) 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] — Configuração específica da solicitação.

Excluir arquivo por ID.

Limites de taxa: 100 chamadas por 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] — Configuração específica da solicitação.

Atualizar detalhes do arquivo.

Limites de taxa: 100 chamadas por 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] — Configuração específica da solicitação.

Copiar arquivo.

Limites de taxa: 100 chamadas por 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] — Whether to copy metadata values along with the file

copy_comments: typing.Optional[FilesCopyRequestCopyComments] — Which comments to copy along with the file

data: typing.Optional[FileCopyParamsData]

request_options: typing.Optional[RequestOptions] — Configuração específica da solicitação.

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

Limites de taxa: 5 chamadas por 1 segundo(s) 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] — Configuração específica da solicitação.

Mover arquivo para uma pasta ou version_stack.

Limites de taxa: 100 chamadas por 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] — Configuração específica da solicitação.

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

Limites de taxa: 5 chamadas por 1 segundo(s) 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] — Configuração específica da solicitação.

Mostrar detalhes do status de upload do arquivo.

Limites de taxa: 5 chamadas por 1 segundo(s) 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] — Configuração específica da solicitação.

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

Limites de taxa: 5 chamadas por 1 segundo(s) 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] — Configuração específica da solicitação.

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

Limites de taxa: 100 chamadas por 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] — Oferece suporte para incluir usuários desativados na resposta. O padrão é false.

after: typing.Optional[RequestAfterOpaqueCursor]

Parâmetro de consulta de cursor opaco para solicitações que retornam resultados paginados.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configuração específica da solicitação.

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

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

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] — Configuração específica da solicitação.

Remover um usuário de uma determinada pasta.

Limites de taxa: 60 chamadas por 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] — Configuração específica da solicitação.

Mostrar detalhes da pasta.

Limites de taxa: 100 chamadas por 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] — Configuração específica da solicitação.

Excluir pasta por ID.

Limites de taxa: 60 chamadas por 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] — Configuração específica da solicitação.

Atualizar detalhes da pasta.

Limites de taxa: 10 chamadas por 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] — Configuração específica da solicitação.

Listar as tarefas derivadas na pasta especificada.

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

Limites de taxa: 100 chamadas por 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
)