Class Bundles

Hierarchy (view full)

CrowdinApi
- Bundles

Index

Constructors

Methods

addBundle checkBundleExportStatus deleteBundle downloadBundle editBundle exportBundle getBundle graphql listBundleBranches listBundleFiles listBundles withFetchAll

Constructors

constructor

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

Methods

addBundle

addBundle(projectId, request): Promise<ResponseObject<Bundle>>
Parameters
- projectId: number
  project identifier
- request: CreateBundleRequest
  request body
Returns Promise<ResponseObject<Bundle>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.post
- Defined in bundles/index.ts:28

checkBundleExportStatus

checkBundleExportStatus(projectId, bundleId, exportId): Promise<ResponseObject<Status<ExportAttributes>>>
Parameters
- projectId: number
  project identifier
- bundleId: number
  bundle identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<Status<ExportAttributes>>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.exports.get
- Defined in bundles/index.ts:98

deleteBundle

deleteBundle(projectId, bundleId): Promise<void>
Parameters
- projectId: number
  project identifier
- bundleId: number
  bundle identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.delete
- Defined in bundles/index.ts:51

downloadBundle

downloadBundle(projectId, bundleId, exportId): Promise<ResponseObject<DownloadLink>>
Parameters
- projectId: number
  project identifier
- bundleId: number
  bundle identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.exports.download.get
- Defined in bundles/index.ts:77

editBundle

editBundle(projectId, bundleId, request): Promise<ResponseObject<Bundle>>
Parameters
- projectId: number
  project identifier
- bundleId: number
  bundle identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Bundle>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.patch
- Defined in bundles/index.ts:62

exportBundle

exportBundle(projectId, bundleId): Promise<ResponseObject<Status<ExportAttributes>>>
Parameters
- projectId: number
  project identifier
- bundleId: number
  bundle identifier
Returns Promise<ResponseObject<Status<ExportAttributes>>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.exports.post
- Defined in bundles/index.ts:87

getBundle

getBundle(projectId, bundleId): Promise<ResponseObject<Bundle>>
Parameters
- projectId: number
  project identifier
- bundleId: number
  bundle identifier
Returns Promise<ResponseObject<Bundle>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.get
- Defined in bundles/index.ts:41

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

listBundleBranches

listBundleBranches(projectId, bundleId, options?): Promise<ResponseList<Branch>>
Parameters
- projectId: number
  project identifier
- bundleId: number
  bundle identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<Branch>>
- Defined in bundles/index.ts:127

listBundleFiles

listBundleFiles(projectId, bundleId, options?): Promise<ResponseList<File>>
Parameters
- projectId: number
  project identifier
- bundleId: number
  bundle identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<File>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.files.getMany
- Defined in bundles/index.ts:113

listBundles

listBundles(projectId, options?): Promise<ResponseList<Bundle>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<Bundle>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.getMany
- Defined in bundles/index.ts:18

withFetchAll

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