Справочник по SDK для Python

Создает список ролей пользователя для указанной учетной записи.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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

Параметры

account_id: Uuid —

include_deactivated: typing.Optional[bool] — поддерживает включение деактивированных пользователей в ответ. По умолчанию: false.

after: typing.Optional[RequestAfterOpaqueCursor]

Параметр запроса «непрозрачный курсор» для запросов, возвращающих разбитые на страницы результаты.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает список учетных записей для текущего пользователя.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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

Параметры

after: typing.Optional[RequestAfterOpaqueCursor]

Параметр запроса «непрозрачный курсор» для запросов, возвращающих разбитые на страницы результаты.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает список журналов аудита с возможностями фильтрации через параметры запроса.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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

Параметры

account_id: Uuid —

api_version: typing.Literal["4.0"] —

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

filters: typing.Optional[Filters] —

after: typing.Optional[RequestAfterOpaqueCursor]

Параметр запроса «непрозрачный курсор» для запросов, возвращающих разбитые на страницы результаты.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Выполняет аутентификацию с использованием типа разрешения client_credentials протокола OAuth 2.0. Этот процесс не подразумевает участия пользователя и не возвращает токен обновления. Когда срок действия токена доступа истекает, SDK автоматически запрашивает новый, используя учетные данные клиента. В асинхронном коде следует использовать класс 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)

Параметры

client_id: str — идентификатор клиента Oauth в Adobe IMS.

client_secret: str — секретный ключ клиента Oauth в Adobe IMS.

scopes: str — разделенный пробелами список областей доступа (OAuth 2.0 RFC 6749). По умолчанию используется openid AdobeID frame.s2s.all.

ims_base_url: str — базовый URL-адрес сервиса IMS для работы в тестовых/альтернативных средах. По умолчанию указывает на производственную среду.

http_client: typing.Optional[httpx.Client] — необязательный клиент httpx.Client для прокси, TLS или пула подключений.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — необязательная функция обратного вызова, которая срабатывает после каждого запроса токена.

timeout: float — время ожидания запроса HTTP в секундах. По умолчанию: 30.

max_retries: int — максимальное количество повторных попыток при временных сбоях. По умолчанию: 2.

refresh_buffer: int — количество секунд до истечения срока действия токена, при котором запускается упреждающее обновление. По умолчанию: 60. Методы get_token() -> str — возвращает действующий токен доступа, при необходимости выполняя его обновление. Передавайте в SDK ссылку на метод (не вызов): Frameio(token=auth.get_token). authenticate() -> dict[str, Any] — выполняет явный запрос нового токена доступа. Возвращает словарь с ответом сервера, содержащий access_token, expires_in и другие параметры. revoke() -> None — аннулирует оба токена на стороне сервера и очищает локальные данные о состоянии токенов. export_tokens() -> dict[str, Any] — экспортирует текущее состояние токенов для последующего сохранения. import_tokens(data: dict[str, Any]) -> None — восстанавливает состояние токенов из ранее экспортированного словаря.

Выполняет аутентификацию с использованием типа разрешения authorization_code протокола OAuth 2.0. Используйте этот процесс для серверных приложений, которые могут безопасно хранить секретный ключ клиента. В асинхронном коде следует использовать класс 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)

Параметры

client_id: str — идентификатор клиента Oauth в Adobe IMS.

client_secret: str — секретный ключ клиента Oauth в Adobe IMS.

redirect_uri: str — зарегистрированный URI перенаправления.

scopes: str — разделенный пробелами список областей доступа (OAuth 2.0 RFC 6749).

ims_base_url: str — базовый URL-адрес сервиса IMS для работы в тестовых/альтернативных средах. По умолчанию указывает на производственную среду.

http_client: typing.Optional[httpx.Client] — необязательный клиент httpx.Client для прокси, TLS или пула подключений.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — необязательная функция обратного вызова, которая срабатывает после каждого обновления токена.

timeout: float — время ожидания запроса HTTP в секундах. По умолчанию: 30.

max_retries: int — максимальное количество повторных попыток при временных сбоях. По умолчанию: 2.

refresh_buffer: int — количество секунд до истечения срока действия токена, при котором запускается упреждающее обновление. По умолчанию: 60. Методы get_token() -> str — возвращает действующий токен доступа, при необходимости выполняя его обновление. Передавайте в SDK ссылку на метод: Frameio(token=auth.get_token). get_authorization_url(state: str) -> str — формирует URL-адрес авторизации Adobe IMS. Передавайте непрозрачное значение CSRF/state, которое будет возвращаться обратно без изменений. exchange_code(code: str) -> dict[str, Any] — обменивает код авторизации на токены доступа и обновления. refresh() -> dict[str, Any] — вручную запускает обновление токенов. revoke() -> None — аннулирует оба токена на стороне сервера и очищает локальные данные о состоянии токенов. export_tokens() -> dict[str, Any] — экспортирует текущее состояние токенов для последующего сохранения. import_tokens(data: dict[str, Any]) -> None — восстанавливает состояние токенов из ранее экспортированного словаря.

Выполняет аутентификацию с использованием комбинации authorization_code + PKCE (без секретного ключа клиента). Используйте этот процесс для браузерных или встроенных приложений, которые не могут безопасно хранить секретный ключ клиента. В асинхронном коде следует использовать класс 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)

Параметры

client_id: str — идентификатор клиента Oauth в Adobe IMS.

redirect_uri: str — зарегистрированный URI перенаправления.

scopes: str — разделенный пробелами список областей доступа (OAuth 2.0 RFC 6749).

ims_base_url: str — базовый URL-адрес сервиса IMS для работы в тестовых/альтернативных средах. По умолчанию указывает на производственную среду.

http_client: typing.Optional[httpx.Client] — необязательный клиент httpx.Client для прокси, TLS или пула подключений.

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — необязательная функция обратного вызова, которая срабатывает после каждого обновления токена.

timeout: float — время ожидания запроса HTTP в секундах. По умолчанию: 30.

max_retries: int — максимальное количество повторных попыток при временных сбоях. По умолчанию: 2.

refresh_buffer: int — количество секунд до истечения срока действия токена, при котором запускается упреждающее обновление. По умолчанию: 60. Методы get_token() -> str — возвращает действующий токен доступа, при необходимости выполняя его обновление. Передавайте в SDK ссылку на метод: Frameio(token=auth.get_token). get_authorization_url(state: str) -> AuthorizationUrlResult — формирует URL-адрес авторизации Adobe IMS с использованием механизма PKCE challenge. Возвращает объект AuthorizationUrlResult с атрибутами url и code_verifier. exchange_code(code: str, code_verifier: str) -> dict[str, Any] — обменивает код авторизации совместно с проверочным ключом PKCE на токены. refresh() -> dict[str, Any] — вручную запускает обновление токенов. revoke() -> None — аннулирует оба токена на стороне сервера и очищает локальные данные о состоянии токенов. export_tokens() -> dict[str, Any] — экспортирует текущее состояние токенов для последующего сохранения. import_tokens(data: dict[str, Any]) -> None — восстанавливает состояние токенов из ранее экспортированного словаря.

Неизменяемый класс данных, возвращаемый методами SPAAuth.get_authorization_url() и AsyncSPAAuth.get_authorization_url(). Содержит URL-адрес авторизации и проверочный ключ PKCE. Атрибуты url: str — полный URL-адрес авторизации, на который необходимо перенаправить пользователя. code_verifier: str — проверочный ключ PKCE, который необходимо сохранить и затем передать в метод exchange_code().

Закрывает HTTP-клиенты уровня модуля, используемые модулем аутентификации. Вызывайте метод close_clients() в синхронном коде или await aclose_clients() в асинхронном при завершении работы приложения, чтобы освободить подключения.

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

Создает список коллекций для проекта.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

project_id: Uuid —

include: typing.Optional[CollectionInclude] —

after: typing.Optional[RequestAfterOpaqueCursor]

Параметр запроса «непрозрачный курсор» для запросов, возвращающих разбитые на страницы результаты.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Показывает сведения о коллекции.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

collection_id: Uuid —

include: typing.Optional[CollectionInclude] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Показывает отдельный комментарий к файлу.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

comment_id: Uuid —

include: typing.Optional[CommentsShowRequestInclude] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Удаляет комментарий из ресурса.

Лимиты запросов: 60 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

comment_id: Uuid —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Обновляет комментарий к указанному ресурсу.

Лимиты запросов: 10 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

comment_id: Uuid —

data: UpdateCommentParamsData

timestamp_as_timecode: typing.Optional[bool] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает список комментариев к указанному ресурсу.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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

Параметры

account_id: Uuid —

file_id: Uuid —

include: typing.Optional[CommentInclude] —

after: typing.Optional[RequestAfterOpaqueCursor]

Параметр запроса «непрозрачный курсор» для запросов, возвращающих разбитые на страницы результаты.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает комментарий к файлу.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

file_id: Uuid —

data: CreateCommentParamsData

timestamp_as_timecode: typing.Optional[bool] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает вложение к существующему комментарию.

Лимиты запросов: 60 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

comment_id: Uuid —

data: AttachmentInput

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Удаляет вложение из комментария.

Лимиты запросов: 60 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

comment_id: Uuid —

attachment_id: Uuid —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает список действий в указанной рабочей среде.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

workspace_id: Uuid —

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

after: typing.Optional[RequestAfterOpaqueCursor]

Параметр запроса «непрозрачный курсор» для запросов, возвращающих разбитые на страницы результаты.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Выводит сведения о пользовательском действии.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

action_id: Uuid —

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

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает пользовательское действие в рабочей среде.

Лимиты запросов: 10 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

workspace_id: Uuid —

data: ActionCreateParamsData

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Обновляет сведения о пользовательском действии.

Лимиты запросов: 10 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

action_id: Uuid —

data: ActionUpdateParamsData

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Удаляет пользовательское действие.

Лимиты запросов: 60 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

action_id: Uuid —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает список файлов в указанной папке.

Лимиты запросов: 5 вызовов в течение 1 секунды для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

include: typing.Optional[FileWithMediaLinksInclude] —

after: typing.Optional[RequestAfterOpaqueCursor]

Параметр запроса «непрозрачный курсор» для запросов, возвращающих разбитые на страницы результаты.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает новый файл в родительской папке. Создать файл (локальное добавление) и Создать файл (удаленное добавление) заменили эту конечную точку.

Лимиты запросов: 5 вызовов в течение 1 секунды для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

data: FileCreateParamsData

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Показывает сведения о файле.

Используйте параметр запроса include, чтобы в ответ выборочно включались дополнительные свойства.

Лимиты запросов: 5 вызовов в течение 1 секунды для 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
)

Параметры

account_id: Uuid —

file_id: Uuid —

include: typing.Optional[FileWithMediaLinksInclude] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Удаляет файл по идентификатору.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

file_id: Uuid —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Обновляет сведения о файле.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

file_id: Uuid —

data: FileUpdateParamsData

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Копирует файл.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

file_id: Uuid —

copy_metadata: typing.Optional[bool] — копировать ли значения метаданных вместе с файлом

copy_comments: typing.Optional[FilesCopyRequestCopyComments] — какие комментарии копировать вместе с файлом

data: typing.Optional[FileCopyParamsData]

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает новый файл в родительской папке путем удаленного добавления.

Лимиты запросов: 5 вызовов в течение 1 секунды для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

data: FileCreateRemoteUploadParamsData

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Перемещает файл в папку или стек версий.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

file_id: Uuid —

data: FileMoveParamsData

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает новый файл в родительской папке путем локального добавления.

Лимиты запросов: 5 вызовов в течение 1 секунды для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

data: FileCreateLocalUploadParamsData

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Показать сведения о статусе добавления файла.

Лимиты запросов: 5 вызовов в течение 1 секунды для 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
)

Параметры

account_id: Uuid —

file_id: Uuid —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Импортирует файл из хранилища, настроенного в учетной записи.

Лимиты запросов: 5 вызовов в течение 1 секунды для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

data: FileImportParamsData

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает список ролей пользователей для указанной папки.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

include_deactivated: typing.Optional[bool] — поддерживает включение деактивированных пользователей в ответ. По умолчанию: false.

after: typing.Optional[RequestAfterOpaqueCursor]

Параметр запроса «непрозрачный курсор» для запросов, возвращающих разбитые на страницы результаты.

page_size: typing.Optional[RequestPageSize] —

include_total_count: typing.Optional[IncludeTotalCount] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Обновляет роли пользователей для указанной папки, если пользователь уже добавлен в нее. Если пользователь не добавлен в эту папку, он будет добавлен с указанной ролью.

Лимиты запросов: 10 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

user_id: Uuid —

data: UpdateUserRolesParamsData

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Удаляет пользователя из указанной папки.

Лимиты запросов: 60 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

user_id: Uuid —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Показывает сведения о папке.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

include: typing.Optional[AssetInclude] —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Удаляет папку по идентификатору.

Лимиты запросов: 60 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Обновляет сведения о папке.

Лимиты запросов: 10 вызовов в течение 1 минуты для 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
)

Параметры

account_id: Uuid —

folder_id: Uuid —

data: FolderUpdateParamsData

request_options: typing.Optional[RequestOptions] — конфигурация на уровне конкретного запроса.

Создает список дочерних элементов в указанной папке.

Используйте параметр запроса include, чтобы в ответ выборочно включались дополнительные свойства.

Лимиты запросов: 100 вызовов в течение 1 минуты для 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
)