BundleApi
extends AbstractApi
in package
Manage project bundles
Table of Contents
Methods
- checkExportStatus() : BundleExport|null
- Check Bundle Export Status
- create() : Bundle|null
- Add Bundle
- delete() : mixed
- Delete Bundle
- download() : DownloadFile|null
- Download Bundle
- export() : BundleExport
- Export Bundle
- get() : Bundle|null
- Get Bundle Info
- list() : ModelCollection
- List Bundles
- listFiles() : ModelCollection
- List Files
- update() : Bundle|null
- Edit Bundle
Methods
checkExportStatus()
Check Bundle Export Status
public
checkExportStatus(int $projectId, int $bundleId, string $exportId) : BundleExport|null
Parameters
- $projectId : int
- $bundleId : int
- $exportId : string
Tags
Return values
BundleExport|nullcreate()
Add Bundle
public
create(int $projectId, array<string|int, mixed> $data) : Bundle|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
string $data[name] required
string $data[format] required
string[] $data[sourcePatterns] required
string[] $data[ignorePatterns]
string $data[exportPattern] required Note: Can't contain \ / : * ? " < > | symbols
int[] $data[labelIds]
Tags
Return values
Bundle|nulldelete()
Delete Bundle
public
delete(int $projectId, int $bundleId) : mixed
Parameters
- $projectId : int
- $bundleId : int
Tags
download()
Download Bundle
public
download(int $projectId, int $bundleId, string $exportId) : DownloadFile|null
Parameters
- $projectId : int
- $bundleId : int
- $exportId : string
Tags
Return values
DownloadFile|nullexport()
Export Bundle
public
export(int $projectId, int $bundleId) : BundleExport
Parameters
- $projectId : int
- $bundleId : int
Tags
Return values
BundleExportget()
Get Bundle Info
public
get(int $projectId, int $bundleId) : Bundle|null
Parameters
- $projectId : int
- $bundleId : int
Tags
Return values
Bundle|nulllist()
List Bundles
public
list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionlistFiles()
List Files
public
listFiles(int $projectId, int $bundleId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $bundleId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdate()
Edit Bundle
public
update(int $projectId, Bundle $bundle) : Bundle|null
Parameters
- $projectId : int
- $bundle : Bundle