Riferimento SDK Python

Elenca i ruoli utente per un account specifico.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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

Parametri

account_id: Uuid —

include_deactivated: typing.Optional[bool] — Supporta l’inclusione di utenti disattivati nella risposta.Il valore predefinito è false.

after: typing.Optional[RequestAfterOpaqueCursor]

Parametro di richiesta del cursore opaco per le richieste che restituiscono risultati impaginati.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elenca gli account per l’utente corrente.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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

Parametri

after: typing.Optional[RequestAfterOpaqueCursor]

Parametro di richiesta del cursore opaco per le richieste che restituiscono risultati impaginati.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elenca i registri di controllo con alcune funzionalità di filtro tramite parametri di query.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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

Parametri

account_id: Uuid —

api_version: typing.Literal["4.0"] —

include: typing.Optional[typing.Literal["user"]] —

filters: typing.Optional[Filters] —

after: typing.Optional[RequestAfterOpaqueCursor]

Parametro di richiesta del cursore opaco per le richieste che restituiscono risultati impaginati.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Autenticati utilizzando la concessione client_credentials OAuth 2.0. Questo flusso non coinvolge un utente e non restituisce un token di aggiornamento. Quando il token di accesso scade, l’SDK ne richiede automaticamente uno nuovo utilizzando le credenziali client. Per l’utilizzo asincrono, usa 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)

Parametri

client_id: str — ID cliente OAuth di Adobe IMS.

client_secret: str — Secret del client OAuth di Adobe IMS.

scopes: str — Ambiti separati da spazi (OAuth 2.0 RFC 6749). Il valore predefinito è openid AdobeID frame.s2s.all.

ims_base_url: str — URL di base IMS per ambienti temporanei/alternativi. Il valore predefinito è production.

http_client: typing.Optional[httpx.Client] — httpx opzionale.Client per proxy, TLS o pool di connessioni.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — Callback opzionale attivato dopo ogni recupero di token.

timeout: float — Timeout della richiesta HTTP in secondi. Il valore predefinito è 30.

max_retries: int — Numero massimo di nuovi tentativi per errori transitori. Il valore predefinito è 2.

refresh_buffer: int — Secondi prima della scadenza per attivare l’aggiornamento proattivo. Il valore predefinito è 60. Metodi get_token() -> str — Restituisce un token di accesso valido, aggiornandolo se necessario. Passa questo riferimento del metodo (non una chiamata) all’SDK: Frameio(token=auth.get_token). authenticate() -> dict[str, Any] — Recupera esplicitamente un nuovo token di accesso. Restituisce il dict di risposta del token con access_token, expires_in ecc. revoke() -> None — Revoca entrambi i token lato server e cancella lo stato locale. export_tokens() -> dict[str, Any] — Esporta lo stato corrente del token per la persistenza. import_tokens(data: dict[str, Any]) -> None — Ripristina lo stato del token da un dict esportato in precedenza.

Autenticati utilizzando la concessione authorization_code OAuth 2.0. Usa questo metodo per applicazioni sul lato server che possono archiviare in modo sicuro un secret del client. Per l’utilizzo asincrono, usa 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)

Parametri

client_id: str — ID cliente OAuth di Adobe IMS.

client_secret: str — Secret del client OAuth di Adobe IMS.

redirect_uri: str — URI di reindirizzamento registrato.

scopes: str — Ambiti separati da spazi (OAuth 2.0 RFC 6749).

ims_base_url: str — URL di base IMS per ambienti temporanei/alternativi. Il valore predefinito è production.

http_client: typing.Optional[httpx.Client] — httpx opzionale.Client per proxy, TLS o pool di connessioni.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — Callback opzionale attivato dopo ogni aggiornamento del token.

timeout: float — Timeout della richiesta HTTP in secondi. Il valore predefinito è 30.

max_retries: int — Numero massimo di nuovi tentativi per errori transitori. Il valore predefinito è 2.

refresh_buffer: int — Secondi prima della scadenza per attivare l’aggiornamento proattivo. Il valore predefinito è 60. Metodi get_token() -> str — Restituisce un token di accesso valido, aggiornandolo se necessario. Passa questo riferimento del metodo all’SDK: Frameio(token=auth.get_token). get_authorization_url(state: str) -> str — Crea l’URL di autorizzazione di Adobe IMS. Passa un valore CSRF/state opaco che sarà restituito. exchange_code(code: str) -> dict[str, Any] — Scambia un codice di autorizzazione con token di accesso e aggiornamento. refresh() -> dict[str, Any] — Attiva manualmente un aggiornamento del token. revoke() -> None — Revoca entrambi i token lato server e cancella lo stato locale. export_tokens() -> dict[str, Any] — Esporta lo stato corrente del token per la persistenza. import_tokens(data: dict[str, Any]) -> None — Ripristina lo stato del token da un dict esportato in precedenza.

Autenticati utilizzando authorization_code + PKCE (senza secret del client). Utilizza questa opzione per applicazioni basate su browser o native che non possono archiviare in sicurezza un secret del client. Per l’utilizzo asincrono, usa 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)

Parametri

client_id: str — ID cliente OAuth di Adobe IMS.

redirect_uri: str — URI di reindirizzamento registrato.

scopes: str — Ambiti separati da spazi (OAuth 2.0 RFC 6749).

ims_base_url: str — URL di base IMS per ambienti temporanei/alternativi. Il valore predefinito è production.

http_client: typing.Optional[httpx.Client] — httpx opzionale.Client per proxy, TLS o pool di connessioni.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — Callback opzionale attivato dopo ogni aggiornamento del token.

timeout: float — Timeout della richiesta HTTP in secondi. Il valore predefinito è 30.

max_retries: int — Numero massimo di nuovi tentativi per errori transitori. Il valore predefinito è 2.

refresh_buffer: int — Secondi prima della scadenza per attivare l’aggiornamento proattivo. Il valore predefinito è 60. Metodi get_token() -> str — Restituisce un token di accesso valido, aggiornandolo se necessario. Passa questo riferimento del metodo all’SDK: Frameio(token=auth.get_token). get_authorization_url(state: str) -> AuthorizationUrlResult — Crea l’URL di autorizzazione di Adobe IMS con challenge PKCE. Restituisce un AuthorizationUrlResult con gli attributi url e code_verifier. exchange_code(code: str, code_verifier: str) -> dict[str, Any] — Scambia un codice di autorizzazione + verificatore PKCE per i token. refresh() -> dict[str, Any] — Attiva manualmente un aggiornamento del token. revoke() -> None — Revoca entrambi i token lato server e cancella lo stato locale. export_tokens() -> dict[str, Any] — Esporta lo stato corrente del token per la persistenza. import_tokens(data: dict[str, Any]) -> None — Ripristina lo stato del token da un dict esportato in precedenza.

Classe di dati bloccata restituita da SPAAuth.get_authorization_url() e AsyncSPAAuth.get_authorization_url(). Contiene l’URL di autorizzazione e il verificatore del codice PKCE. Attributi url: str — L’URL di autorizzazione completo verso cui reindirizzare l’utente. code_verifier: str — Il verificatore del codice PKCE da memorizzare e passare a exchange_code().

Chiudi i client HTTP a livello di modulo utilizzati dal modulo di autenticazione. Chiama close_clients() nel codice sincrono o await aclose_clients() nel codice asincrono durante la chiusura dell’applicazione per rilasciare le connessioni.

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

Elenca le raccolte per un progetto.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

project_id: Uuid —

include: typing.Optional[CollectionInclude] —

after: typing.Optional[RequestAfterOpaqueCursor]

Parametro di richiesta del cursore opaco per le richieste che restituiscono risultati impaginati.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Mostra i dettagli della raccolta.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

collection_id: Uuid —

include: typing.Optional[CollectionInclude] —

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Visualizza un singolo commento su un file.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

comment_id: Uuid —

include: typing.Optional[CommentsShowRequestInclude] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elimina il commento da una risorsa.

Limiti di frequenza: 60 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

comment_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Aggiorna il commento sulla risorsa specificata.

Limiti di frequenza: 10 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

comment_id: Uuid —

data: UpdateCommentParamsData

timestamp_as_timecode: typing.Optional[bool] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elenca i commenti sulla risorsa specificata.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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

Parametri

account_id: Uuid —

file_id: Uuid —

include: typing.Optional[CommentInclude] —

after: typing.Optional[RequestAfterOpaqueCursor]

Parametro di richiesta del cursore opaco per le richieste che restituiscono risultati impaginati.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Crea un commento su un file.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

file_id: Uuid —

data: CreateCommentParamsData

timestamp_as_timecode: typing.Optional[bool] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Crea un allegato per un commento esistente.

Limiti di frequenza: 60 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

comment_id: Uuid —

data: AttachmentInput

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elimina un allegato da un commento.

Limiti di frequenza: 60 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

comment_id: Uuid —

attachment_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elenca le azioni in un’area di lavoro specifica.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

workspace_id: Uuid —

include: typing.Optional[typing.Literal["creator"]] —

after: typing.Optional[RequestAfterOpaqueCursor]

Parametro di richiesta del cursore opaco per le richieste che restituiscono risultati impaginati.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Mostra i dettagli dell’azione personalizzata.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

action_id: Uuid —

include: typing.Optional[typing.Literal["creator"]] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Crea un’azione personalizzata in un’area di lavoro.

Limiti di frequenza: 10 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

workspace_id: Uuid —

data: ActionCreateParamsData

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Aggiorna i dettagli dell’azione personalizzata.

Limiti di frequenza: 10 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

action_id: Uuid —

data: ActionUpdateParamsData

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elimina un’azione personalizzata.

Limiti di frequenza: 60 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

action_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elenca i file in una cartella specifica.

Limiti di frequenza: 5 chiamate ogni 1 secondo per 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
)

Parametri

account_id: Uuid —

folder_id: Uuid —

include: typing.Optional[FileWithMediaLinksInclude] —

after: typing.Optional[RequestAfterOpaqueCursor]

Parametro di richiesta del cursore opaco per le richieste che restituiscono risultati impaginati.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Crea un nuovo file nella cartella padre. Create file (local upload) e Create file (remote upload) hanno sostituito questo endpoint.

Limiti di frequenza: 5 chiamate ogni 1 secondo per 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
)

Parametri

account_id: Uuid —

folder_id: Uuid —

data: FileCreateParamsData

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Mostra i dettagli del file.

Usa il parametro di query “include” della richiesta per includere in modo selettivo proprietà aggiuntive nella risposta.

Limiti di frequenza: 5 chiamate ogni 1 secondo per 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
)

Parametri

account_id: Uuid —

file_id: Uuid —

include: typing.Optional[FileWithMediaLinksInclude] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elimina il file in base all’ID.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

file_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Aggiorna i dettagli del file.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

file_id: Uuid —

data: FileUpdateParamsData

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Copia il file.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

file_id: Uuid —

copy_metadata: typing.Optional[bool] — Indica se copiare i valori dei metadati insieme al file

dipy_comments: typing.Optional[FilesCopyRequestCopyComments] — Indica quali commenti copiare insieme al file

data: typing.Optional[FileCopyParamsData]

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Crea un nuovo file nella cartella padre tramite caricamento remoto.

Limiti di frequenza: 5 chiamate ogni 1 secondo per 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
)

Parametri

account_id: Uuid —

folder_id: Uuid —

data: FileCreateRemoteUploadParamsData

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Sposta il file in una cartella o in uno stack di versioni.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

file_id: Uuid —

data: FileMoveParamsData

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Crea un nuovo file nella cartella padre tramite caricamento locale.

Limiti di frequenza: 5 chiamate ogni 1 secondo per 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
)

Parametri

account_id: Uuid —

folder_id: Uuid —

data: FileCreateLocalUploadParamsData

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Mostra i dettagli dello stato di caricamento del file.

Limiti di frequenza: 5 chiamate ogni 1 secondo per 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
)

Parametri

account_id: Uuid —

file_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Importa un file da una posizione di archiviazione configurata sull’account.

Limiti di frequenza: 5 chiamate ogni 1 secondo per 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
)

Parametri

account_id: Uuid —

folder_id: Uuid —

data: FileImportParamsData

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elenca i ruoli utente per un cartella specifica.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parameters

account_id: Uuid —

folder_id: Uuid —

include_deactivated: typing.Optional[bool] — Supporta l’inclusione di utenti disattivati nella risposta. Il valore predefinito è false.

after: typing.Optional[RequestAfterOpaqueCursor]

Parametro di richiesta del cursore opaco per le richieste che restituiscono risultati impaginati.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Aggiorna i ruoli utente per la cartella specificata se l’utente è già stato aggiunto alla cartella. Se l’utente non è stato aggiunto alla cartella, viene aggiunto con il ruolo specificato.

Limiti di frequenza: 10 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

folder_id: Uuid —

user_id: Uuid —

data: UpdateUserRolesParamsData

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Rimuovi un utente da una cartella specifica.

Limiti di frequenza: 60 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

folder_id: Uuid —

user_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Mostra i dettagli della cartella.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

folder_id: Uuid —

include: typing.Optional[AssetInclude] —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elimina la cartella in base all’ID.

Limiti di frequenza: 60 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

folder_id: Uuid —

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Aggiorna i dettagli della cartella.

Limiti di frequenza: 10 chiamate ogni 1,00 minuto per 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
)

Parametri

account_id: Uuid —

folder_id: Uuid —

data: FolderUpdateParamsData

request_options: typing.Optional[RequestOptions] — Configurazione specifica della richiesta.

Elenca gli elementi figlio nella cartella specificata.

Usa il parametro di query “include” della richiesta per includere in modo selettivo proprietà aggiuntive nella risposta.

Limiti di frequenza: 100 chiamate ogni 1,00 minuto per 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
)