@adobe/aio-lib-cloudmanager
Advanced tools
Comparing version 3.0.0 to 3.1.0
# Changelog | ||
# [3.1.0](https://github.com/adobe/aio-lib-cloudmanager/compare/3.0.0...3.1.0) (2023-04-26) | ||
### Bug Fixes | ||
* **release:** Update release job to ubuntu-latest. Fixes [#379](https://github.com/adobe/aio-lib-cloudmanager/issues/379) ([#380](https://github.com/adobe/aio-lib-cloudmanager/issues/380)) ([b0ff79b](https://github.com/adobe/aio-lib-cloudmanager/commit/b0ff79bd05445b1acc0336b0e87c212c69b12d61)) | ||
### Features | ||
* **content-set:** add Content Set Public API ([#376](https://github.com/adobe/aio-lib-cloudmanager/issues/376)). fixes [#378](https://github.com/adobe/aio-lib-cloudmanager/issues/378) ([7a88488](https://github.com/adobe/aio-lib-cloudmanager/commit/7a884881dbc20a6d4c3e0671324ab66d4aeb6657)) | ||
# [3.0.0](https://github.com/adobe/aio-lib-cloudmanager/compare/2.0.0...3.0.0) (2022-12-16) | ||
@@ -4,0 +16,0 @@ |
{ | ||
"name": "@adobe/aio-lib-cloudmanager", | ||
"version": "3.0.0", | ||
"version": "3.1.0", | ||
"description": "Adobe I/O Cloud Manager Library", | ||
@@ -5,0 +5,0 @@ "repository": { |
173
README.md
@@ -115,2 +115,8 @@ <!-- | ||
</dd> | ||
<dt><a href="#ContentSet">ContentSet</a> : <code>object</code></dt> | ||
<dd><p>A representation of a ContentSet custom</p> | ||
</dd> | ||
<dt><a href="#ContentFlow">ContentFlow</a> : <code>object</code></dt> | ||
<dd><p>The Content Flow Execution</p> | ||
</dd> | ||
<dt><a href="#LogOptionRepresentation">LogOptionRepresentation</a> : <code>object</code></dt> | ||
@@ -149,5 +155,9 @@ <dd></dd> | ||
* [.advanceCurrentExecution(programId, pipelineId)](#CloudManagerAPI+advanceCurrentExecution) ⇒ <code>Promise.<object></code> | ||
* [.cancelContentFlow(programId, contentFlowId)](#CloudManagerAPI+cancelContentFlow) ⇒ <code>Promise.<object></code> | ||
* [.cancelCurrentExecution(programId, pipelineId)](#CloudManagerAPI+cancelCurrentExecution) ⇒ <code>Promise.<object></code> | ||
* [.createContentFlow(programId, environmentId, contentFlow)](#CloudManagerAPI+createContentFlow) ⇒ [<code>Promise.<ContentFlow></code>](#ContentFlow) | ||
* [.createContentSet(programId, contentSet)](#CloudManagerAPI+createContentSet) ⇒ [<code>Promise.<ContentSet></code>](#ContentSet) | ||
* [.createExecution(programId, pipelineId, mode)](#CloudManagerAPI+createExecution) ⇒ [<code>Promise.<PipelineExecution></code>](#PipelineExecution) | ||
* [.createIpAllowlist(programId, name, cidrBlocks)](#CloudManagerAPI+createIpAllowlist) ⇒ [<code>Promise.<IPAllowedList></code>](#IPAllowedList) | ||
* [.deleteContentSet(programId, contentSetId)](#CloudManagerAPI+deleteContentSet) ⇒ <code>Promise.<object></code> | ||
* [.deleteEnvironment(programId, environmentId)](#CloudManagerAPI+deleteEnvironment) ⇒ <code>Promise.<object></code> | ||
@@ -158,2 +168,4 @@ * [.deleteIpAllowlist(programId, ipAllowlistId)](#CloudManagerAPI+deleteIpAllowlist) ⇒ <code>Promise.<object></code> | ||
* [.downloadLogs(programId, environmentId, service, name, days, outputDirectory)](#CloudManagerAPI+downloadLogs) ⇒ <code>Promise.<Array.<DownloadedLog>></code> | ||
* [.getContentFlow(programId, contentFlowId)](#CloudManagerAPI+getContentFlow) ⇒ [<code>Promise.<ContentFlow></code>](#ContentFlow) | ||
* [.getContentSet(programId, contentSetId)](#CloudManagerAPI+getContentSet) ⇒ [<code>Promise.<ContentSet></code>](#ContentSet) | ||
* [.getCurrentExecution(programId, pipelineId)](#CloudManagerAPI+getCurrentExecution) ⇒ [<code>Promise.<PipelineExecution></code>](#PipelineExecution) | ||
@@ -169,2 +181,4 @@ * [.getDeveloperConsoleUrl(programId, environmentId)](#CloudManagerAPI+getDeveloperConsoleUrl) ⇒ <code>Promise.<string></code> | ||
* [.listAvailableLogOptions(programId, environmentId)](#CloudManagerAPI+listAvailableLogOptions) ⇒ <code>Promise.<Array.<LogOptionRepresentation>></code> | ||
* [.listContentFlows(programId)](#CloudManagerAPI+listContentFlows) ⇒ <code>Promise.<Array.<ContentFlow>></code> | ||
* [.listContentSets(programId)](#CloudManagerAPI+listContentSets) ⇒ <code>Promise.<Array.<ContentSet>></code> | ||
* [.listEnvironments(programId)](#CloudManagerAPI+listEnvironments) ⇒ <code>Promise.<Array.<Environment>></code> | ||
@@ -180,2 +194,3 @@ * [.listExecutions(programId, pipelineId, limit)](#CloudManagerAPI+listExecutions) ⇒ <code>Promise.<Array.<PipelineExecution>></code> | ||
* [.tailExecutionStepLog(programId, pipelineId, action, logFile, outputStream)](#CloudManagerAPI+tailExecutionStepLog) ⇒ [<code>Promise.<PipelineExecutionStepState></code>](#PipelineExecutionStepState) | ||
* [.updateContentSet(programId, contentSetId, updatedContentSet)](#CloudManagerAPI+updateContentSet) ⇒ [<code>Promise.<ContentSet></code>](#ContentSet) | ||
* [.updateIpAllowlist(programId, ipAllowlistId, cidrBlocks)](#CloudManagerAPI+updateIpAllowlist) ⇒ <code>Promise.<object></code> | ||
@@ -236,2 +251,16 @@ * [.updatePipeline(programId, pipelineId, changes)](#CloudManagerAPI+updatePipeline) ⇒ [<code>Promise.<Pipeline></code>](#Pipeline) | ||
<a name="CloudManagerAPI+cancelContentFlow"></a> | ||
### cloudManagerAPI.cancelContentFlow(programId, contentFlowId) ⇒ <code>Promise.<object></code> | ||
Cancel a content flow | ||
Cancels an in progress flow | ||
**Kind**: instance method of [<code>CloudManagerAPI</code>](#CloudManagerAPI) | ||
**Returns**: <code>Promise.<object></code> - a truthy value | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| programId | <code>string</code> | the program id | | ||
| contentFlowId | <code>string</code> | the flow id | | ||
<a name="CloudManagerAPI+cancelCurrentExecution"></a> | ||
@@ -250,2 +279,29 @@ | ||
<a name="CloudManagerAPI+createContentFlow"></a> | ||
### cloudManagerAPI.createContentFlow(programId, environmentId, contentFlow) ⇒ [<code>Promise.<ContentFlow></code>](#ContentFlow) | ||
Create content Set Flow for environment | ||
**Kind**: instance method of [<code>CloudManagerAPI</code>](#CloudManagerAPI) | ||
**Returns**: [<code>Promise.<ContentFlow></code>](#ContentFlow) - the created content flow representation | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| programId | <code>string</code> | The program id | | ||
| environmentId | <code>string</code> | The environment id | | ||
| contentFlow | [<code>ContentFlow</code>](#ContentFlow) | The body of the contentFlow | | ||
<a name="CloudManagerAPI+createContentSet"></a> | ||
### cloudManagerAPI.createContentSet(programId, contentSet) ⇒ [<code>Promise.<ContentSet></code>](#ContentSet) | ||
Create a Content set | ||
**Kind**: instance method of [<code>CloudManagerAPI</code>](#CloudManagerAPI) | ||
**Returns**: [<code>Promise.<ContentSet></code>](#ContentSet) - the created content set | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| programId | <code>string</code> | the program id | | ||
| contentSet | <code>string</code> | the body of the content set. | | ||
<a name="CloudManagerAPI+createExecution"></a> | ||
@@ -279,2 +335,15 @@ | ||
<a name="CloudManagerAPI+deleteContentSet"></a> | ||
### cloudManagerAPI.deleteContentSet(programId, contentSetId) ⇒ <code>Promise.<object></code> | ||
Delete Content Set | ||
**Kind**: instance method of [<code>CloudManagerAPI</code>](#CloudManagerAPI) | ||
**Returns**: <code>Promise.<object></code> - a truthy value | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| programId | <code>string</code> | the program id | | ||
| contentSetId | <code>string</code> | the content set id | | ||
<a name="CloudManagerAPI+deleteEnvironment"></a> | ||
@@ -348,2 +417,28 @@ | ||
<a name="CloudManagerAPI+getContentFlow"></a> | ||
### cloudManagerAPI.getContentFlow(programId, contentFlowId) ⇒ [<code>Promise.<ContentFlow></code>](#ContentFlow) | ||
Get Content Flow | ||
**Kind**: instance method of [<code>CloudManagerAPI</code>](#CloudManagerAPI) | ||
**Returns**: [<code>Promise.<ContentFlow></code>](#ContentFlow) - the Content Flow | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| programId | <code>string</code> | The program id | | ||
| contentFlowId | <code>string</code> | the content flow id | | ||
<a name="CloudManagerAPI+getContentSet"></a> | ||
### cloudManagerAPI.getContentSet(programId, contentSetId) ⇒ [<code>Promise.<ContentSet></code>](#ContentSet) | ||
Get Content Set | ||
**Kind**: instance method of [<code>CloudManagerAPI</code>](#CloudManagerAPI) | ||
**Returns**: [<code>Promise.<ContentSet></code>](#ContentSet) - the content set | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| programId | <code>string</code> | the program id | | ||
| contentSetId | <code>string</code> | the content set id | | ||
<a name="CloudManagerAPI+getCurrentExecution"></a> | ||
@@ -488,2 +583,26 @@ | ||
<a name="CloudManagerAPI+listContentFlows"></a> | ||
### cloudManagerAPI.listContentFlows(programId) ⇒ <code>Promise.<Array.<ContentFlow>></code> | ||
List content flows for program | ||
**Kind**: instance method of [<code>CloudManagerAPI</code>](#CloudManagerAPI) | ||
**Returns**: <code>Promise.<Array.<ContentFlow>></code> - an array of content flows | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| programId | <code>string</code> | The program id | | ||
<a name="CloudManagerAPI+listContentSets"></a> | ||
### cloudManagerAPI.listContentSets(programId) ⇒ <code>Promise.<Array.<ContentSet>></code> | ||
List Content Sets for program | ||
**Kind**: instance method of [<code>CloudManagerAPI</code>](#CloudManagerAPI) | ||
**Returns**: <code>Promise.<Array.<ContentSet>></code> - list of the content sets for the program | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| programId | <code>string</code> | the program id | | ||
<a name="CloudManagerAPI+listEnvironments"></a> | ||
@@ -622,2 +741,18 @@ | ||
<a name="CloudManagerAPI+updateContentSet"></a> | ||
### cloudManagerAPI.updateContentSet(programId, contentSetId, updatedContentSet) ⇒ [<code>Promise.<ContentSet></code>](#ContentSet) | ||
Update the content set definition. | ||
The operation is a PUT, so the entire body has to be provided. | ||
**Kind**: instance method of [<code>CloudManagerAPI</code>](#CloudManagerAPI) | ||
**Returns**: [<code>Promise.<ContentSet></code>](#ContentSet) - the updated content set | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| programId | <code>string</code> | The program id | | ||
| contentSetId | <code>string</code> | The content set id | | ||
| updatedContentSet | <code>string</code> | the body (JSON format) | | ||
<a name="CloudManagerAPI+updateIpAllowlist"></a> | ||
@@ -860,2 +995,40 @@ | ||
<a name="ContentSet"></a> | ||
## ContentSet : <code>object</code> | ||
A representation of a ContentSet custom | ||
**Kind**: global typedef | ||
**Properties** | ||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| id | <code>string</code> | Identifier of the Content Set | | ||
| name | <code>string</code> | The name of the content set | | ||
| paths | <code>Array.<ContentSetPath></code> | Included asset paths | | ||
| programId | <code>string</code> | Identifier of the program. Unique within the space. | | ||
| createdAt | <code>string</code> | Create date | | ||
| updatedAt | <code>string</code> | Update date | | ||
<a name="ContentFlow"></a> | ||
## ContentFlow : <code>object</code> | ||
The Content Flow Execution | ||
**Kind**: global typedef | ||
**Properties** | ||
| Name | Type | Description | | ||
| --- | --- | --- | | ||
| contentSetId | <code>string</code> | The content set id | | ||
| contentSetName | <code>string</code> | The content set name | | ||
| srcEnvironmentId | <code>string</code> | Source environment id | | ||
| srcEnvironmentName | <code>string</code> | Source environment name | | ||
| destEnvironmentId | <code>string</code> | Destination environment id | | ||
| destEnvironmentName | <code>string</code> | Destination environment name | | ||
| tier | <code>string</code> | The tier, for example author | | ||
| status | <code>string</code> | Status of the flows | | ||
| destProgramId | <code>string</code> | Destination program id | | ||
| resultDetails | <code>undefined</code> | Details of this content flow result | | ||
<a name="LogOptionRepresentation"></a> | ||
@@ -862,0 +1035,0 @@ |
@@ -37,2 +37,5 @@ /* | ||
commerceLogs: 'http://ns.adobe.com/adobecloud/rel/commerceCommandExecution/logs', | ||
contentSet: 'http://ns.adobe.com/adobecloud/rel/contentSet', | ||
contentSets: 'http://ns.adobe.com/adobecloud/rel/contentSets', | ||
contentFlows: 'http://ns.adobe.com/adobecloud/rel/contentFlows', | ||
}, | ||
@@ -39,0 +42,0 @@ config: { |
157
src/index.js
@@ -1291,2 +1291,159 @@ /* | ||
} | ||
async _listContentSets (url) { | ||
return this._get(url, codes.ERROR_LIST_CONTENTSETS).then(res => { | ||
return res.json() | ||
}, e => { | ||
throw e | ||
}) | ||
} | ||
async _listContentFlows (url) { | ||
return this._get(url, codes.ERROR_LIST_CONTENTFLOWS).then(res => { | ||
return res.json() | ||
}, e => { | ||
throw e | ||
}) | ||
} | ||
/** | ||
* Create a Content set | ||
* | ||
* @param {string} programId - the program id | ||
* @param {string} contentSet - the body of the content set. | ||
* @returns {Promise<ContentSet>} the created content set | ||
*/ | ||
async createContentSet (programId, contentSet) { | ||
const url = `/api/program/${programId}/contentSets` | ||
return this._post(url, contentSet, codes.ERROR_CREATE_CONTENTSET).then(async (res) => { | ||
return halfred.parse(await res.json()) | ||
}, e => { | ||
throw e | ||
}) | ||
} | ||
/** | ||
* Delete Content Set | ||
* | ||
* @param {string} programId - the program id | ||
* @param {string} contentSetId - the content set id | ||
* @returns {Promise<object>} a truthy value | ||
*/ | ||
async deleteContentSet (programId, contentSetId) { | ||
const url = `/api/program/${programId}/contentSet/${contentSetId}` | ||
return this._delete(url, codes.ERROR_DELETE_CONTENTSET).then(() => { | ||
return {} | ||
}, e => { | ||
throw e | ||
}) | ||
} | ||
/** | ||
* Get Content Set | ||
* | ||
* @param {string} programId - the program id | ||
* @param {string} contentSetId - the content set id | ||
* @returns {Promise<ContentSet>} the content set | ||
*/ | ||
async getContentSet (programId, contentSetId) { | ||
const url = `/api/program/${programId}/contentSet/${contentSetId}` | ||
return this._get(url, codes.ERROR_GET_CONTENTSET).then(res => { | ||
return res.json() | ||
}, e => { | ||
throw e | ||
}) | ||
} | ||
/** | ||
* List Content Sets for program | ||
* | ||
* @param {string} programId - the program id | ||
* @returns {Promise<ContentSet[]>} list of the content sets for the program | ||
*/ | ||
async listContentSets (programId) { | ||
const url = `/api/program/${programId}/contentSets` | ||
const result = await this._listContentSets(url) | ||
return (result && halfred.parse(result).embeddedArray('contentSets')) || [] | ||
} | ||
/** | ||
* Update the content set definition. | ||
* | ||
* The operation is a PUT, so the entire body has to be provided. | ||
* | ||
* @param {string} programId The program id | ||
* @param {string} contentSetId The content set id | ||
* @param {string} updatedContentSet the body (JSON format) | ||
* @returns {Promise<ContentSet>} the updated content set | ||
*/ | ||
async updateContentSet (programId, contentSetId, updatedContentSet) { | ||
const url = `/api/program/${programId}/contentSet/${contentSetId}` | ||
return this._put(url, updatedContentSet, codes.ERROR_UPDATE_CONTENTSET).then(async res => { | ||
return halfred.parse(await res.json()) | ||
}, e => { | ||
throw e | ||
}) | ||
} | ||
/** | ||
* Create content Set Flow for environment | ||
* | ||
* @param {string} programId The program id | ||
* @param {string} environmentId The environment id | ||
* @param {ContentFlow} contentFlow The body of the contentFlow | ||
* @returns {Promise<ContentFlow>} the created content flow representation | ||
*/ | ||
async createContentFlow (programId, environmentId, contentFlow) { | ||
const url = `/api/program/${programId}/environment/${environmentId}/contentFlow` | ||
return this._post(url, contentFlow, codes.ERROR_CREATE_CONTENTFLOW).then(async res => { | ||
return halfred.parse(await res.json()) | ||
}, e => { | ||
throw e | ||
}) | ||
} | ||
/** | ||
* Get Content Flow | ||
* | ||
* @param {string} programId The program id | ||
* @param {string} contentFlowId the content flow id | ||
* @returns {Promise<ContentFlow>} the Content Flow | ||
*/ | ||
async getContentFlow (programId, contentFlowId) { | ||
const url = `/api/program/${programId}/contentFlow/${contentFlowId}` | ||
return this._get(url, codes.ERROR_GET_CONTENTFLOW).then(res => { | ||
return res.json() | ||
}, e => { | ||
throw e | ||
}) | ||
} | ||
/** | ||
* List content flows for program | ||
* | ||
* @param {string} programId The program id | ||
* @returns {Promise<ContentFlow[]>} an array of content flows | ||
*/ | ||
async listContentFlows (programId) { | ||
const url = `/api/program/${programId}/contentFlows` | ||
const result = await this._listContentFlows(url) | ||
return (result && halfred.parse(result).embeddedArray('contentFlows')) || [] | ||
} | ||
/** | ||
* Cancel a content flow | ||
* Cancels an in progress flow | ||
* | ||
* @param {string} programId the program id | ||
* @param {string} contentFlowId the flow id | ||
* @returns {Promise<object>} a truthy value | ||
*/ | ||
async cancelContentFlow (programId, contentFlowId) { | ||
const url = `/api/program/${programId}/contentFlow/${contentFlowId}` | ||
return this._delete(url, codes.ERROR_CANCEL_CONTENTFLOW).then(() => { | ||
return {} | ||
}, e => { | ||
throw e | ||
}) | ||
} | ||
} | ||
@@ -1293,0 +1450,0 @@ |
@@ -115,1 +115,10 @@ /* | ||
E('ERROR_NO_LOG_URL', 'Could not get the log url for environment: %s') | ||
E('ERROR_CREATE_CONTENTSET', 'Unable to create content set for program: %s') | ||
E('ERROR_DELETE_CONTENTSET', 'Unable to delete content set: %s') | ||
E('ERROR_GET_CONTENTSET', 'Unable to get content set for program: %s') | ||
E('ERROR_UPDATE_CONTENTSET', 'Unable to update content set %s') | ||
E('ERROR_LIST_CONTENTSETS', 'Unable to list content sets for program: %s') | ||
E('ERROR_CREATE_CONTENTFLOW', 'Unable to create content flow for program %s') | ||
E('ERROR_LIST_CONTENTFLOWS', 'Unable to get content flows for program: %s') | ||
E('ERROR_GET_CONTENTFLOW', 'Unable to get content flow for %s') | ||
E('ERROR_CANCEL_CONTENTFLOW', 'Unable to cancel content flow for %s') |
@@ -157,2 +157,32 @@ /* | ||
/** | ||
* A representation of a ContentSet custom | ||
* | ||
* @typedef {object} ContentSet | ||
* @property {string} id - Identifier of the Content Set | ||
* @property {string} name - The name of the content set | ||
* @property {ContentSetPath[]} paths - Included asset paths | ||
* @property {string} programId - Identifier of the program. Unique within the space. | ||
* @property {string} createdAt - Create date | ||
* @property {string} updatedAt - Update date | ||
*/ | ||
/** | ||
* The Content Flow Execution | ||
* | ||
* @typedef {object} ContentFlow | ||
* @property {string} contentSetId - The content set id | ||
* @property {string} contentSetName - The content set name | ||
* @property {string} srcEnvironmentId - Source environment id | ||
* @property {string} srcEnvironmentName - Source environment name | ||
* @property {string} destEnvironmentId - Destination environment id | ||
* @property {string} destEnvironmentName - Destination environment name | ||
* @property {string} tier - The tier, for example author | ||
* @property {string} status - Status of the flows | ||
* @property {string} destProgramId - Destination program id | ||
* @property {undefined} resultDetails - Details of this content flow result | ||
*/ | ||
/** | ||
* @typedef {object} LogOptionRepresentation | ||
@@ -159,0 +189,0 @@ * @property {string} service - Name of the service in environment. Example: author |
@@ -17,3 +17,3 @@ /* | ||
const desiredDefinitions = ['EmbeddedProgram', 'Pipeline', 'PipelinePhase', 'PipelineExecution', 'PipelineStepMetrics', 'Metric', 'Environment', | ||
'LogOptionRepresentation', 'Variable', 'PipelineExecutionStepState', 'IPAllowedListBinding', 'IPAllowedList'] | ||
'LogOptionRepresentation', 'Variable', 'PipelineExecutionStepState', 'IPAllowedListBinding', 'IPAllowedList', 'ContentSet', 'ContentFlow'] | ||
@@ -20,0 +20,0 @@ const cleanName = value => value.replace(/\W/g, '') |
110
types.d.ts
@@ -294,2 +294,68 @@ /** | ||
removeIpAllowlistBinding(programId: string, ipAllowlistId: string, environmentId: string, service: string): Promise<object>; | ||
/** | ||
* Create a Content set | ||
* @param programId - the program id | ||
* @param contentSet - the body of the content set. | ||
* @returns the created content set | ||
*/ | ||
createContentSet(programId: string, contentSet: string): Promise<ContentSet>; | ||
/** | ||
* Delete Content Set | ||
* @param programId - the program id | ||
* @param contentSetId - the content set id | ||
* @returns a truthy value | ||
*/ | ||
deleteContentSet(programId: string, contentSetId: string): Promise<object>; | ||
/** | ||
* Get Content Set | ||
* @param programId - the program id | ||
* @param contentSetId - the content set id | ||
* @returns the content set | ||
*/ | ||
getContentSet(programId: string, contentSetId: string): Promise<ContentSet>; | ||
/** | ||
* List Content Sets for program | ||
* @param programId - the program id | ||
* @returns list of the content sets for the program | ||
*/ | ||
listContentSets(programId: string): Promise<ContentSet[]>; | ||
/** | ||
* Update the content set definition. | ||
* | ||
* The operation is a PUT, so the entire body has to be provided. | ||
* @param programId - The program id | ||
* @param contentSetId - The content set id | ||
* @param updatedContentSet - the body (JSON format) | ||
* @returns the updated content set | ||
*/ | ||
updateContentSet(programId: string, contentSetId: string, updatedContentSet: string): Promise<ContentSet>; | ||
/** | ||
* Create content Set Flow for environment | ||
* @param programId - The program id | ||
* @param environmentId - The environment id | ||
* @param contentFlow - The body of the contentFlow | ||
* @returns the created content flow representation | ||
*/ | ||
createContentFlow(programId: string, environmentId: string, contentFlow: ContentFlow): Promise<ContentFlow>; | ||
/** | ||
* Get Content Flow | ||
* @param programId - The program id | ||
* @param contentFlowId - the content flow id | ||
* @returns the Content Flow | ||
*/ | ||
getContentFlow(programId: string, contentFlowId: string): Promise<ContentFlow>; | ||
/** | ||
* List content flows for program | ||
* @param programId - The program id | ||
* @returns an array of content flows | ||
*/ | ||
listContentFlows(programId: string): Promise<ContentFlow[]>; | ||
/** | ||
* Cancel a content flow | ||
* Cancels an in progress flow | ||
* @param programId - the program id | ||
* @param contentFlowId - the flow id | ||
* @returns a truthy value | ||
*/ | ||
cancelContentFlow(programId: string, contentFlowId: string): Promise<object>; | ||
} | ||
@@ -496,2 +562,46 @@ | ||
/** | ||
* A representation of a ContentSet custom | ||
* @property id - Identifier of the Content Set | ||
* @property name - The name of the content set | ||
* @property paths - Included asset paths | ||
* @property programId - Identifier of the program. Unique within the space. | ||
* @property createdAt - Create date | ||
* @property updatedAt - Update date | ||
*/ | ||
declare type ContentSet = { | ||
id: string; | ||
name: string; | ||
paths: ContentSetPath[]; | ||
programId: string; | ||
createdAt: string; | ||
updatedAt: string; | ||
}; | ||
/** | ||
* The Content Flow Execution | ||
* @property contentSetId - The content set id | ||
* @property contentSetName - The content set name | ||
* @property srcEnvironmentId - Source environment id | ||
* @property srcEnvironmentName - Source environment name | ||
* @property destEnvironmentId - Destination environment id | ||
* @property destEnvironmentName - Destination environment name | ||
* @property tier - The tier, for example author | ||
* @property status - Status of the flows | ||
* @property destProgramId - Destination program id | ||
* @property resultDetails - Details of this content flow result | ||
*/ | ||
declare type ContentFlow = { | ||
contentSetId: string; | ||
contentSetName: string; | ||
srcEnvironmentId: string; | ||
srcEnvironmentName: string; | ||
destEnvironmentId: string; | ||
destEnvironmentName: string; | ||
tier: string; | ||
status: string; | ||
destProgramId: string; | ||
resultDetails: undefined; | ||
}; | ||
/** | ||
* @property service - Name of the service in environment. Example: author | ||
@@ -498,0 +608,0 @@ * @property name - Name of the log for service in environment. Example: aemerror |
Sorry, the diff of this file is not supported yet
1947159
88
12077
1119