Class StringCorrections

Hierarchy (view full)

CrowdinApi
- StringCorrections

Index

Constructors

Methods

addStringCorrection deleteStringCorrection deleteStringCorrections getStringCorrection graphql listStringCorrections restoreStringCorrection withFetchAll

Constructors

constructor

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

Methods

addStringCorrection

addStringCorrection(projectId, request): Promise<ResponseObject<StringCorrection>>
Parameters
- projectId: number
  project identifier
- request: AddStringCorrectionRequest
  request body
Returns Promise<ResponseObject<StringCorrection>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.post
- Defined in stringCorrections/index.ts:25

deleteStringCorrection

deleteStringCorrection(projectId, correctionId): Promise<void>
Parameters
- projectId: number
  project identifier
- correctionId: number
  correction identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.delete
- Defined in stringCorrections/index.ts:78

deleteStringCorrections

deleteStringCorrections(projectId, stringId): Promise<void>
Parameters
- projectId: number
  project identifier
- stringId: number
  string identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.deleteMany
- Defined in stringCorrections/index.ts:38

getStringCorrection

getStringCorrection(projectId, correctionId, params?): Promise<ResponseObject<StringCorrection>>
Parameters
- projectId: number
  project identifier
- correctionId: number
  correction identifier
- Optionalparams: {
  denormalizePlaceholders?: BooleanInt;
  }
  query params
  - OptionaldenormalizePlaceholders?: BooleanInt
Returns Promise<ResponseObject<StringCorrection>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.get
- Defined in stringCorrections/index.ts:50

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:266

listStringCorrections

listStringCorrections(projectId, options): Promise<ResponseList<StringCorrection>>
Parameters
- projectId: number
  project identifier
- options: ListStringCorrectionsParams
  optional pagination parameters for the request
Returns Promise<ResponseList<StringCorrection>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.getMany
- Defined in stringCorrections/index.ts:9

restoreStringCorrection

restoreStringCorrection(projectId, correctionId): Promise<ResponseObject<StringCorrection>>
Parameters
- projectId: number
  project identifier
- correctionId: number
  correction identifier
Returns Promise<ResponseObject<StringCorrection>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.put
- Defined in stringCorrections/index.ts:65

withFetchAll

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

Class StringCorrections

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns StringCorrections

Methods

addStringCorrection

Parameters

Returns Promise<ResponseObject<StringCorrection>>

See

deleteStringCorrection

Parameters

Returns Promise<void>

See

deleteStringCorrections

Parameters

Returns Promise<void>

See

getStringCorrection

Parameters

OptionaldenormalizePlaceholders?: BooleanInt

Returns Promise<ResponseObject<StringCorrection>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

listStringCorrections

Parameters

Returns Promise<ResponseList<StringCorrection>>

See

restoreStringCorrection

Parameters

Returns Promise<ResponseObject<StringCorrection>>

See

withFetchAll

Parameters

Returns this

Settings

On This Page

`Optional`denormalizePlaceholders?: BooleanInt

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string