Python SDK リファレンス

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
from frameio.metadata import (
3
    BulkUpdateMetadataParamsData,
4
    BulkUpdateMetadataParamsDataValuesItem,
5
)
6
7
client = Frameio(
8
    token="YOUR_TOKEN",
9
)
10
client.metadata.bulk_update(
11
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
12
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
13
    data=BulkUpdateMetadataParamsData(
14
        file_ids=[
15
            "09b31c2a-04de-464a-a593-643a36ef0d98",
16
            "b967fc36-4e18-4b48-a3ab-c790100e2baa",
17
        ],
18
        values=[
19
            BulkUpdateMetadataParamsDataValuesItem(
20
                field_definition_id="ff41ce50-269b-4624-8306-aac10e28ab94",
21
                value=[
22
                    {
23
                        "id": "e60f47b4-cf8e-4273-96d5-3258a830a0aa",
24
                        "type": "user",
25
                    },
26
                    {
27
                        "id": "24eeaf7e-ce27-4555-bc77-cce39900626d",
28
                        "type": "account_user_group",
29
                    },
30
                ],
31
            )
32
        ],
33
    ),
34
)

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

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

1
from frameio import (
2
    Frameio,
3
    UpdateSelectDefinitionParamsFieldConfiguration,
4
    UpdateSelectDefinitionParamsFieldConfigurationOptionsItem,
5
)
6
from frameio.metadata_fields import UpdateFieldDefinitionParamsData_Select
7
8
client = Frameio(
9
    token="YOUR_TOKEN",
10
)
11
client.metadata_fields.metadata_field_definitions_update(
12
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
13
    field_definition_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
14
    data=UpdateFieldDefinitionParamsData_Select(
15
        field_configuration=UpdateSelectDefinitionParamsFieldConfiguration(
16
            enable_add_new=False,
17
            options=[
18
                UpdateSelectDefinitionParamsFieldConfigurationOptionsItem(
19
                    display_name="Option 1",
20
                ),
21
                UpdateSelectDefinitionParamsFieldConfigurationOptionsItem(
22
                    display_name="Option 2",
23
                ),
24
            ],
25
        ),
26
        name="Updated-Field-Name",
27
    ),
28
)

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

1
from frameio import (
2
    Frameio,
3
    SelectDefinitionParamsFieldConfiguration,
4
    SelectDefinitionParamsFieldConfigurationOptionsItem,
5
)
6
from frameio.metadata_fields import CreateFieldDefinitionParamsData_Select
7
8
client = Frameio(
9
    token="YOUR_TOKEN",
10
)
11
client.metadata_fields.metadata_field_definitions_create(
12
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
13
    data=CreateFieldDefinitionParamsData_Select(
14
        field_configuration=SelectDefinitionParamsFieldConfiguration(
15
            enable_add_new=False,
16
            options=[
17
                SelectDefinitionParamsFieldConfigurationOptionsItem(
18
                    display_name="Option 1",
19
                ),
20
                SelectDefinitionParamsFieldConfigurationOptionsItem(
21
                    display_name="Option 2",
22
                ),
23
            ],
24
        ),
25
        name="Fields definition name",
26
    ),
27
)

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
response = client.project_permissions.index(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include_deactivated=True,
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
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.project_permissions.delete(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
)

1
from frameio import Frameio, UpdateUserRolesParamsData
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.project_permissions.project_user_roles_update(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    project_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.projects.show(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
)

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

1
from frameio import Frameio
2
from frameio.projects import ProjectUpdateParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.projects.update(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=ProjectUpdateParamsData(
11
        name="Project Name",
12
        restricted=True,
13
        status="active",
14
    ),
15
)

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
response = client.projects.index(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
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
from frameio.projects import ProjectParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.projects.create(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=ProjectParamsData(
11
        name="Project Name",
12
        restricted=True,
13
    ),
14
)

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
)

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.folders.list(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    folder_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
from frameio.folders import FolderCreateParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.folders.create(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=FolderCreateParamsData(
11
        name="Folder name",
12
    ),
13
)

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.version_stacks.index(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    version_stack_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
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.version_stacks.show(
7
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8
    version_stack_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    include="media_links",
10
)

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

1
from frameio import Frameio
2
3
client = Frameio(
4
    token="YOUR_TOKEN",
5
)
6
client.version_stacks.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.version_stacks import VersionStackCreateParamsData
3
4
client = Frameio(
5
    token="YOUR_TOKEN",
6
)
7
client.version_stacks.create(
8
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10
    data=VersionStackCreateParamsData(
11
        file_ids=[
12
            "dd2a3cdd-fc90-41bd-a7b8-8a0447aec6d4",
13
            "79fed48a-8372-496e-8dcb-5e959b9b9fcf",
14
        ],
15
    ),
16
)

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

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
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