SDK 참조

TypeScript SDK 참조

설치

$npm i -s frameio

사용량

다음을 사용하여 클라이언트를 인스턴스화하고 사용합니다.

1import { FrameioClient } from "frameio";
2
3const client = new FrameioClient({ token: "YOUR_TOKEN" });
4await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
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: "Fields definition name",
19    },
20});

요청 및 응답 유형

SDK는 모든 요청 및 응답 유형을 TypeScript 인터페이스로 내보냅니다. 다음 네임스페이스를 사용하여 가져오기만 하면 됩니다.

1import { Frameio } from "frameio";
2
3const request: Frameio.UpdateFieldDefinitionParams = {
4    ...
5};

예외 처리

API가 실패 상태 코드(4xx 또는 5xx 응답)를 반환하면 다음 오류의 하위 클래스가 발생합니다.

1import { FrameioError } from "frameio";
2
3try {
4    await client.metadataFields.metadataFieldDefinitionsCreate(...);
5} catch (err) {
6    if (err instanceof FrameioError) {
7        console.log(err.statusCode);
8        console.log(err.message);
9        console.log(err.body);
10        console.log(err.rawResponse);
11    }
12}

고급

추가 헤더

요청의 일부로 추가 헤더를 전송하려면 headers 요청 옵션을 사용하세요.

1const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2    headers: {
3        'X-Custom-Header': 'custom value'
4    }
5});

추가 쿼리 문자열 매개변수

요청의 일부로 추가 쿼리 문자열 매개변수를 전송하려면 queryParams 요청 옵션을 사용하세요.

1const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2    queryParams: {
3        'customQueryParamKey': 'custom query param value'
4    }
5});

재시도

SDK에는 지수 백오프 방식의 자동 재시도 기능이 구현되어 있습니다. 요청이 재시도 가능한 것으로 간주되고, 재시도 횟수가 구성된 재시도 제한(기본값: 2)을 초과하지 않는 한 요청이 재시도됩니다.

다음 HTTP 상태 코드 중 하나가 반환될 때 요청은 재시도 가능한 것으로 간주됩니다.

  • 408(시간 초과)
  • 429(너무 많은 요청)
  • 5XX(내부 서버 오류)


이 동작을 구성하려면 maxRetries 요청 옵션을 사용하세요.

1const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2    maxRetries: 0 // override maxRetries at the request level
3});

시간 초과

SDK는 기본적으로 60초의 시간 초과 값을 사용합니다. 이 동작을 구성하려면 timeoutInSeconds 옵션을 사용하세요.

1const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2    timeoutInSeconds: 30 // override timeout to 30s
3});

요청 중단

SDK를 사용하면 중단 신호를 전달하여 언제든지 요청을 중단할 수 있습니다.

1const controller = new AbortController();
2const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
3    abortSignal: controller.signal
4});
5controller.abort(); // aborts the request

원시 응답 데이터에 액세스하기

SDK는 .withRawResponse() 메서드를 통해 헤더를 포함한 원시 응답 데이터에 대한 액세스를 제공합니다. .withRawResponse() 메서드는 data 및 rawResponse 속성을 가진 오브젝트를 결과로 제공하는 프로미스를 반환합니다.

1const { data, rawResponse } = await client.metadataFields.metadataFieldDefinitionsCreate(...).withRawResponse();
2
3console.log(data);
4console.log(rawResponse.headers['X-My-Header']);

런타임 호환성

SDK는 다음 런타임에서 작동합니다.

  • Node.js 18+
  • Vercel
  • Cloudflare Workers
  • Deno v1.25+
  • Bun 1.0+
  • React Native

가져오기 클라이언트 사용자 지정

SDK는 기본 HTTP 클라이언트 및 Fetch 기능을 사용자 지정할 수 있는 방법을 제공합니다. 지원되지 않는 환경에서 실행 중인 경우, 이를 통해 제약을 극복하고 SDK가 정상적으로 작동하도록 보장할 수 있습니다.

1import { FrameioClient } from "frameio";
2
3const client = new FrameioClient({
4    ...
5    fetcher: // provide your implementation here
6});

참조

계정 권한

지정된 계정의 사용자 역할을 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1const 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});
7for await (const item of response) {
8    console.log(item);
9}
10
11// Or you can manually iterate page-by-page
12let 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});
18while (page.hasNextPage()) {
19    page = page.getNextPage();
20}

매개변수

accountId: Frameio.Uuid —

request: Frameio.AccountPermissionsIndexRequest

requestOptions: AccountPermissions.RequestOptions

계정

현재 사용자의 계정을 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

request: Frameio.AccountsIndexRequest

requestOptions: Accounts.RequestOptions

쿼리 매개변수를 통해 필터링 기능을 사용하여 감사 로그를 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

인증

OAuth 2.0의 client_credentials 권한 부여를 사용하여 인증합니다. 이 흐름에는 사용자가 관여하지 않으며 새로 고침 토큰도 반환되지 않습니다. 액세스 토큰이 만료되면 SDK가 클라이언트 자격 증명을 사용하여 새 토큰을 자동으로 요청합니다.

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

매개변수

clientId: string — Adobe IMS OAuth client ID.

clientSecret: string — Adobe IMS OAuth 클라이언트 시크릿입니다.

scopes: string — 공백으로 구분된 권한 목록입니다(OAuth 2.0 RFC 6749). 기본적으로 서버 간 범위가 사용됩니다.

imsBaseUrl: string — 스테이징 및 대안 환경을 위한 IMS 기본 URL입니다. 기본값은 프로덕션입니다.

fetch: typeof fetch — 사용자 지정 가져오기 구현(프록시, TLS 등)입니다.

onTokenRefreshed: OnTokenRefreshed — 모든 토큰 가져오기 후 실행되는 선택적 콜백입니다.

timeout: number — HTTP 요청 시간 초과(밀리초 단위)입니다. 기본값은 30000입니다.

maxRetries: number — 일시적인 오류 발생 시 최대 재시도 횟수입니다. 기본값은 2입니다.

refreshBuffer: number — 사전 새로 고침을 트리거하기 위한 만료 전 초 단위 시간입니다. 기본값은 60입니다.

logger: Logger — 진단 출력용 로거 인스턴스입니다. Methods getToken(): Promise<string> — 필요한 경우 새로 고침을 수행하며 유효한 액세스 토큰을 반환합니다. 클라이언트에 전달하세요. new FrameioClient({ token: () => auth.getToken() }). authenticate(): Promise<TokenResponse> — 새 액세스 토큰을 명시적으로 가져옵니다. revoke(): Promise<void> — 서버 측에서 두 토큰 모두를 취소하고 로컬 상태를 지웁니다. exportTokens(): ExportedTokens — 지속성을 위해 현재 토큰 상태를 내보냅니다. importTokens(data: ExportedTokens): void — 이전에 내보낸 오브젝트에서 토큰 상태를 복원합니다.

OAuth 2.0 authorization_code 권한 부여를 사용하여 인증합니다. 클라이언트 시크릿을 안전하게 저장할 수 있는 서버 측 애플리케이션에 이 방식을 사용하세요.

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

매개변수

clientId: string — Adobe IMS OAuth client ID.

clientSecret: string — Adobe IMS OAuth 클라이언트 시크릿입니다.

redirectUri: string — 등록된 리디렉션 URI입니다.

scopes: string — 공백으로 구분된 권한 목록입니다(OAuth 2.0 RFC 6749).

imsBaseUrl: string — 스테이징 및 대안 환경을 위한 IMS 기본 URL입니다. 기본값은 프로덕션입니다.

fetch: typeof fetch — 사용자 지정 가져오기 구현(프록시, TLS 등)입니다.

onTokenRefreshed: OnTokenRefreshed — 모든 토큰 새로 고침 후 실행되는 선택적 콜백입니다.

timeout: number — HTTP 요청 시간 초과(밀리초 단위)입니다. 기본값은 30000입니다.

maxRetries: number — 일시적인 오류 발생 시 최대 재시도 횟수입니다. 기본값은 2입니다.

refreshBuffer: number — 사전 새로 고침을 트리거하기 위한 만료 전 초 단위 시간입니다. 기본값은 60입니다.

logger: Logger — 진단 출력용 로거 인스턴스입니다. Methods getToken(): Promise<string> — 필요한 경우 새로 고침을 수행하며 유효한 액세스 토큰을 반환합니다. getAuthorizationUrl({ state }): string — Adobe IMS 인증 URL을 빌드합니다. 반환될 불투명한 CSRF/상태 값을 전달합니다. exchangeCode(code: string): Promise<TokenResponse> — 토큰을 액세스하고 새로 고치기 위해 인증 코드를 교환합니다. refresh(): Promise<TokenResponse> — 토큰 새로 고침을 수동으로 트리거합니다. revoke(): Promise<void> — 서버 측에서 두 토큰 모두를 취소하고 로컬 상태를 지웁니다. exportTokens(): ExportedTokens — 지속성을 위해 현재 토큰 상태를 내보냅니다. importTokens(data: ExportedTokens): void — 이전에 내보낸 오브젝트에서 토큰 상태를 복원합니다.

authorization_code + PKCE(클라이언트 시크릿 없음)를 사용하여 인증합니다. 클라이언트 시크릿을 안전하게 저장할 수 없는 브라우저 기반 단일 페이지에 이 방식을 사용하세요.

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

매개변수

clientId: string — Adobe IMS OAuth client ID.

redirectUri: string — 등록된 리디렉션 URI입니다.

scopes: string — 공백으로 구분된 권한 목록입니다(OAuth 2.0 RFC 6749).

imsBaseUrl: string — 스테이징 및 대안 환경을 위한 IMS 기본 URL입니다. 기본값은 프로덕션입니다.

fetch: typeof fetch — 사용자 지정 가져오기 구현(프록시, TLS 등)입니다.

onTokenRefreshed: OnTokenRefreshed — 모든 토큰 새로 고침 후 실행되는 선택적 콜백입니다.

timeout: number — HTTP 요청 시간 초과(밀리초 단위)입니다. 기본값은 30000입니다.

maxRetries: number — 일시적인 오류 발생 시 최대 재시도 횟수입니다. 기본값은 2입니다.

refreshBuffer: number — 사전 새로 고침을 트리거하기 위한 만료 전 초 단위 시간입니다. 기본값은 60입니다.

logger: Logger — 진단 출력용 로거 인스턴스입니다. Methods getToken(): Promise<string> — 필요한 경우 새로 고침을 수행하며 유효한 액세스 토큰을 반환합니다. getAuthorizationUrl({ state }): Promise<AuthorizationUrlResult> — PKCE 챌린지를 사용하여 Adobe IMS 인증 URL을 구축합니다. url 및 codeVerifier 속성을 포함하는 AuthorizationUrlResult를 반환합니다. exchangeCode({ code, codeVerifier }): Promise<TokenResponse> — 인증 코드 + PKCE 검증자를 토큰으로 교환합니다. refresh(): Promise<TokenResponse> — 토큰 새로 고침을 수동으로 트리거합니다. revoke(): Promise<void> — 서버 측에서 두 토큰 모두를 취소하고 로컬 상태를 지웁니다. exportTokens(): ExportedTokens — 지속성을 위해 현재 토큰 상태를 내보냅니다. importTokens(data: ExportedTokens): void — 이전에 내보낸 오브젝트에서 토큰 상태를 복원합니다.

데스크탑 및 모바일 애플리케이션용 authorization_code + PKCE를 사용하여 인증합니다. SPAAuth와 동일한 API를 공유합니다. custom-scheme 리디렉션 URI(예: myapp://callback)를 사용합니다.

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

매개변수

clientId: string — Adobe IMS OAuth client ID.

redirectUri: string — 등록된 리디렉션 URI입니다(사용자 지정 스키마 지원).

scopes: string — 공백으로 구분된 권한 목록입니다(OAuth 2.0 RFC 6749).

imsBaseUrl: string — 스테이징 및 대안 환경을 위한 IMS 기본 URL입니다. 기본값은 프로덕션입니다.

fetch: typeof fetch — 사용자 지정 가져오기 구현(프록시, TLS 등)입니다.

onTokenRefreshed: OnTokenRefreshed — 모든 토큰 새로 고침 후 실행되는 선택적 콜백입니다.

timeout: number — HTTP 요청 시간 초과(밀리초 단위)입니다. 기본값은 30000입니다.

maxRetries: number — 일시적인 오류 발생 시 최대 재시도 횟수입니다. 기본값은 2입니다.

refreshBuffer: number — 사전 새로 고침을 트리거하기 위한 만료 전 초 단위 시간입니다. 기본값은 60입니다.

logger: Logger — 진단 출력용 로거 인스턴스입니다. Methods SPAAuth와 동일: getToken(), getAuthorizationUrl({ state }), exchangeCode({ code, codeVerifier }), refresh(), revoke(), exportTokens(), importTokens(data).

SPAAuth.getAuthorizationUrl() 및 NativeAppAuth.getAuthorizationUrl()에서 반환되는 오브젝트입니다. 인증 URL 및 PKCE 코드 검증자를 보관합니다.

속성

url: string — 사용자를 리디렉션할 전체 인증 URL입니다.

codeVerifier: string — 저장해 두었다가 exchangeCode()에 전달할 PKCE 코드 검증자입니다.

인증 예외

모든 인증 오류는 FrameioAuthError를 확장하며 frameio에서 가져올 수 있습니다.

예외설명
FrameioAuthError모든 auth-SDK 오류의 기본 오류입니다.
AuthenticationError토큰 교환 또는 새로 고침에 실패했습니다. errorCode 및 errorDescription 속성이 있습니다.
TokenExpiredError새로 고침 토큰이 만료되었습니다. 재인증이 필요합니다.
NetworkError네트워크 요청에 실패했습니다(시간 초과, 연결 오류 등).
RateLimitErrorAdobe IMS가 429를 반환했으며 재시도 횟수가 소진되었습니다. retryAfter 속성이 있습니다.
PKCEErrorPKCE 확인에 실패했습니다.
ConfigurationError필수 구성이 누락되었거나 유효하지 않습니다.

컬렉션

프로젝트의 컬렉션 나열.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

컬렉션 세부 정보 표시.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

코멘트

파일의 단일 코멘트를 표시합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

에셋에서 코멘트를 삭제합니다.

요청 제한: account_user당 1.00분당 60회 호출

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

매개변수

accountId: Frameio.Uuid —

commentId: Frameio.Uuid —

requestOptions: Comments.RequestOptions

지정된 에셋에 대한 코멘트를 업데이트합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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

지정된 에셋에 대한 코멘트를 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1const 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);
11for await (const item of response) {
12    console.log(item);
13}
14
15// Or you can manually iterate page-by-page
16let 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});
22while (page.hasNextPage()) {
23    page = page.getNextPage();
24}

매개변수

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.CommentsIndexRequest

requestOptions: Comments.RequestOptions

파일에 코멘트를 생성합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

기존 코멘트의 첨부 파일 생성.

요청 제한: account_user당 1.00분당 60회 호출

usage
1await 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

코멘트에서 첨부 파일 삭제.

요청 제한: account_user당 1.00분당 60회 호출

usage
1await 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

사용자 지정 작업

지정된 작업 영역의 작업 나열.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

사용자 지정 작업의 세부 정보를 표시합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

작업 영역에 사용자 지정 작업을 생성합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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

사용자 지정 작업의 세부 정보를 업데이트합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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

사용자 지정 작업을 삭제합니다.

요청 제한: account_user당 1.00분당 60회 호출

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

매개변수

accountId: Frameio.FrameOrAdobeId —

actionId: Frameio.Uuid —

requestOptions: CustomActions.RequestOptions

파일

지정된 폴더에 있는 파일을 나열합니다.

속도 제한: account_user당 1초당 5회 호출

usage
1await 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

상위 폴더 아래에 새 파일을 만듭니다. 파일 생성(로컬 업로드)과 파일 생성(원격 업로드)이 이 엔드포인트를 대체했습니다.

속도 제한: account_user당 1초당 5회 호출

usage
1await 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 쿼리 매개변수를 사용하세요.

media_links.original을 포함했는데 사용자에게 파일을 다운로드할 권한이 없는 경우, 이 엔드포인트는 403 Forbidden 오류로 응답합니다. 이 사용자에 대해 워터마크가 요구되지만 요청된 media_links에서 이를 지원하지 않아 콘텐츠에 액세스할 수 없는 경우, 요청은 성공하지만 지원되지 않는 미디어 링크는 null로 설정됩니다. 마찬가지로 특정 파일에 대해 요청된 트랜스코드 링크가 존재하지 않거나(예: 정적 이미지 파일에 media_links.video_h264_180 포함) 트랜스코딩 프로세스가 완료되지 않은 경우(즉, 파일의 상태가 “transcoded”가 아닌 “uploaded”인 경우), 응답 페이로드의 링크 역시 null로 설정됩니다. 즉, 클라이언트는 null로 처리된 미디어 링크를 원활하게 처리할 수 있어야 합니다.

속도 제한: account_user당 1초당 5회 호출

usage
1await 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

ID로 파일을 삭제합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

requestOptions: Files.RequestOptions

파일 세부 정보를 업데이트합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

파일을 복사합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

원격 업로드를 통해 상위 폴더 아래에 새 파일을 생성합니다.

속도 제한: account_user당 1초당 5회 호출

usage
1await 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

파일을 폴더 또는 version_stack으로 이동합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

로컬 업로드를 통해 상위 폴더 아래에 새 파일을 생성합니다.

속도 제한: account_user당 1초당 5회 호출

usage
1await 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

파일 업로드 상태 세부 정보를 표시합니다.

속도 제한: account_user당 1초당 5회 호출

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

매개변수

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

requestOptions: Files.RequestOptions

계정에 구성된 저장 위치에서 파일을 가져옵니다.

속도 제한: account_user당 1초당 5회 호출

usage
1await 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

폴더 권한

지정된 폴더의 사용자 역할을 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

사용자가 이미 폴더에 추가된 경우 지정된 폴더의 사용자 역할을 업데이트합니다. 사용자가 폴더에 추가되지 않은 경우 해당 사용자는 지정된 역할로 추가됩니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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

지정된 폴더에서 사용자를 제거합니다.

요청 제한: account_user당 1.00분당 60회 호출

usage
1await 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

폴더

폴더 세부 정보를 표시합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

ID로 폴더를 삭제합니다.

요청 제한: account_user당 1.00분당 60회 호출

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

매개변수

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

requestOptions: Folders.RequestOptions

폴더 세부 정보를 업데이트합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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 쿼리 매개변수를 사용하세요.

media_links.original을 포함했는데 사용자에게 해당 프로젝트에서 파일을 다운로드할 권한이 없는 경우, 이 엔드포인트는 403 Forbidden 오류로 응답합니다. 이 사용자에 대해 워터마크가 요구되지만 요청된 media_links에서 이를 지원하지 않아 콘텐츠에 액세스할 수 없는 경우, 요청은 성공하지만 지원되지 않는 미디어 링크는 null로 설정됩니다. 마찬가지로 특정 파일에 대해 요청된 트랜스코드 링크가 존재하지 않거나(예: 정적 이미지 파일에 media_links.video_h264_180 포함) 트랜스코딩 프로세스가 완료되지 않은 경우(즉, 파일의 상태가 “transcoded”가 아닌 “uploaded”인 경우), 응답 페이로드의 미디어 링크 역시 null로 설정됩니다. 즉, 클라이언트는 null로 처리된 미디어 링크를 원활하게 처리할 수 있어야 합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

폴더를 복사합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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

지정된 폴더의 하위 폴더들을 나열합니다.

속도 제한: account_user당 1초당 5회 호출

usage
1await 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 경로 매개변수 내에 새 폴더를 만듭니다.

속도 제한: account_user당 1초당 3회 호출

usage
1await 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

폴더를 다른 폴더로 이동합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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

그룹

계정의 그룹을 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

그룹 세부 정보 표시.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

현재 계정의 그룹을 생성합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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

그룹 세부 정보를 업데이트합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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

메타데이터

여러 파일에 걸쳐 메타데이터 값을 업데이트합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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

파일의 메타데이터를 표시합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

메타데이터 필드

계정 수준의 사용자 지정 필드 정의를 삭제합니다.

요청 제한: account_user당 1.00분당 60회 호출

usage
1await 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

계정 수준의 사용자 지정 필드 정의를 업데이트합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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

계정 수준의 필드 정의를 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await 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

계정 수준의 필드 정의를 생성합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await 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});

매개변수

accountId: Frameio.Uuid —

request: Frameio.CreateFieldDefinitionParams

requestOptions: MetadataFields.RequestOptions

프로젝트 권한

지정된 프로젝트에 대한 사용자 역할을 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.ProjectPermissionsIndexRequest

requestOptions: ProjectPermissions.RequestOptions

지정된 프로젝트에서 사용자를 제거합니다.

요청 제한: account_user당 1.00분당 60회 호출

usage
1await client.projectPermissions.delete(
2    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5);

매개변수

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

userId: Frameio.Uuid —

requestOptions: ProjectPermissions.RequestOptions

사용자가 이미 프로젝트에 추가된 경우 지정된 프로젝트에 대한 사용자 역할을 업데이트합니다. 사용자가 프로젝트에 추가되지 않은 경우 해당 사용자는 지정된 역할로 추가됩니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.projectPermissions.projectUserRolesUpdate(
2    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5    {
6        data: {
7            role: "editor",
8        },
9    },
10);

매개변수

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

UserId: Frameio.Uuid —

request: Frameio.UpdateUserRolesParams

requestOptions: ProjectPermissions.RequestOptions

프로젝트

프로젝트 세부 정보를 표시합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.ProjectsShowRequest

requestOptions: Projects.RequestOptions

프로젝트를 삭제합니다.

요청 제한: account_user당 1.00분당 60회 호출

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

매개변수

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

requestOptions: Projects.RequestOptions

프로젝트 세부 정보를 업데이트합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        name: "Project Name",
4        restricted: true,
5        status: "active",
6    },
7});

매개변수

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.ProjectUpdateParams

requestOptions: Projects.RequestOptions

지정된 작업 영역의 프로젝트를 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1const response = await client.projects.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);
11for await (const item of response) {
12    console.log(item);
13}
14
15// Or you can manually iterate page-by-page
16let page = await client.projects.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});
22while (page.hasNextPage()) {
23    page = page.getNextPage();
24}

매개변수

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.ProjectsIndexRequest

requestOptions: Projects.RequestOptions

지정된 작업 영역에 프로젝트를 생성합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.projects.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        name: "Project Name",
4        restricted: true,
5    },
6});

매개변수

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.ProjectsParams

requestOptions: Projects.RequestOptions

인증된 사용자가 지정된 계정 내에서 액세스할 수 있는 모든 프로젝트 나열.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await client.projects.accountProjectsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    include: "owner",
3    sort: "name_asc",
4    after: "<opaque_cursor>",
5    page_size: 10,
6    include_total_count: false,
7});

매개변수

accountId: Frameio.FrameOrAdobeId —

request: Frameio.AccountProjectsIndexRequest

requestOptions: Projects.RequestOptions

지정된 계정 내에서 현재 사용자가 초대되었지만 작업 영역 레벨 액세스 권한은 없는 프로젝트를 나열합니다. 사용자가 팀/작업 영역 권한 없이 프로젝트별 공동 작업자 액세스 권한을 갖는 프로젝트입니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await client.projects.invitedProjectsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    include: "owner",
3    sort: "name_asc",
4    after: "<opaque_cursor>",
5    page_size: 10,
6    include_total_count: false,
7});

매개변수

accountId: Frameio.FrameOrAdobeId —

request: Frameio.InvitedProjectsIndexRequest

requestOptions: Projects.RequestOptions

검색

계정 내의 에셋, 폴더, 프로젝트를 검색합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await client.search.search("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    engine: "nlp",
3    query: "red car driving on highway",
4    filters: {
5        files_and_version_stacks: true,
6        folders: false,
7        projects: false,
8    },
9    after: "<opaque_cursor>",
10    page_size: 10,
11    include_total_count: false,
12});

매개변수

accountId: Frameio.Uuid —

request: Frameio.SearchParams

requestOptions: Search.RequestOptions

공유

단일 공유를 표시합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await client.shares.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

매개변수

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

requestOptions: Shares.RequestOptions

공유를 삭제합니다.

요청 제한: account_user당 1.00분당 60회 호출

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

매개변수

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

requestOptions: Shares.RequestOptions

공유를 업데이트합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.shares.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        access: "public",
4        description: "A descriptive summary of the share",
5        downloading_enabled: true,
6        expiration: "2026-01-22T17:04:53Z",
7        name: "Share Name",
8        passphrase: "as!dfj39sd(*",
9    },
10});

매개변수

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.UpdateShareParams

requestOptions: Shares.RequestOptions

공유 검토자를 나열합니다.

요청 제한: account_user당 1.00분당 10회 호출

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

매개변수

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.SharesListReviewersRequestreParams

requestOptions: Shares.RequestOptions

다음 세 가지 식별자 유형을 사용하여 보안 공유에 검토자를 추가합니다. adobe_user_id, email, user_id.

요청에는 식별자 유형 매개변수가 하나만 포함될 수 있습니다.

email은 공유가 속한 계정에 Frame 계정 멤버가 없는 경우에도 해당 공유에 검토자를 추가할 수 있는 유일한 식별자입니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.shares.addReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        message: "Please join my share!",
4        reviewers: {
5            emails: ["email1@domain.com", "email2@domain.com"],
6        },
7    },
8});

매개변수

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.AddReviewersToShareParams

requestOptions: Shares.RequestOptions

다음 세 가지 식별자 유형을 사용하여 보안 공유에서 검토자를 제거합니다. adobe_user_id, email, user_id.

요청에는 식별자 유형 매개변수가 하나만 포함될 수 있습니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.shares.removeReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        reviewers: {
4            adobe_user_ids: ["2A3C1A3D66C621B20A494021@176719f5667c82b4499999.e"],
5        },
6    },
7});

매개변수

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.RemoveReviewerParams

requestOptions: Shares.RequestOptions

현재 공유 내에 있는 에셋을 해당 공유에서 제거합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.shares.removeAsset(
2    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5);

매개변수

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

assetId: Frameio.Uuid —

requestOptions: Shares.RequestOptions

새로운 에셋을 공유에 추가합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        asset_id: "0cc1cb59-1d7c-4176-8532-afe099897318",
4    },
5});

매개변수

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.AddAssetParams

requestOptions: Shares.RequestOptions

프로젝트의 공유를 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.SharesIndexRequest

requestOptions: Shares.RequestOptions

공유를 생성합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.shares.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        type: "asset",
4        access: "public",
5        asset_ids: ["12eb1446-5736-4f93-85fc-3b636f156211", "f23a3b3e-7b1f-4655-b91a-acf0566e5bb9"],
6        downloading_enabled: true,
7        expiration: "2026-01-22T17:04:53Z",
8        name: "Share Name",
9        passphrase: "as!dfj39sd(*",
10    },
11});

매개변수

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.CreateShareParams

requestOptions: Shares.RequestOptions

사용자

베어러 토큰과 연결된 사용자의 세부 정보를 확인합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await client.users.show();

매개변수

requestOptions: Users.RequestOptions

버전 스택

지정된 버전 스택의 하위 항목(파일)들을 나열합니다.

응답에 추가 속성을 선택적으로 포함하려면 include 쿼리 매개변수를 사용하세요.

media_links.original을 포함했는데 사용자에게 해당 프로젝트에서 파일을 다운로드할 권한이 없는 경우, 이 엔드포인트는 403 Forbidden 오류로 응답합니다. 이 사용자에 대해 워터마크가 요구되지만 요청된 media_links에서 이를 지원하지 않아 콘텐츠에 액세스할 수 없는 경우, 요청은 성공하지만 지원되지 않는 미디어 링크는 null로 설정됩니다. 마찬가지로 특정 파일에 대해 요청된 트랜스코드 링크가 존재하지 않거나(예: 정적 이미지 파일에 media_links.video_h264_180 포함) 트랜스코딩 프로세스가 완료되지 않은 경우(즉, 파일의 상태가 “transcoded”가 아닌 “uploaded”인 경우), 응답 페이로드의 미디어 링크 역시 null로 설정됩니다. 즉, 클라이언트는 null로 처리된 미디어 링크를 원활하게 처리할 수 있어야 합니다.

요청 제한: account_user당 1.00분당 100회 호출

usage
1await client.versionStacks.index("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 —

projectId: Frameio.Uuid —

request: Frameio.VersionStacksIndexRequest

requestOptions: VersionStacks.RequestOptions

버전 스택의 세부 정보를 표시합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

accountId: Frameio.Uuid —

versionStackId: Frameio.Uuid —

request: Frameio.VersionStacksShowRequest

requestOptions: VersionStacks.RequestOptions

버전 스택을 복사합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.versionStacks.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 —

versionStackId: Frameio.Uuid —

request: Frameio.VersionStackCopyParams

requestOptions: VersionStacks.RequestOptions

지정된 폴더의 버전 스택을 나열합니다.

속도 제한: account_user당 1초당 5회 호출

usage
1await client.versionStacks.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.VersionStacksListRequest

requestOptions: VersionStacks.RequestOptions

상위 폴더 아래에 새 버전 스택을 생성합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        file_ids: ["dd2a3cdd-fc90-41bd-a7b8-8a0447aec6d4", "79fed48a-8372-496e-8dcb-5e959b9b9fcf"],
4    },
5});

매개변수

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.VersionStackCreateParams

requestOptions: VersionStacks.RequestOptions

버전 스택을 다른 폴더로 이동합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.versionStacks.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.VersionStackMoveParams

requestOptions: VersionStacks.RequestOptions

Webhook

지정된 작업 영역의 웹훅을 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WebhooksIndexRequest

requestOptions: Webhooks.RequestOptions

시크릿이 포함된 단일 웹훅을 생성합니다.

유효한 이벤트:

file.created, file.deleted, file.ready, file.updated, file.upload.completed, file.versioned, file.copied, folder.created, folder.deleted, folder.updated, folder.copied, comment.completed, comment.created, comment.deleted, comment.uncompleted, comment.updated, customfield.created, customfield.updated, customfield.deleted, metadata.value.updated, project.created, project.deleted, project.updated, collection.created, collection.updated, collection.deleted, share.created, share.updated, share.deleted, share.viewed

요청 제한: 계정당 1.00분당 10회 호출

usage
1await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        events: [
4            "file.created",
5            "file.deleted",
6            "file.ready",
7            "file.updated",
8            "file.upload.completed",
9            "file.versioned",
10            "file.copied",
11            "folder.created",
12            "folder.deleted",
13            "folder.updated",
14            "folder.copied",
15            "comment.completed",
16            "comment.created",
17            "comment.deleted",
18            "comment.uncompleted",
19            "comment.updated",
20            "customfield.created",
21            "customfield.updated",
22            "customfield.deleted",
23            "metadata.value.updated",
24            "project.created",
25            "project.deleted",
26            "project.updated",
27            "collection.created",
28            "collection.updated",
29            "collection.deleted",
30            "share.created",
31            "share.updated",
32            "share.deleted",
33            "share.viewed",
34        ],
35        name: "New Webhook",
36        url: "https://url.example.com",
37    },
38});

매개변수

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WebhookCreateParams

requestOptions: Webhooks.RequestOptions

웹훅 세부 정보를 표시합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

accountId: Frameio.Uuid —

webhookId: Frameio.Uuid —

request: Frameio.WebhooksShowRequest

requestOptions: Webhooks.RequestOptions

웹훅을 삭제합니다.

요청 제한: account_user당 1.00분당 60회 호출

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

매개변수

accountId: Frameio.Uuid —

webhookId: Frameio.Uuid —

requestOptions: Webhooks.RequestOptions

웹훅 세부 정보를 업데이트합니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2    data: {
3        active: true,
4        events: [
5            "file.created",
6            "file.deleted",
7            "file.ready",
8            "file.updated",
9            "file.upload.completed",
10            "file.versioned",
11            "file.copied",
12            "folder.created",
13            "folder.deleted",
14            "folder.updated",
15            "folder.copied",
16            "comment.completed",
17            "comment.created",
18            "comment.deleted",
19            "comment.uncompleted",
20            "comment.updated",
21            "customfield.created",
22            "customfield.updated",
23            "customfield.deleted",
24            "metadata.value.updated",
25            "project.created",
26            "project.deleted",
27            "project.updated",
28            "collection.created",
29            "collection.updated",
30            "collection.deleted",
31            "share.created",
32            "share.updated",
33            "share.deleted",
34            "share.viewed",
35        ],
36        name: "Updated Webhook",
37        url: "https://url.example.com",
38    },
39});

매개변수

accountId: Frameio.Uuid —

webhookId: Frameio.Uuid —

request: Frameio.WebhookUpdateParams

requestOptions: Webhooks.RequestOptions

작업 공간 권한

지정된 작업 영역의 사용자 역할을 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WorkspacePermissionsIndexRequest

requestOptions: WorkspacePermissions.RequestOptions

지정된 작업 영역에서 사용자를 제거합니다.

요청 제한: account_user당 1.00분당 60회 호출

usage
1await client.workspacePermissions.workspaceUserRolesDelete(
2    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5);

매개변수

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

userId: Frameio.Uuid —

requestOptions: WorkspacePermissions.RequestOptions

사용자가 이미 작업 영역에 추가된 경우 지정된 작업 영역에 대한 사용자 역할을 업데이트합니다. 사용자가 작업 영역에 추가되지 않은 경우 해당 사용자는 지정된 역할로 추가됩니다.

요청 제한: account_user당 1.00분당 10회 호출

usage
1await client.workspacePermissions.workspaceUserRolesUpdate(
2    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5    {
6        data: {
7            role: "editor",
8        },
9    },
10);

매개변수

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

userId: Frameio.Uuid —

request: Frameio.UpdateUserRolesParams

requestOptions: WorkspacePermissions.RequestOptions

Workspace

작업 영역 세부 정보를 표시합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WorkspacesShowRequest

requestOptions: Workspaces.RequestOptions

계정에서 작업 영역을 삭제합니다.

요청 제한: account_user당 1.00분당 60회 호출

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

매개변수

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

requestOptions: Workspaces.RequestOptions

작업 영역을 업데이트합니다.

요청 제한: account_user당 1.00분당 10회 호출

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

매개변수

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WorkspaceParams

requestOptions: Workspaces.RequestOptions

지정된 계정의 작업 영역을 나열합니다.

요청 제한: account_user당 1.00분당 100회 호출

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

매개변수

accountId: Frameio.Uuid —

request: Frameio.WorkspacesIndexRequest

requestOptions: Workspaces.RequestOptions

계정에서 작업 영역을 생성합니다.

요청 제한: account_user당 1.00분당 10회 호출

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

매개변수

accountId: Frameio.Uuid —

request: Frameio.WorkspaceParams

requestOptions: Workspaces.RequestOptions

npm

npm에서 보기

이 페이지가 도움이 되었나요?