Class Distributions

Hierarchy (view full)

CrowdinApi
- Distributions

Index

Constructors

Methods

createDistribution createDistributionRelease deleteDistribution editDistribution getDistribution getDistributionRelease graphql listDistributions withFetchAll

Constructors

constructor

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

Methods

createDistribution

createDistribution(projectId, request): Promise<ResponseObject<Distribution>>
Parameters
- projectId: number
  project identifier
- request: CreateDistributionRequest | CreateDistributionStringsBasedRequest
  request body
Returns Promise<ResponseObject<Distribution>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.post
- Defined in distributions/index.ts:42

createDistributionRelease

createDistributionRelease(projectId, hash): Promise<ResponseObject<DistributionRelease | DistributionStringsBasedRelease>>
Parameters
- projectId: number
  project identifier
- hash: string
  hash
Returns Promise<ResponseObject<DistributionRelease | DistributionStringsBasedRelease>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.release.post
- Defined in distributions/index.ts:108

deleteDistribution

deleteDistribution(projectId, hash): Promise<void>
Parameters
- projectId: number
  project identifier
- hash: string
  hash
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.delete
- Defined in distributions/index.ts:67

editDistribution

editDistribution(projectId, hash, request): Promise<ResponseObject<Distribution>>
Parameters
- projectId: number
  project identifier
- hash: string
  hash
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Distribution>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.patch
- Defined in distributions/index.ts:78

getDistribution

getDistribution(projectId, hash): Promise<ResponseObject<Distribution>>
Parameters
- projectId: number
  project identifier
- hash: string
  hash
Returns Promise<ResponseObject<Distribution>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.get
- Defined in distributions/index.ts:57

getDistributionRelease

getDistributionRelease(projectId, hash): Promise<ResponseObject<DistributionRelease | DistributionStringsBasedRelease>>
Parameters
- projectId: number
  project identifier
- hash: string
  hash
Returns Promise<ResponseObject<DistributionRelease | DistributionStringsBasedRelease>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.release.get
- Defined in distributions/index.ts:92

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

listDistributions

listDistributions(projectId, options?): Promise<ResponseList<Distribution>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<Distribution>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.getMany
- Defined in distributions/index.ts:9
listDistributions(projectId, limit?, offset?): Promise<ResponseList<Distribution>>
Parameters
- projectId: number
  project identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<Distribution>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.getMany
- Defined in distributions/index.ts:20

withFetchAll

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

Class Distributions

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Distributions

Methods

createDistribution

Parameters

Returns Promise<ResponseObject<Distribution>>

See

createDistributionRelease

Parameters

Returns Promise<ResponseObject<DistributionRelease | DistributionStringsBasedRelease>>

See

deleteDistribution

Parameters

Returns Promise<void>

See

editDistribution

Parameters

Returns Promise<ResponseObject<Distribution>>

See

getDistribution

Parameters

Returns Promise<ResponseObject<Distribution>>

See

getDistributionRelease

Parameters

Returns Promise<ResponseObject<DistributionRelease | DistributionStringsBasedRelease>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

listDistributions

Parameters

Returns Promise<ResponseList<Distribution>>

See

Parameters

Returns Promise<ResponseList<Distribution>>

Deprecated

See

withFetchAll

Parameters

Returns this

Settings

On This Page

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string