Class CustomFieldsService

Hierarchy (view full)

BaseService<CustomField, CustomFieldInterface>
- CustomFieldsService

Index

Constructors

Properties

availableOperations baseUrl headers instances

Methods

factory get getMany list

Constructors

constructor

new CustomFieldsService(init): CustomFieldsService
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 CustomFieldsService
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/custom-fields'

headers

headers: Record<string, string>

`Protected` instances

instances: Record<string, CustomField> = {}

Methods

`Protected` factory

factory(data): CustomField
Parameters
- data: CustomFieldInterface
Returns CustomField
Overrides BaseService.factory
- Defined in custom-fields/custom-fields-service.ts:8

get

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

getMany

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

list

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