Class UploadedFilesService

Hierarchy (view full)

BaseService<UploadedFile, UploadedFileInterface>
- UploadedFilesService

Index

Constructors

Properties

availableOperations baseUrl headers instances

Methods

factory get getMany list upload

Constructors

constructor

new UploadedFilesService(init): UploadedFilesService
Service classes are not intended to be instantiated directly. Instead, use the Client class to create instances of services.
Parameters
- init: {
  headers: Record<string, string>;
  }
  - headers: Record<string, string>
Returns UploadedFilesService
Inherited from BaseService.constructor
- Defined in base-service.ts:26

Properties

availableOperations

availableOperations: ServiceOperation[] = ...

Lists out the available operations for the resource, calling methods not in this list will result in an error

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/files'

headers

headers: Record<string, string>

`Protected` instances

instances: Record<string, UploadedFile> = {}

Methods

factory

factory(data): UploadedFile
Parameters
- data: UploadedFileInterface
Returns UploadedFile
Overrides BaseService.factory
- Defined in uploaded-files/uploaded-files-service.ts:14

get

get(id): Promise<UploadedFile>
Parameters
- id: string | number
Returns Promise<UploadedFile>
Inherited from BaseService.get
- Defined in base-service.ts:30

getMany

getMany(ids): Promise<UploadedFile[]>
Parameters
- ids: string[] | number[]
Returns Promise<UploadedFile[]>
Inherited from BaseService.getMany
- Defined in base-service.ts:49

list

list(): Promise<UploadedFile[]>
Returns Promise<UploadedFile[]>
Inherited from BaseService.list
- Defined in base-service.ts:53

upload

upload(file, story?): Promise<UploadedFile>
Uploads a file to Shortcut, optionally associating it with a story. Note that it is unknown where non-story associated files are stored.
Parameters
- file: Buffer
  The file to upload
- Optional story: number | Story
  The story to associate the file with, either an instance of Story or a story ID
Returns Promise<UploadedFile>
- Defined in uploaded-files/uploaded-files-service.ts:22