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

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
const response = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include_deactivated: true,
3
    after: "<opaque_cursor>",
4
    page_size: 10,
5
    include_total_count: false,
6
});
7
for await (const item of response) {
8
    console.log(item);
9
}
10
11
// Or you can manually iterate page-by-page
12
let page = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
13
    include_deactivated: true,
14
    after: "<opaque_cursor>",
15
    page_size: 10,
16
    include_total_count: false,
17
});
18
while (page.hasNextPage()) {
19
    page = page.getNextPage();
20
}

Параметры

accountId: Frameio.Uuid —

request: Frameio.AccountPermissionsIndexRequest

requestOptions: AccountPermissions.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
const response = await client.accounts.index({
2
    after: "<opaque_cursor>",
3
    page_size: 10,
4
    include_total_count: false,
5
});
6
for await (const item of response) {
7
    console.log(item);
8
}
9
10
// Or you can manually iterate page-by-page
11
let page = await client.accounts.index({
12
    after: "<opaque_cursor>",
13
    page_size: 10,
14
    include_total_count: false,
15
});
16
while (page.hasNextPage()) {
17
    page = page.getNextPage();
18
}

Параметры

request: Frameio.AccountsIndexRequest

requestOptions: Accounts.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "user",
3
    after: "<opaque_cursor>",
4
    page_size: 10,
5
    include_total_count: false,
6
});

Параметры

accountId: Frameio.FrameOrAdobeId —

request: Frameio.AuditlogIndexRequest

requestOptions: Accounts.RequestOptions

Выполняет аутентификацию с использованием типа разрешения client_credentials протокола OAuth 2.0. Этот процесс не подразумевает участия пользователя и не возвращает токен обновления. Когда срок действия токена доступа истекает, SDK автоматически запрашивает новый, используя учетные данные клиента.

1
import { FrameioClient, ServerToServerAuth } from "frameio";
2
3
const auth = new ServerToServerAuth({
4
    clientId: "YOUR_CLIENT_ID",
5
    clientSecret: "YOUR_CLIENT_SECRET",
6
});
7
const client = new FrameioClient({ token: () => auth.getToken() });

Параметры

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

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

scopes: string — разделенный пробелами список областей доступа (OAuth 2.0 RFC 6749). По умолчанию используются области доступа для межсерверной аутентификации.

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

fetch: typeof fetch — пользовательская реализация функции fetch (для прокси, TLS и т. д.).

onTokenRefreshed: OnTokenRefreshed — дополнительный обратный вызов, срабатывающий после каждого получения токена.

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

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

refreshBuffer: number — количество секунд до истечения срока действия токена, при котором запускается упреждающее обновление. По умолчанию: 60.

logger: Logger — экземпляр логгера для вывода диагностических данных. Методы getToken(): Promise<string> — возвращает действующий токен доступа, при необходимости выполняя его обновление. Передайте его клиенту: new FrameioClient({ token: () => auth.getToken() }). authenticate(): Promise<TokenResponse> — принудительно запускает процесс получения нового токен доступа. revoke(): Promise<void> — аннулирует оба токена на стороне сервера и очищает локальные данные о состоянии токенов. exportTokens(): ExportedTokens — экспортирует текущее состояние токенов для последующего сохранения. importTokens(data: ExportedTokens): void — восстанавливает состояние токенов из ранее экспортированного объекта.

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

1
import { randomBytes } from "crypto";
2
import { FrameioClient, WebAppAuth } from "frameio";
3
4
const auth = new WebAppAuth({
5
    clientId: "YOUR_CLIENT_ID",
6
    clientSecret: "YOUR_CLIENT_SECRET",
7
    redirectUri: "https://myapp.com/callback",
8
});
9
const url = auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") });
10
// redirect the user to url ...
11
await auth.exchangeCode("CODE_FROM_CALLBACK");
12
const client = new FrameioClient({ token: () => auth.getToken() });

Параметры

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

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

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

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

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

fetch: typeof fetch — пользовательская реализация функции fetch (для прокси, TLS и т. д.).

onTokenRefreshed: OnTokenRefreshed — дополнительный обратный вызов, срабатывающий после каждого обновления токена.

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

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

refreshBuffer: number — количество секунд до истечения срока действия токена, при котором запускается упреждающее обновление. По умолчанию: 60.

logger: Logger — экземпляр логгера для вывода диагностических данных. Методы getToken(): Promise<string> — возвращает действующий токен доступа, при необходимости выполняя его обновление. getAuthorizationUrl({ state }): string — формирует URL-адрес авторизации Adobe IMS. Передавайте непрозрачное значение CSRF/state, которое будет возвращаться обратно без изменений. exchangeCode(code: string): Promise<TokenResponse> — обменивает код авторизации на токены доступа и обновления. refresh(): Promise<TokenResponse> — позволяет вручную запустить обновление токена. revoke(): Promise<void> — аннулирует оба токена на стороне сервера и очищает локальные данные о состоянии токенов. exportTokens(): ExportedTokens — экспортирует текущее состояние токенов для последующего сохранения. importTokens(data: ExportedTokens): void — восстанавливает состояние токенов из ранее экспортированного объекта.

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

1
import { randomBytes } from "crypto";
2
import { FrameioClient, SPAAuth } from "frameio";
3
4
const auth = new SPAAuth({
5
    clientId: "YOUR_CLIENT_ID",
6
    redirectUri: "https://myapp.com/cb",
7
});
8
const result = await auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") });
9
// redirect the user to result.url, store result.codeVerifier ...
10
await auth.exchangeCode({ code: "CODE_FROM_CALLBACK", codeVerifier: result.codeVerifier });
11
const client = new FrameioClient({ token: () => auth.getToken() });

Параметры

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

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

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

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

fetch: typeof fetch — пользовательская реализация функции fetch (для прокси, TLS и т. д.).

onTokenRefreshed: OnTokenRefreshed — дополнительный обратный вызов, срабатывающий после каждого обновления токена.

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

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

refreshBuffer: number — количество секунд до истечения срока действия токена, при котором запускается упреждающее обновление. По умолчанию: 60.

logger: Logger — экземпляр логгера для вывода диагностических данных. Методы getToken(): Promise<string> — возвращает действующий токен доступа, при необходимости выполняя его обновление. getAuthorizationUrl({ state }): Promise<AuthorizationUrlResult> — формирует URL-адрес авторизации Adobe IMS с проверкой PKCE. Возвращает результат AuthorizationUrlResult, содержащий url и codeVerifier. exchangeCode({ code, codeVerifier }): Promise<TokenResponse> — обменивает код авторизации совместно с проверочным ключом PKCE на токены. refresh(): Promise<TokenResponse> — позволяет вручную запустить обновление токена. revoke(): Promise<void> — аннулирует оба токена на стороне сервера и очищает локальные данные о состоянии токенов. exportTokens(): ExportedTokens — экспортирует текущее состояние токенов для последующего сохранения. importTokens(data: ExportedTokens): void — восстанавливает состояние токенов из ранее экспортированного объекта.

Выполняет аутентификацию с использованием authorization_code и PKCE для приложений для ПК и мобильных устройств. Использует тот же API-интерфейс, что и SPAAuth; применяется пользовательская схема URI (например, myapp://callback).

1
import { randomBytes } from "crypto";
2
import { FrameioClient, NativeAppAuth } from "frameio";
3
4
const auth = new NativeAppAuth({
5
    clientId: "YOUR_CLIENT_ID",
6
    redirectUri: "myapp://callback",
7
});
8
const result = await auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") });
9
// open result.url in the system browser, store result.codeVerifier ...
10
await auth.exchangeCode({ code: "CODE_FROM_CALLBACK", codeVerifier: result.codeVerifier });
11
const client = new FrameioClient({ token: () => auth.getToken() });

Параметры

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

redirectUri: string — зарегистрированный URI перенаправления (с поддержкой пользовательских схем).

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

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

fetch: typeof fetch — пользовательская реализация функции fetch (для прокси, TLS и т. д.).

onTokenRefreshed: OnTokenRefreshed — дополнительный обратный вызов, срабатывающий после каждого обновления токена.

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

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

refreshBuffer: number — количество секунд до истечения срока действия токена, при котором запускается упреждающее обновление. По умолчанию: 60.

logger: Logger — экземпляр логгера для вывода диагностических данных. Методы Такие же, как и для SPAAuth: getToken(), getAuthorizationUrl({ state }), exchangeCode({ code, codeVerifier }), refresh(), revoke(), exportTokens(), importTokens(data).

Объект, возвращаемый SPAAuth.getAuthorizationUrl() и NativeAppAuth.getAuthorizationUrl(). Содержит URL-адрес авторизации и проверочный ключ PKCE. Свойства url: string — полный URL-адрес авторизации, на который необходимо перенаправить пользователя. codeVerifier: string — проверочный ключ PKCE, который необходимо сохранить и затем передать в метод exchangeCode().

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.collections.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "creator,project",
3
    after: "<opaque_cursor>",
4
    page_size: 10,
5
    include_total_count: false,
6
});

Параметры

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.CollectionsIndexRequest

requestOptions: Collections.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.collections.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "creator,project",
3
});

Параметры

accountId: Frameio.Uuid —

collectionId: Frameio.Uuid —

request: Frameio.CollectionsShowRequest

requestOptions: Collections.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "owner",
3
});

Параметры

accountId: Frameio.Uuid —

commentId: Frameio.Uuid —

request: Frameio.CommentsShowRequest

requestOptions: Comments.RequestOptions

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

Лимиты запросов: 60 вызовов в течение 1 минуты для account_user.

1
await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Параметры

accountId: Frameio.Uuid —

commentId: Frameio.Uuid —

requestOptions: Comments.RequestOptions

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

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    timestamp_as_timecode: true,
3
    data: {
4
        annotation:
5
            '[{"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}]',
6
        completed: false,
7
        page: 4,
8
        text: "This is great!",
9
    },
10
});

Параметры

accountId: Frameio.Uuid —

commentId: Frameio.Uuid —

request: Frameio.UpdateCommentParams

requestOptions: Comments.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
const response = await client.comments.index(
2
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4
    {
5
        include: "owner",
6
        after: "<opaque_cursor>",
7
        page_size: 10,
8
        include_total_count: false,
9
    },
10
);
11
for await (const item of response) {
12
    console.log(item);
13
}
14
15
// Or you can manually iterate page-by-page
16
let page = await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
17
    include: "owner",
18
    after: "<opaque_cursor>",
19
    page_size: 10,
20
    include_total_count: false,
21
});
22
while (page.hasNextPage()) {
23
    page = page.getNextPage();
24
}

Параметры

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.CommentsIndexRequest

requestOptions: Comments.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    timestamp_as_timecode: true,
3
    data: {
4
        annotation:
5
            '[{"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}]',
6
        completed: false,
7
        page: 4,
8
        text: "This is great!",
9
        timestamp: "00:00:02:12",
10
    },
11
});

Параметры

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.CreateCommentParams

requestOptions: Comments.RequestOptions

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

Лимиты запросов: 60 вызовов в течение 1 минуты для account_user.

1
await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        file_size: 1024000,
4
        media_type: "image/png",
5
        name: "screenshot.png",
6
    },
7
});

Параметры

accountId: Frameio.FrameOrAdobeId —

commentId: Frameio.Uuid —

request: Frameio.CreateAttachmentParams

requestOptions: Comments.RequestOptions

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

Лимиты запросов: 60 вызовов в течение 1 минуты для account_user.

1
await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Параметры

accountId: Frameio.FrameOrAdobeId —

commentId: Frameio.Uuid —

attachmentId: Frameio.Uuid —

requestOptions: Comments.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.customActions.actionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "creator",
3
    after: "<opaque_cursor>",
4
    page_size: 10,
5
    include_total_count: false,
6
});

Параметры

accountId: Frameio.FrameOrAdobeId —

workspaceId: Frameio.Uuid —

request: Frameio.ActionsIndexRequest

requestOptions: CustomActions.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.customActions.actionsShow("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "creator",
3
});

Параметры

accountId: Frameio.FrameOrAdobeId —

actionId: Frameio.Uuid —

request: Frameio.ActionsShowRequest

requestOptions: CustomActions.RequestOptions

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

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.customActions.actionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        description: "customizing our workflow",
4
        event: "my.event",
5
        name: "First Custom Action",
6
        timeout: 7,
7
        url: "https://example.com/custom-action",
8
    },
9
});

Параметры

accountId: Frameio.FrameOrAdobeId —

workspaceId: Frameio.Uuid —

request: Frameio.ActionCreateParams

requestOptions: CustomActions.RequestOptions

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

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.customActions.actionsUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        active: true,
4
        description: "customizing our workflow",
5
        event: "my.event",
6
        multi_asset: true,
7
        name: "First Custom Action",
8
        timeout: 7,
9
        url: "https://example.com/custom-action",
10
    },
11
});

Параметры

accountId: Frameio.FrameOrAdobeId —

actionId: Frameio.Uuid —

request: Frameio.ActionUpdateParams

requestOptions: CustomActions.RequestOptions

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

Лимиты запросов: 60 вызовов в течение 1 минуты для account_user.

1
await client.customActions.actionsDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Параметры

accountId: Frameio.FrameOrAdobeId —

actionId: Frameio.Uuid —

requestOptions: CustomActions.RequestOptions

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

Лимиты запросов: 5 вызовов в течение 1 секунды для account_user.

1
await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "media_links",
3
    after: "<opaque_cursor>",
4
    page_size: 10,
5
    include_total_count: false,
6
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FilesListRequest

requestOptions: Files.RequestOptions

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

Лимиты запросов: 5 вызовов в течение 1 секунды для account_user.

1
await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        file_size: 1137444,
4
        media_type: "image/png",
5
        name: "asset.png",
6
    },
7
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FileCreateParams

requestOptions: Files.RequestOptions

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

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

Лимиты запросов: 5 вызовов в течение 1 секунды для account_user.

1
await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "media_links",
3
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FilesShowRequest

requestOptions: Files.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Параметры

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

requestOptions: Files.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        name: "asset.png",
4
    },
5
});

Параметры

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.FileUpdateParams

requestOptions: Files.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    copy_metadata: true,
3
    copy_comments: "none",
4
    data: {
5
        parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
6
    },
7
});

Параметры

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.FileCopyParams

requestOptions: Files.RequestOptions

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

Лимиты запросов: 5 вызовов в течение 1 секунды для account_user.

1
await client.files.createRemoteUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        name: "asset.png",
4
        source_url: "https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png",
5
    },
6
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FileCreateRemoteUploadParams

requestOptions: Files.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
4
    },
5
});

Параметры

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.FileMoveParams

requestOptions: Files.RequestOptions

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

Лимиты запросов: 5 вызовов в течение 1 секунды для account_user.

1
await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        file_size: 1137444,
4
        name: "asset.png",
5
    },
6
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FileCreateLocalUploadParams

requestOptions: Files.RequestOptions

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

Лимиты запросов: 5 вызовов в течение 1 секунды для account_user.

1
await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Параметры

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

requestOptions: Files.RequestOptions

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

Лимиты запросов: 5 вызовов в течение 1 секунды для account_user.

1
await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
4
        name: "asset.png",
5
        storage_location: "123e4567-e89b-12d3-a456-426614174000",
6
    },
7
});

Параметры

accountId: Frameio.FrameOrAdobeId —

folderId: Frameio.FrameOrAdobeId —

request: Frameio.FileImportParams

requestOptions: Files.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.folderPermissions.folderUserRolesIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include_deactivated: true,
3
    after: "<opaque_cursor>",
4
    page_size: 10,
5
    include_total_count: false,
6
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderUserRolesIndexRequest

requestOptions: FolderPermissions.RequestOptions

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

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.folderPermissions.folderUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        role: "editor",
4
    },
5
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

userId: Frameio.Uuid —

request: Frameio.UpdateUserRolesParams

requestOptions: FolderPermissions.RequestOptions

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

Лимиты запросов: 60 вызовов в течение 1 минуты для account_user.

1
await client.folderPermissions.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

userId: Frameio.Uuid —

requestOptions: FolderPermissions.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "creator",
3
});

Параметры

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.FoldersShowRequest

requestOptions: Folders.RequestOptions

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

Лимиты запросов: 60 вызовов в течение 1 минуты для account_user.

1
await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

requestOptions: Folders.RequestOptions

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

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        name: "Folder name",
4
    },
5
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderUpdateParams

requestOptions: Folders.RequestOptions

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

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "media_links",
3
    type: "file,folder,version_stack",
4
    after: "<opaque_cursor>",
5
    page_size: 10,
6
    include_total_count: false,
7
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderIndexRequest

requestOptions: Folders.RequestOptions

Копирует папку.

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    copy_metadata: true,
3
    data: {
4
        parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
5
    },
6
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderCopyParams

requestOptions: Folders.RequestOptions

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

Лимиты запросов: 5 вызовов в течение 1 секунды для account_user.

1
await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "creator",
3
    after: "<opaque_cursor>",
4
    page_size: 10,
5
    include_total_count: false,
6
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FoldersListRequest

requestOptions: Folders.RequestOptions

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

Лимиты запросов: 3 вызова в течение 1 секунды для account_user.

1
await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        name: "Folder name",
4
    },
5
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderCreateParams

requestOptions: Folders.RequestOptions

Перемещает папку в другую папку.

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
4
    },
5
});

Параметры

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderMoveParams

requestOptions: Folders.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.groups.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "creator",
3
    sort: "creator_asc",
4
    after: "<opaque_cursor>",
5
    page_size: 10,
6
    include_total_count: false,
7
});

Параметры

accountId: Frameio.FrameOrAdobeId —

request: Frameio.GroupsIndexRequest

requestOptions: Groups.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.groups.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "creator",
3
});

Параметры

accountId: Frameio.FrameOrAdobeId —

groupId: Frameio.Uuid —

request: Frameio.GroupsShowRequest

requestOptions: Groups.RequestOptions

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

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.groups.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        emoji: "smile",
4
        name: "group-1",
5
    },
6
});

Параметры

accountId: Frameio.FrameOrAdobeId —

request: Frameio.CreateGroupParams

requestOptions: Groups.RequestOptions

Обновляет сведения о группе.

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.groups.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        emoji: "smile",
4
        name: "group-1",
5
    },
6
});

Параметры

accountId: Frameio.FrameOrAdobeId —

groupId: Frameio.Uuid —

request: Frameio.UpdateGroupParams

requestOptions: Groups.RequestOptions

Обновляет значения метаданных сразу в нескольких файлах.

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        file_ids: ["09b31c2a-04de-464a-a593-643a36ef0d98", "b967fc36-4e18-4b48-a3ab-c790100e2baa"],
4
        values: [
5
            {
6
                field_definition_id: "ff41ce50-269b-4624-8306-aac10e28ab94",
7
                value: [
8
                    {
9
                        id: "e60f47b4-cf8e-4273-96d5-3258a830a0aa",
10
                        type: "user",
11
                    },
12
                    {
13
                        id: "24eeaf7e-ce27-4555-bc77-cce39900626d",
14
                        type: "account_user_group",
15
                    },
16
                ],
17
            },
18
        ],
19
    },
20
});

Параметры

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.BulkUpdateMetadataParams

requestOptions: Metadata.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.metadata.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    show_null: true,
3
});

Параметры

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.MetadataShowRequest

requestOptions: Metadata.RequestOptions

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

Лимиты запросов: 60 вызовов в течение 1 минуты для account_user.

1
await client.metadataFields.metadataFieldDefinitionsDelete(
2
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4
);

Параметры

accountId: Frameio.Uuid —

fieldDefinitionId: Frameio.Uuid —

requestOptions: MetadataFields.RequestOptions

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

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.metadataFields.metadataFieldDefinitionsUpdate(
2
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4
    {
5
        data: {
6
            field_type: "select",
7
            field_configuration: {
8
                enable_add_new: false,
9
                options: [
10
                    {
11
                        display_name: "Option 1",
12
                    },
13
                    {
14
                        display_name: "Option 2",
15
                    },
16
                ],
17
            },
18
            name: "Updated-Field-Name",
19
        },
20
    },
21
);

Параметры

accountId: Frameio.Uuid —

fieldDefinitionId: Frameio.Uuid —

request: Frameio.UpdateFieldDefinitionParams

requestOptions: MetadataFields.RequestOptions

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

Лимиты запросов: 100 вызовов в течение 1 минуты для account_user.

1
await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    include: "creator",
3
    after: "<opaque_cursor>",
4
    page_size: 10,
5
    include_total_count: false,
6
});

Параметры

accountId: Frameio.Uuid —

request: Frameio.MetadataFieldDefinitionsIndexRequest

requestOptions: MetadataFields.RequestOptions

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

Лимиты запросов: 10 вызовов в течение 1 минуты для account_user.

1
await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2
    data: {
3
        field_type: "select",
4
        field_configuration: {
5
            enable_add_new: false,
6
            options: [
7
                {
8
                    display_name: "Option 1",
9
                },
10
                {
11
                    display_name: "Option 2",
12
                },
13
            ],
14
        },
15
        name: "Fields definition name",
16
    },
17
});