/** * Jira Software Cloud API * Jira Software Cloud REST API documentation * * The version of the OpenAPI document: 1001.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { BodiesSubmitDeployments } from '../models'; export interface DeleteDeploymentByKeyRequest { Authorization: string; pipelineId: string; environmentId: string; deploymentSequenceNumber: number; _updateSequenceNumber?: number; } export interface DeleteDeploymentsByPropertyRequest { Authorization: string; _updateSequenceNumber?: number; } export interface GetDeploymentByKeyRequest { Authorization: string; pipelineId: string; environmentId: string; deploymentSequenceNumber: number; } export interface SubmitDeploymentsRequest { Authorization: string; BodiesSubmitDeployments: BodiesSubmitDeployments; } /** * no description */ export declare class DeploymentsApi extends runtime.BaseAPI { /** * Delete the currently stored deployment data for the given `pipelineId`, `environmentId` and `deploymentSequenceNumber` combination. Deletion is performed asynchronously. The `getDeploymentByKey` operation can be used to confirm that data has been deleted successfully (if needed). Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the \'DELETE\' scope. * Delete a deployment by key */ deleteDeploymentByKeyRaw(requestParameters: DeleteDeploymentByKeyRequest): Promise>; /** * Delete the currently stored deployment data for the given `pipelineId`, `environmentId` and `deploymentSequenceNumber` combination. Deletion is performed asynchronously. The `getDeploymentByKey` operation can be used to confirm that data has been deleted successfully (if needed). Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the \'DELETE\' scope. * Delete a deployment by key */ deleteDeploymentByKey(requestParameters: DeleteDeploymentByKeyRequest): Promise; /** * Bulk delete all deployments that match the given request. In addition to the optional `_updateSequenceNumber`, one or more query params must be supplied to specify the Properties to delete by. If more than one Property is provided, data will be deleted that matches ALL of the Properties (i.e. treated as AND). See the documentation for the `submitDeployments` operation for more details. Example operation: DELETE /bulkByProperties?accountId=account-123&createdBy=user-456 Deletion is performed asynchronously. The `getDeploymentByKey` operation can be used to confirm that data has been deleted successfully (if needed). Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the \'DELETE\' scope. * Delete deployments by Property */ deleteDeploymentsByPropertyRaw(requestParameters: DeleteDeploymentsByPropertyRequest): Promise>; /** * Bulk delete all deployments that match the given request. In addition to the optional `_updateSequenceNumber`, one or more query params must be supplied to specify the Properties to delete by. If more than one Property is provided, data will be deleted that matches ALL of the Properties (i.e. treated as AND). See the documentation for the `submitDeployments` operation for more details. Example operation: DELETE /bulkByProperties?accountId=account-123&createdBy=user-456 Deletion is performed asynchronously. The `getDeploymentByKey` operation can be used to confirm that data has been deleted successfully (if needed). Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the \'DELETE\' scope. * Delete deployments by Property */ deleteDeploymentsByProperty(requestParameters: DeleteDeploymentsByPropertyRequest): Promise; /** * Retrieve the currently stored deployment data for the given `pipelineId`, `environmentId` and `deploymentSequenceNumber` combination. The result will be what is currently stored, ignoring any pending updates or deletes. Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the \'READ\' scope. * Get a deployment by key */ getDeploymentByKeyRaw(requestParameters: GetDeploymentByKeyRequest): Promise>; /** * Retrieve the currently stored deployment data for the given `pipelineId`, `environmentId` and `deploymentSequenceNumber` combination. The result will be what is currently stored, ignoring any pending updates or deletes. Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the \'READ\' scope. * Get a deployment by key */ getDeploymentByKey(requestParameters: GetDeploymentByKeyRequest): Promise; /** * Update / insert deployment data. Deployments are identified by the combination of `pipelineId`, `environmentId` and `deploymentSequenceNumber`, and existing deployment data for the same deployment will be replaced if it exists and the `updateSequenceNumber` of existing data is less than the incoming data. Submissions are processed asynchronously. Submitted data will eventually be available in Jira. Most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The `getDeploymentByKey` operation can be used to confirm that data has been stored successfully (if needed). In the case of multiple deployments being submitted in one request, each is validated individually prior to submission. Details of which deployments failed submission (if any) are available in the response object. Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the \'WRITE\' scope. * Submit deployment data */ submitDeploymentsRaw(requestParameters: SubmitDeploymentsRequest): Promise>; /** * Update / insert deployment data. Deployments are identified by the combination of `pipelineId`, `environmentId` and `deploymentSequenceNumber`, and existing deployment data for the same deployment will be replaced if it exists and the `updateSequenceNumber` of existing data is less than the incoming data. Submissions are processed asynchronously. Submitted data will eventually be available in Jira. Most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The `getDeploymentByKey` operation can be used to confirm that data has been stored successfully (if needed). In the case of multiple deployments being submitted in one request, each is validated individually prior to submission. Details of which deployments failed submission (if any) are available in the response object. Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the \'WRITE\' scope. * Submit deployment data */ submitDeployments(requestParameters: SubmitDeploymentsRequest): Promise; }