-
exportCreatePackage(args)
-
Creates Creative Exchange export package containing site content and referenced theme
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Argument |
Description |
roots |
Array.<string>
|
|
Content roots |
force |
boolean
|
|
Force |
engine |
string
|
|
Engine |
synchronous |
boolean
|
<optional>
|
- |
|
Returns:
-
Type
-
Promise
-
exportDownloadPackage(args)
-
Download export package as .zip file.
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
id |
String
|
Package id |
|
Returns:
-
Type
-
Promise
-
exportGetAllPackages(args)
-
Get list of all Creative Exchange export packages. These packages contains package id
which can later be used for accessing package status or downloading it
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Argument |
Description |
page |
number
|
<optional>
|
Number of page containing 20 items |
|
Returns:
-
Type
-
Promise.<ExportGetPackageResults, Error.<RequestError>>
-
exportGetPackageStatus(args)
-
Get status of the package. During exporting package can have status IN_PROGRESS or DONE
indicating if package is still exporting or if can be downloaded
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
id |
String
|
Package id |
|
Returns:
-
Type
-
Promise
-
exportRemovePackage(args)
-
Removes package from instance
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
id |
String
|
Package id |
|
Returns:
-
Type
-
Promise
-
importDownloadPackage(args)
-
Download the import package as .zip file.
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
id |
String
|
Package id |
|
Returns:
-
Type
-
Promise
-
importGetAllPackages(args)
-
Get list of all import packages. These packages contains package id
which can later be used for accessing package status, downloading it or installing
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Argument |
Description |
page |
number
|
<optional>
|
Number of page containing 20 items |
|
Returns:
-
Type
-
Promise.<ExportGetPackageResults, Error.<RequestError>>
-
importGetPackageStatus(args)
-
Get status of the package. During importing package can have status IN_PROGRESS or DONE
indicating if package is still importing or if can be downloaded
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
id |
String
|
Package id |
|
Returns:
-
Type
-
Promise
-
importInspectPackage(args)
-
Inspect package. Inspect allows for checking what changes will install make without actual
change of theme or content or instance
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
id |
String
|
Package id |
|
Returns:
-
Type
-
Promise
-
importInstallPackage(args)
-
Install package. Modifies theme and adds new variants.
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
id |
String
|
Package id |
|
Returns:
-
Type
-
Promise
-
importRemovePackage(args)
-
Removes package from instance
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
id |
String
|
Package id |
|
Returns:
-
Type
-
Promise
-
importUploadPackage(args)
-
Upload package to an instance
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
file |
String
|
Binary representation of .zip package |
|
Returns:
-
Type
-
Promise
-
themesActivateThemes(args)
-
Activate selected themes to publish instance
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
themes |
Array.<string>
|
Theme paths |
|
Returns:
-
Type
-
Promise
-
themesCheckActivateProgress(args)
-
Returns progress of theme activation
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
id |
string
|
Theme id |
|
Returns:
-
Type
-
Promise
-
themesCreateTheme(args)
-
Create new theme
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Argument |
Description |
themeName |
string
|
|
Name of new theme |
parentThemePath |
string
|
<optional>
|
Parent theme |
protectedTheme |
boolean
|
<optional>
|
Protected theme |
finalTheme |
boolean
|
<optional>
|
Final theme |
|
Returns:
-
Type
-
Promise
-
themesDeleteTheme(args)
-
Removes themes from instance
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
themes |
Array.<string>
|
Theme paths |
|
Returns:
-
Type
-
Promise
-
themesExportThemes(args)
-
Downloads theme in CRX package format
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
themes |
Array.<string>
|
Theme paths |
|
Returns:
-
Type
-
Promise
-
themesGetAllThemes(args)
-
Get list of all themes.
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Argument |
Description |
page |
number
|
<optional>
|
Number of page containing 20 items |
|
Returns:
-
Type
-
Promise
-
themesGetDetails(args)
-
Get details about theme
Parameters:
| Name |
Type |
Description |
args |
Object
|
Properties
| Name |
Type |
Description |
name |
Array.<string>
|
Theme name |
|
Returns:
-
Type
-
Promise