Class Fields

Hierarchy (view full)

CrowdinApi
- Fields

Index

Constructors

Methods

addField deleteField editField getField graphql listFields withFetchAll

Constructors

constructor

new Fields(credentials, config?): Fields
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns Fields
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:230

Methods

addField

addField(request): Promise<ResponseObject<Field>>
Parameters
- request: AddFieldRequest
  request body
Returns Promise<ResponseObject<Field>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.post
- Defined in fields/index.ts:20

deleteField

deleteField(fieldId): Promise<void>
Parameters
- fieldId: number
  field identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.fields.delete
- Defined in fields/index.ts:38

editField

editField(fieldId, request): Promise<ResponseObject<Field>>
Parameters
- fieldId: number
  field identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Field>>
See
https://developer.crowdin.com/api/v2/#operation/api.fields.patch
- Defined in fields/index.ts:48

getField

getField(fieldId): Promise<ResponseObject<Field>>
Parameters
- fieldId: number
  field identifier
Returns Promise<ResponseObject<Field>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.get
- Defined in fields/index.ts:29

graphql

graphql<T>(req, config?): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
- config: {
  url?: string;
  } = {}
  - Optionalurl?: string
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:264

listFields

listFields(options?): Promise<ResponseList<Field>>
Parameters
- Optionaloptions: ListFieldsParams
  optional parameters for the request
Returns Promise<ResponseList<Field>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.getMany
- Defined in fields/index.ts:8

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:326