Python SDK 참조

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

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

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

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)

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)

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)

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

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
)

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
)

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
)

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
)

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
)

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

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)

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
)