Référence du SDK TypeScript | Frame.io API Documentation

Installation

npm i -s frameio

Utilisation

Instanciez et utilisez le client comme suit :

import { FrameioClient } from "frameio";
const client = new FrameioClient({ token: "YOUR_TOKEN" });
await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    data: {
        field_type: "select",
        field_configuration: {
            enable_add_new: false,
            options: [
                {
                    display_name: "Option 1",
                },
                {
                    display_name: "Option 2",
                },
            ],
        },
        name: "Fields definition name",
    },
});

Types de requêtes et de réponses

Le SDK exporte tous les types de requêtes et de réponses sous forme d’interfaces TypeScript. Il suffit de les importer avec l’espace de noms suivant :

import { Frameio } from "frameio";
const request: Frameio.UpdateFieldDefinitionParams = {
    ...
};

Gestion des exceptions

Lorsque l’API renvoie un code d’état indiquant un échec (réponse 4xx ou 5xx), une sous-classe de l’erreur suivante sera levée.

import { FrameioError } from "frameio";
try {
    await client.metadataFields.metadataFieldDefinitionsCreate(...);
} catch (err) {
    if (err instanceof FrameioError) {
        console.log(err.statusCode);
        console.log(err.message);
        console.log(err.body);
        console.log(err.rawResponse);
    }
}

Avancé

En-têtes supplémentaires

Si vous souhaitez envoyer des en-têtes supplémentaires dans le cadre de la requête, utilisez l’option de requête relative aux en-têtes.

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

Paramètres supplémentaires de la chaîne de requête

Si vous souhaitez envoyer des paramètres de chaîne de requête supplémentaires dans le cadre de la requête, utilisez l’option de requête « queryParams ».

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

Tentatives

Le SDK est configuré pour effectuer des tentatives de reconnexion automatiques avec un délai d’attente exponentiel. Une requête sera retentée tant qu’elle est considérée comme pouvant faire l’objet d’une nouvelle tentative et que le nombre de tentatives n’a pas dépassé la limite configurée (par défaut : 2).

Une requête est considérée comme pouvant faire l’objet d’une nouvelle tentative lorsque l’un des codes d’état HTTP suivants est renvoyé :

408 (Délai d’attente de la requête)
429 (Trop de requêtes)
5XX (Erreur interne du serveur)

Utilisez l’option de requête maxRetries pour configurer ce comportement.

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

Délais d’expiration

Le SDK utilise par défaut un délai d’expiration de 60 secondes. Utilisez l’option timeoutInSeconds pour configurer ce comportement.

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

Annulation des requêtes

Le SDK permet aux utilisateurs d’interrompre des requêtes à tout moment en transmettant un signal d’interruption.

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

Accéder aux données brutes de réponse

Le SDK permet d’accéder aux données brutes de la réponse, y compris les en-têtes, via la méthode .withRawResponse(). La méthode .withRawResponse() renvoie une promesse qui aboutit à un objet comportant une propriété data et une propriété rawResponse.

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

Compatibilité d’exécution

Le SDK fonctionne dans les environnements d’exécution suivants :

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

Personnalisation de Récupérer / Client

Le SDK vous permet de personnaliser le client HTTP sous-jacent et la fonction Récupérer. Si vous utilisez un environnement non pris en charge, cela vous permet de recourir à une solution de secours pour vous assurer que le SDK fonctionne.

import { FrameioClient } from "frameio";
const client = new FrameioClient({
    ...
    fetcher: // provide your implementation here
});

Référence

Métadonnées

client.metadata.bulkUpdate(accountId, projectId, { ...params }) -> void

Mise à jour des valeurs des métadonnées sur plusieurs fichiers.

Limites de débit : 10 appels par minute et par account_user

usage

await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    data: {
        file_ids: ["09b31c2a-04de-464a-a593-643a36ef0d98", "b967fc36-4e18-4b48-a3ab-c790100e2baa"],
        values: [
            {
                field_definition_id: "ff41ce50-269b-4624-8306-aac10e28ab94",
                value: [
                    {
                        id: "e60f47b4-cf8e-4273-96d5-3258a830a0aa",
                        type: "user",
                    },
                    {
                        id: "24eeaf7e-ce27-4555-bc77-cce39900626d",
                        type: "account_user_group",
                    },
                ],
            },
        ],
    },
});

Paramètres

accountId : Frameio.Uuid

projectId : Frameio.Uuid

request : Frameio.BulkUpdateMetadataParams

requestOptions : Metadata.RequestOptions

client.metadata.show(accountId, fileId, { ...params }) -> Frameio.MetadataResponse

Afficher les métadonnées d’un fichier.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

fileId : Frameio.Uuid

request : Frameio.MetadataShowRequest

requestOptions : Metadata.RequestOptions

Champs de métadonnées

client.metadataFields.metadataFieldDefinitionsDelete(accountId, fieldDefinitionId) -> void

Supprimer les définitions des champs personnalisés au niveau du compte.

Limites de débit : 60 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

fieldDefinitionId : Frameio.Uuid

requestOptions : MetadataFields.RequestOptions

client.metadataFields.metadataFieldDefinitionsUpdate(accountId, fieldDefinitionId, { ...params }) -> Frameio.FieldDefinitionResponse

Mise à jour des définitions de champs personnalisés au niveau du compte.

Limites de débit : 10 appels par minute et par account_user

usage

await client.metadataFields.metadataFieldDefinitionsUpdate(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        data: {
            field_type: "select",
            field_configuration: {
                enable_add_new: false,
                options: [
                    {
                        display_name: "Option 1",
                    },
                    {
                        display_name: "Option 2",
                    },
                ],
            },
            name: "Updated-Field-Name",
        },
    },
);

Paramètres

accountId : Frameio.Uuid – fieldDefinitionId : Frameio.Uuid – request : Frameio.UpdateFieldDefinitionParams

requestOptions: MetadataFields.RequestOptions

client.metadataFields.metadataFieldDefinitionsIndex(accountId, { ...params }) -> Frameio.FieldDefinitionsWithIncludesResponse

Liste des définitions de champs au niveau du compte.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

request : Frameio.MetadataFieldDefinitionsIndexRequest

requestOptions : MetadataFields.RequestOptions

client.metadataFields.metadataFieldDefinitionsCreate(accountId, { ...params }) -> Frameio.FieldDefinitionResponse

Créer des définitions de champ au niveau du compte.

Limites de débit : 10 appels par minute et par account_user

usage

await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    data: {
        field_type: "select",
        field_configuration: {
            enable_add_new: false,
            options: [
                {
                    display_name: "Option 1",
                },
                {
                    display_name: "Option 2",
                },
            ],
        },
        name: "Fields definition name",
    },
});

Paramètres

accountId : Frameio.Uuid

request : Frameio.CreateFieldDefinitionParams

requestOptions : MetadataFields.RequestOptions

Autorisations sur le projet

client.projectPermissions.index(accountId, projectId, { ...params }) -> core.Page<Frameio.UserRole

Répertorier les rôles d’utilisateur pour un projet donné.

Limites de débit : 100 appels par minute et par account_user

usage

const response = await client.projectPermissions.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include_deactivated: true,
        after: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
for await (const item of response) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.projectPermissions.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include_deactivated: true,
        after: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Paramètres

accountId : Frameio.Uuid

projectId : Frameio.Uuid

request : Frameio.ProjectPermissionsIndexRequest

requestOptions : ProjectPermissions.RequestOptions

client.projectPermissions.delete(accountId, projectId, userId) -> void

Supprimer un utilisateur du projet spécifié.

Limites de débit : 60 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

projectId : Frameio.Uuid

userId : Frameio.Uuid

requestOptions : ProjectPermissions.RequestOptions

client.projectPermissions.projectUserRolesUpdate(accountId, projectId, userId, { ...params }) -> Frameio.UpdateUserRolesResponse

Mettre à jour les rôles des utilisateurs pour le projet spécifié si celui-ci a déjà été ajouté au projet. Si l’utilisateur n’est pas encore ajouté au projet, il sera ajouté avec le rôle indiqué.

Limites de débit : 10 appels par minute et par account_user

usage

await client.projectPermissions.projectUserRolesUpdate(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        data: {
            role: "editor",
        },
    },
);

Paramètres

accountId : Frameio.Uuid

projectId : Frameio.Uuid

UserId : Frameio.Uuid

request : Frameio.UpdateUserRolesParams

requestOptions : ProjectPermissions.RequestOptions

Projets

client.projects.show(accountId, projectId, { ...params }) -> Frameio.ProjectWithIncludesResponse

Afficher les détails du projet.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

projectId : Frameio.Uuid

request : Frameio.ProjectsShowRequest

requestOptions : Projects.RequestOptions

client.projects.delete(accountId, projectId) -> void

Supprimer un projet.

Limites de débit : 60 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

projectId : Frameio.Uuid

requestOptions : Projects.RequestOptions

client.projects.update(accountId, projectId, { ...params }) -> Frameio.ProjectResponse

Mettre à jour les détails du projet.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

projectId : Frameio.Uuid

request : Frameio.ProjectUpdateParams

requestOptions : Projects.RequestOptions

client.projects.index(accountId, workspaceId, { ...params }) -> core.Page<Frameio.ProjectWithIncludes>

Répertorier des projets dans un espace de travail donné.

Limites de débit : 100 appels par minute et par account_user

usage

const response = await client.projects.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include: "owner",
        after: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
for await (const item of response) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    include: "owner",
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Paramètres

accountId : Frameio.Uuid

workspaceId : Frameio.Uuid

request : Frameio.ProjectsIndexRequest

requestOptions : Projects.RequestOptions

client.projects.create(accountId, workspaceId, { ...params }) -> Frameio.ProjectResponse

Créer un projet dans un espace de travail donné.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

workspaceId : Frameio.Uuid

request : Frameio.ProjectsParams

requestOptions : Projects.RequestOptions

Dossiers

client.folders.show(accountId, folderId, { ...params }) -> Frameio.FolderWithIncludesResponse

Afficher les détails du dossier.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

projectId : Frameio.Uuid

request : Frameio.FoldersShowRequest

requestOptions : Folders.RequestOptions

client.folders.delete(accountId, folderId) -> void

Supprimer un dossier par son identifiant.

Limites de débit : 60 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

requestOptions : Folders.RequestOptions

client.folders.update(accountId, folderId, { ...params }) -> Frameio.FolderResponse

Mettre à jour les détails du dossier.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FolderUpdateParams

requestOptions : Folders.RequestOptions

client.folders.index(accountId, folderId, { ...params }) -> Frameio.AssetsWithIncludesResponse

Répertorier les enfants dans un dossier donné.

Utilisez le paramètre de requête « include » pour inclure de manière sélective des propriétés supplémentaires dans la réponse.

Si vous incluezmedia_links.originalet que l’utilisateur n’est pas autorisé à télécharger des fichiers dans le projet correspondant, ce point d’entrée renverra une erreur403 Interdit. Si le contenu est inaccessible parce qu’un filigrane est requis pour cet utilisateur et n’est pas pris en charge par les liens de médias demandés, la requête aboutira, mais les liens de médias non pris en charge seront définis sur « null ». De même, si le lien de transcodage demandé n’existe pas pour un fichier donné (par exemple, media_links.video_h264_180 pour un fichier image statique) ou si le processus de transcodage n’est pas terminé (c’est-à-dire que le statut du fichier est « chargé » et non « transcodé »,) le lien de médias sera également défini sur « null » dans la payload de la réponse. En résumé, le client doit gérer correctement les liens de médias nuls.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FolderIndexRequest

requestOptions : Folders.RequestOptions

client.folders.copy(accountId, folderId, { ...params }) -> Frameio.FolderCopyResponse

Copier le dossier.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FolderCopyParams

requestOptions : Folders.RequestOptions

client.folders.list(accountId, folderId, { ...params }) -> Frameio.FoldersWithIncludesResponse

Répertorier des dossiers au sein d’un dossier donné.

Limites de débit : 5 appels par seconde et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FoldersListRequest

requestOptions : Folders.RequestOptions

client.folders.create(accountId, folderId, { ...params }) -> Frameio.FolderResponse

Créer un nouveau dossier à l’intérieur du chemin spécifié par le paramètre folder_id.

Limites de débit : 3 appels par seconde et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FolderCreateParams

requestOptions : Folders.RequestOptions

client.folders.move(accountId, folderId, { ...params }) -> Frameio.FolderResponse

Déplacer le dossier vers un autre dossier.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FolderMoveParams

requestOptions : Folders.RequestOptions

Piles de versions

client.versionStacks.index(accountId, versionStackId, { ...params }) -> Frameio.AssetsWithIncludesResponse

Répertorier les éléments enfants (fichiers) d’une pile de versions donnée.

Utilisez le paramètre de requête « include » pour inclure de manière sélective des propriétés supplémentaires dans la réponse.

Limites de débit : 100 appels par minute et par account_user

usage

await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    include: "media_links",
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});

Paramètres

accountId : Frameio.Uuid

projectId : Frameio.Uuid

request : Frameio.VersionStacksIndexRequest

requestOptions : VersionStacks.RequestOptions

client.versionStacks.show(accountId, versionStackId, { ...params }) -> Frameio.VersionStackWithIncludesResponse

Afficher les détails de la pile de versions.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

versionStackId : Frameio.Uuid

request : Frameio.VersionStacksShowRequest

requestOptions : VersionStacks.RequestOptions

client.versionStacks.copy(accountId, versionStackId, { ...params }) -> Frameio.VersionStackCopyResponse

Copier une pile de versions.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

versionStackId : Frameio.Uuid

request : Frameio.VersionStackCopyParams

requestOptions : VersionStacks.RequestOptions

client.versionStacks.list(accountId, folderId, { ...params }) -> Frameio.VersionStacksWithIncludesResponse

Répertorier des piles de versions au sein d’un dossier donné.

Limites de débit : 5 appels par seconde et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.VersionStacksListRequest

requestOptions : VersionStacks.RequestOptions

client.versionStacks.create(accountId, folderId, { ...params }) -> Frameio.VersionStackWithIncludesResponse

Créer une nouvelle pile de versions dans le dossier parent.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.VersionStackCreateParams

requestOptions : VersionStacks.RequestOptions

client.versionStacks.move(accountId, versionStackId, { ...params }) -> Frameio.VersionStackResponse

Déplacer la pile de versions vers un dossier.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.VersionStackMoveParams

requestOptions : VersionStacks.RequestOptions

Autorisations du compte

client.accountPermissions.index(accountId, { ...params }) -> core.Page<Frameio.AccountUserRole>

Répertorier les rôles d’utilisateur pour un compte donné.

Limites de débit : 100 appels par minute et par account_user

usage

const response = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    include_deactivated: true,
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
for await (const item of response) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    include_deactivated: true,
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Paramètres

accountId : Frameio.Uuid

request : Frameio.AccountPermissionsIndexRequest

requestOptions : AccountPermissions.RequestOptions

Comptes

client.accounts.index({ ...params }) -> core.Page<Frameio.Account>

Répertorier les comptes de l’utilisateur actuel.

Limites de débit : 100 appels par minute et par account_user

usage

const response = await client.accounts.index({
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
for await (const item of response) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.accounts.index({
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Paramètres

request : Frameio.AccountsIndexRequest

requestOptions : Accounts.RequestOptions

Commentaires

client.comments.show(accountId, commentId, { ...params }) -> Frameio.CommentWithIncludesResponse

Afficher un seul commentaire sur un fichier.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

commentId : Frameio.Uuid

request : Frameio.CommentsShowRequest

requestOptions : Comments.RequestOptions

client.comments.delete(accountId, commentId) -> void

Supprimer un commentaire d’une ressource.

Limites de débit : 60 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

commentId : Frameio.Uuid

requestOptions : Comments.RequestOptions

client.comments.update(accountId, commentId, { ...params }) -> Frameio.CommentResponse

Mettre à jour le commentaire sur une ressource donnée.

Limites de débit : 10 appels par minute et par account_user

usage

await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    timestamp_as_timecode: true,
    data: {
        annotation:
            '[{"tool":"rect","color":"#F22237","size":8,"x":0.277726001863933,"y":0.12909555568499534,"w":0.3153168321877913,"h":0.5308131407269339,"ix":0.277726001863933,"iy":0.12909555568499534,"radius":8}]',
        completed: false,
        page: 4,
        text: "This is great!",
    },
});

Paramètres

accountId : Frameio.Uuid

commentId : Frameio.Uuid

request : Frameio.UpdateCommentParams

requestOptions : Comments.RequestOptions

client.comments.index(accountId, fileId, { ...params }) -> core.Page<Frameio.CommentWithIncludes>

Répertorier les commentaires d’une ressource donnée.

Limites de débit : 100 appels par minute et par account_user

usage

const response = await client.comments.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include: "owner",
        after: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
for await (const item of response) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    include: "owner",
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Paramètres

accountId : Frameio.Uuid

fileId : Frameio.Uuid

request : Frameio.CommentsIndexRequest

requestOptions : Comments.RequestOptions

client.comments.create(accountId, fileId, { ...params }) -> Frameio.CommentResponse

Créer un commentaire sur un fichier.

Limites de débit : 100 appels par minute et par account_user

usage

await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    timestamp_as_timecode: true,
    data: {
        annotation:
            '[{"tool":"rect","color":"#F22237","size":8,"x":0.277726001863933,"y":0.12909555568499534,"w":0.3153168321877913,"h":0.5308131407269339,"ix":0.277726001863933,"iy":0.12909555568499534,"radius":8}]',
        completed: false,
        page: 4,
        text: "This is great!",
        timestamp: "00:00:02:12",
    },
});

Paramètres

accountId : Frameio.Uuid

fileId : Frameio.Uuid

request : Frameio.CreateCommentParams

requestOptions : Comments.RequestOptions

Webhooks

client.webhooks.index(accountId, workspaceId, { ...params }) -> core.Page<Frameio.WebhookWithIncludes>

Répertorier les webhooks pour un espace de travail donné.

Limites de débit : 100 appels par minute et par account_user

usage

const response = await client.webhooks.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include: "creator",
        after: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
for await (const item of response) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.webhooks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    include: "creator",
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Paramètres

accountId : Frameio.Uuid

workspaceId : Frameio.Uuid

request : Frameio.WebhooksIndexRequest

requestOptions : Webhooks.RequestOptions

client.webhooks.create(accountId, workspaceId, { ...params }) -> Frameio.WebhookCreateResponse

Crée un seul webhook avec un secret.

Événements valides :

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

Limites de débit : 10 appels par minute et par account

usage

await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    data: {
        events: [
            "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",
        ],
        name: "New Webhook",
        url: "https://url.example.com",
    },
});

Paramètres

accountId : Frameio.Uuid

workspaceId : Frameio.Uuid

request : Frameio.WebhookCreateParams

requestOptions : Webhooks.RequestOptions

client.webhooks.show(accountId, webhookId, { ...params }) -> Frameio.WebhookWithIncludesResponse

Afficher les détails du webhook.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

webhookId : Frameio.Uuid

request : Frameio.WebhooksShowRequest

requestOptions : Webhooks.RequestOptions

client.webhooks.delete(accountId, webhookId) -> void

Supprimer un webhook.

Limites de débit : 60 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

webhookId : Frameio.Uuid

requestOptions : Webhooks.RequestOptions

client.webhooks.update(accountId, webhookId, { ...params }) -> Frameio.WebhookResponse

Mettre à jour les détails du webhook.

Limites de débit : 10 appels par minute et par account_user

usage

await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    data: {
        active: true,
        events: [
            "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",
        ],
        name: "Updated Webhook",
        url: "https://url.example.com",
    },
});

Paramètres

accountId : Frameio.Uuid

webhookId : Frameio.Uuid

request : Frameio.WebhookUpdateParams

requestOptions : Webhooks.RequestOptions

Autorisations de l’espace de travail

client.workspacePermissions.index(accountId, workspaceId, { ...params }) -> core.Page<Frameio.UserRole>

Répertorier les rôles d’utilisateur pour un espace de travail donné.

Limites de débit : 100 appels par 1.00 minute(s) par account_user

usage

const response = await client.workspacePermissions.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include_deactivated: true,
        after: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
for await (const item of response) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.workspacePermissions.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include_deactivated: true,
        after: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Paramètres

accountId : Frameio.Uuid

workspaceId : Frameio.Uuid

request : Frameio.WorkspacePermissionsIndexRequest

requestOptions : WorkspacePermissions.RequestOptions

client.workspacePermissions.workspaceUserRolesDelete(accountId, workspaceId, userId) -> void

Supprimer un utilisateur d’un espace de travail donné.

Limites de débit : 60 appels par minute et par account_user

usage

await client.workspacePermissions.workspaceUserRolesDelete(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
);

Paramètres

accountId : Frameio.Uuid

workspaceId : Frameio.Uuid

userId : Frameio.Uuid

requestOptions : WorkspacePermissions.RequestOptions

client.workspacePermissions.workspaceUserRolesUpdate(accountId, workspaceId, userId, { ...params }) -> Frameio.UpdateUserRolesResponse

Mettre à jour les rôles des utilisateurs pour l’espace de travail spécifié si l’utilisateur est déjà ajouté à l’espace de travail. Si l’utilisateur n’est pas encore ajouté à l’espace de travail, il sera ajouté avec le rôle indiqué.

Limites de débit : 10 appels par minute et par account_user

usage

await client.workspacePermissions.workspaceUserRolesUpdate(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        data: {
            role: "editor",
        },
    },
);

Paramètres

accountId : Frameio.Uuid

workspaceId : Frameio.Uuid

userId : Frameio.Uuid

request : Frameio.UpdateUserRolesParams

requestOptions : WorkspacePermissions.RequestOptions

Espaces de travail

client.workspaces.show(accountId, workspaceId, { ...params }) -> Frameio.WorkspaceWithIncludesResponse

Afficher les détails de l’espace de travail.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

workspaceId : Frameio.Uuid

request : Frameio.WorkspacesShowRequest

requestOptions : Workspaces.RequestOptions

client.workspaces.delete(accountId, workspaceId) -> void

Supprimer l’espace de travail du compte.

Limites de débit : 60 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

workspaceId : Frameio.Uuid

requestOptions : Workspaces.RequestOptions

client.workspaces.update(accountId, workspaceId, { ...params }) -> Frameio.WorkspaceResponse

Mettre à jour un espace de travail.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

workspaceId : Frameio.Uuid

request : Frameio.WorkspaceParams

requestOptions : Workspaces.RequestOptions

client.workspaces.index(accountId, { ...params }) -> core.Page<Frameio.WorkspaceWithIncludes>

Répertorier les espaces de travail pour un compte donné.

Limites de débit : 100 appels par minute et par account_user

usage

const response = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    include: "creator",
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
for await (const item of response) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    include: "creator",
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Paramètres

accountId : Frameio.Uuid

request : Frameio.WorkspacesIndexRequest

requestOptions : Workspaces.RequestOptions

client.workspaces.create(accountId, { ...params }) -> Frameio.WorkspaceResponse

Créer un espace de travail à partir d’un compte.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

request : Frameio.WorkspaceParams

requestOptions : Workspaces.RequestOptions

Partages

client.shares.show(accountId, shareId) -> Frameio.ShareResponse

Afficher un seul partage.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

shareId : Frameio.Uuid

requestOptions : Shares.RequestOptions

client.shares.delete(accountId, shareId) -> void

Supprimer un partage.

Limites de débit : 60 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

shareId : Frameio.Uuid

requestOptions : Shares.RequestOptions

client.shares.update(accountId, shareId, { ...params }) -> Frameio.ShareResponse

Mettre à jour un partage.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

shareId : Frameio.Uuid

request : Frameio.UpdateShareParams

requestOptions : Shares.RequestOptions

client.shares.listReviewers(accountId, shareId, { ...params }) -> core.Page<Frameio.User>

Répertorier les réviseurs du partage.

Limites de débit : 10 appels par minute et par account_user

usage

const response = await client.shares.listReviewers(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        after: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
for await (const item of response) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.shares.listReviewers(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        after: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Paramètres

accountId : Frameio.Uuid

shareId : Frameio.Uuid

request : Frameio.SharesListReviewersRequestreParams

requestOptions : Shares.RequestOptions

client.shares.addReviewers(accountId, shareId, { ...params }) -> void

Ajouter des réviseurs à un partage sécurisé selon trois types d’identificateurs : adobe_user_id, email et user_id.

Une requête ne peut inclure qu’un seul paramètre de type identifiant.

email est le seul identifiant permettant d’ajouter des réviseurs à un partage qui ne disposent pas d’un compte Frame sur le compte auquel appartient ce partage.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

shareId : Frameio.Uuid

request : Frameio.AddReviewersToShareParams

requestOptions : Shares.RequestOptions

client.shares.removeReviewers(accountId, shareId, { ...params }) -> void

Supprimer des réviseurs du partage sécurisé selon trois types d’identificateurs : adobe_user_id, email et user_id.

Une requête ne peut inclure qu’un seul paramètre de type identifiant.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

shareId : Frameio.Uuid

request : Frameio.RemoveReviewerParams

requestOptions : Shares.RequestOptions

client.shares.removeAsset(accountId, shareId, assetId) -> Frameio.RemoveAssetResponse

Supprimer un élément actuellement présent dans le partage de ce dossier.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

shareId : Frameio.Uuid

assetId : Frameio.Uuid

requestOptions : Shares.RequestOptions

client.shares.addAsset(accountId, shareId, { ...params }) -> Frameio.AddAssetResponse

Ajouter un nouveau partage de ressources.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

shareId : Frameio.Uuid

request : Frameio.AddAssetParams

requestOptions : Shares.RequestOptions

client.shares.index(accountId, projectId, { ...params }) -> core.Page<Frameio.Share>

Répertorier les partages d’un projet.

Limites de débit : 100 appels par minute et par account_user

usage

const response = await client.shares.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        after: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
for await (const item of response) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.shares.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    after: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Paramètres

accountId : Frameio.Uuid

shareId : Frameio.Uuid

request : Frameio.SharesIndexRequest

requestOptions : Shares.RequestOptions

client.shares.create(accountId, projectId, { ...params }) -> Frameio.ShareResponse

Créer un partage.

Limites de débit : 10 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

projectId : Frameio.Uuid

request : Frameio.CreateShareParams

requestOptions : Shares.RequestOptions

Fichiers

client.files.list(accountId, folderId, { ...params }) -> Frameio.AssetsWithIncludesResponse

Répertorier les fichiers d’un dossier donné.

Limites de débit : 5 appels par seconde et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FilesListRequest

requestOptions : Files.RequestOptions

client.files.create(accountId, folderId, { ...params }) -> Frameio.FileWithUploadUrlsResponse

Créer un nouveau fichier dans le dossier parent. Créer un fichier (chargement local) et Créer un fichier (chargement à distance) ont remplacé ce point d’entrée.

Limites de débit : 5 appels par seconde et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FileCreateParams

requestOptions : Files.RequestOptions

client.files.show(accountId, fileId, { ...params }) -> Frameio.FileWithIncludesResponse

Afficher les détails du fichier.

Utilisez le paramètre de requête « include » pour inclure de manière sélective des propriétés supplémentaires dans la réponse.

Si vous incluez media_links.original et que l’utilisateur n’est pas autorisé à télécharger le fichier, ce point d’entrée renverra une erreur 403 Interdit. Si le contenu est inaccessible parce qu’un filigrane est requis pour cet utilisateur et n’est pas pris en charge par les liens de médias demandés, la requête aboutira, mais les liens de médias non pris en charge seront définis sur « null ». De même, si le lien de transcodage demandé n’existe pas pour un fichier donné (par exemple, media_links.video_h264_180 pour un fichier image statique) ou si le processus de transcodage n’est pas terminé (c’est-à-dire que le statut du fichier est « chargé » et non « transcodé »,) le lien de médias sera également défini sur « null » dans la payload de la réponse. En résumé, le client doit gérer correctement les liens de médias nuls.

Limites de débit : 5 appels par seconde et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FilesShowRequest

requestOptions : Files.RequestOptions

client.files.delete(accountId, fileId) -> void

Supprimer un fichier par son identifiant.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

fileId : Frameio.Uuid

requestOptions : Files.RequestOptions

client.files.update(accountId, fileId, { ...params }) -> Frameio.FileResponse

Mettre à jour les détails du fichier.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

fileId : Frameio.Uuid

request : Frameio.FileUpdateParams

requestOptions : Files.RequestOptions

client.files.copy(accountId, fileId, { ...params }) -> Frameio.FileCopyResponse

Copier le fichier.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

fileId : Frameio.Uuid

request : Frameio.FileCopyParams

requestOptions : Files.RequestOptions

client.files.createRemoteUpload(accountId, folderId, { ...params }) -> Frameio.FileRemoteUploadResponse

Créer un nouveau fichier dans le dossier parent par le biais d’un chargement à distance.

Limites de débit : 5 appels par seconde et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FileCreateRemoteUploadParams

requestOptions : Files.RequestOptions

client.files.move(accountId, fileId, { ...params }) -> Frameio.FileResponse

Déplacer le fichier vers un dossier ou version_stack.

Limites de débit : 100 appels par minute et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

fileId : Frameio.Uuid

request : Frameio.FileMoveParams

requestOptions : Files.RequestOptions

client.files.createLocalUpload(accountId, folderId, { ...params }) -> Frameio.FileWithUploadUrlsResponse

Créer un nouveau fichier dans le dossier parent par le biais d’un chargement local.

Limites de débit : 5 appels par seconde et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

folderId : Frameio.Uuid

request : Frameio.FileCreateLocalUploadParams

requestOptions : Files.RequestOptions

client.files.showFileUploadStatus(accountId, fileId) -> Frameio.FileUploadStatusResponse

Afficher les détails du statut de chargement du fichier.

Limites de débit : 5 appels par seconde et par account_user

usage

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

Paramètres

accountId : Frameio.Uuid

fileId : Frameio.Uuid

requestOptions : Files.RequestOptions

Utilisateurs et utilisatrices

client.users.show() -> Frameio.ProfileResponse

Consulter les informations relatives à l’utilisateur associé au jeton du porteur.

Limites de débit : 100 appels par minute et par account_user

usage

await client.users.show();

Paramètres

requestOptions : Users.RequestOptions

npm

Afficher sur npm