Class UploadsResource

Hierarchy

Resource
- UploadsResource

Index

Constructors

Methods

create get import iterate list remove update

Constructors

constructor

new UploadsResource(client: RequestSender): UploadsResource
Parameters
- client: RequestSender
Returns UploadsResource
Inherited from Resource.constructor
- Defined in src/resources/base.ts:28

Methods

create

create(
    idOrganization: string,
    input: FileInput,
    options?: RequestOptions,
): Promise<Upload>
Sube un fichero. Admite una ruta en disco, un Buffer o un Blob.

La ruta es la buena para lo grande: es la única forma que no pasa el fichero por memoria.
```
await pv.uploads.create(orgId, { file: "./hogaza.jpg" });
await pv.uploads.create(orgId, { file: bytes, filename: "hogaza.jpg" });
```
Parameters
- idOrganization: string
- input: FileInput
- options: RequestOptions = {}
Returns Promise<Upload>
- Defined in src/resources/uploads.ts:78

get

get(
    idOrganization: string,
    idUpload: string,
    options?: RequestOptions,
): Promise<Upload>
Un fichero. Pídelo de nuevo cuando necesites un public_path vigente.
Parameters
- idOrganization: string
- idUpload: string
- options: RequestOptions = {}
Returns Promise<Upload>
- Defined in src/resources/uploads.ts:112

import

import(
    idOrganization: string,
    idIntegration: string,
    files: readonly ImportFileInput[],
    options?: RequestOptions,
): Promise<ImportResult>
Trae a la biblioteca ficheros elegidos en una integración (el selector de Drive).

La respuesta es PARCIAL a propósito: mira errors aunque uploads traiga algo — de seis ficheros pueden entrar cuatro. Un 2204 significa que el proveedor no da los bytes: un documento nativo de Google no tiene fichero que descargar.
Parameters
- idOrganization: string
- idIntegration: string
- files: readonly ImportFileInput[]
- options: RequestOptions = {}
Returns Promise<ImportResult>
- Defined in src/resources/uploads.ts:151

iterate

iterate(
idOrganization: string,
options?: PageOptions & RequestOptions,
): AsyncGenerator<Upload>
Los ficheros de la biblioteca, encadenando páginas.
Parameters
- idOrganization: string
- options: PageOptions & RequestOptions = {}
Returns AsyncGenerator<Upload>
- Defined in src/resources/uploads.ts:107

list

list(
idOrganization: string,
options?: PageOptions & RequestOptions,
): Promise<Paginated<Upload>>
Los ficheros de la biblioteca.

No salen aquí los recortes que la plataforma se hace para sí misma (is_temporal) ni las portadas de vídeo, que son otro upload y viajan dentro del suyo.
Parameters
- idOrganization: string
- options: PageOptions & RequestOptions = {}
Returns Promise<Paginated<Upload>>
- Defined in src/resources/uploads.ts:94

remove

remove(
    idOrganization: string,
    idUpload: string,
    options?: { force?: boolean } & RequestOptions,
): Promise<void>
Borra un fichero.

Con force se borra aunque una publicación siga apuntándolo; sin él, un fichero en uso se conserva y sólo se saca de la biblioteca.
Parameters
- idOrganization: string
- idUpload: string
- options: { force?: boolean } & RequestOptions = {}
Returns Promise<void>
- Defined in src/resources/uploads.ts:132

update

update(
    idOrganization: string,
    idUpload: string,
    body: UploadUpdate,
    options?: RequestOptions,
): Promise<Upload>
Cambia la portada de un vídeo. Ojo con cover_offset: se escribe siempre (ver arriba).
Parameters
- idOrganization: string
- idUpload: string
- body: UploadUpdate
- options: RequestOptions = {}
Returns Promise<Upload>
- Defined in src/resources/uploads.ts:117