/** * 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 { BodiesSubmitBuilds, InlineResponse2021 } from '../models'; export interface DeleteBuildByKeyRequest { Authorization: string; pipelineId: string; buildNumber: number; _updateSequenceNumber?: number; } export interface DeleteBuildsByPropertyRequest { Authorization: string; _updateSequenceNumber?: number; } export interface GetBuildByKeyRequest { Authorization: string; pipelineId: string; buildNumber: number; } export interface SubmitBuildsRequest { Authorization: string; BodiesSubmitBuilds: BodiesSubmitBuilds; } /** * no description */ export declare class BuildsApi extends runtime.BaseAPI { /** * Delete the build data currently stored for the given `pipelineId` and `buildNumber` combination. Deletion is performed asynchronously. The `getBuildByKey` operation can be used to confirm that data has been deleted successfully (if needed). Only apps that define the `jiraBuildInfoProvider` module can access this resource. This resource requires the \'DELETE\' scope. * Delete a build by key */ deleteBuildByKeyRaw(requestParameters: DeleteBuildByKeyRequest): Promise>; /** * Delete the build data currently stored for the given `pipelineId` and `buildNumber` combination. Deletion is performed asynchronously. The `getBuildByKey` operation can be used to confirm that data has been deleted successfully (if needed). Only apps that define the `jiraBuildInfoProvider` module can access this resource. This resource requires the \'DELETE\' scope. * Delete a build by key */ deleteBuildByKey(requestParameters: DeleteBuildByKeyRequest): Promise; /** * Bulk delete all builds data that match the given request. In addition to the optional `_updateSequenceNumber`, one or more query params must be supplied to specify Properties to delete by. If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND). See the documentation for the `submitBuilds` operation for more details. e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345 Deletion is performed asynchronously. The `getBuildByKey` operation can be used to confirm that data has been deleted successfully (if needed). Only apps that define the `jiraBuildInfoProvider` module can access this resource. This resource requires the \'DELETE\' scope. * Delete builds by Property */ deleteBuildsByPropertyRaw(requestParameters: DeleteBuildsByPropertyRequest): Promise>; /** * Bulk delete all builds data that match the given request. In addition to the optional `_updateSequenceNumber`, one or more query params must be supplied to specify Properties to delete by. If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND). See the documentation for the `submitBuilds` operation for more details. e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345 Deletion is performed asynchronously. The `getBuildByKey` operation can be used to confirm that data has been deleted successfully (if needed). Only apps that define the `jiraBuildInfoProvider` module can access this resource. This resource requires the \'DELETE\' scope. * Delete builds by Property */ deleteBuildsByProperty(requestParameters: DeleteBuildsByPropertyRequest): Promise; /** * Retrieve the currently stored build data for the given `pipelineId` and `buildNumber` combination. The result will be what is currently stored, ignoring any pending updates or deletes. Only apps that define the `jiraBuildInfoProvider` module can access this resource. This resource requires the \'READ\' scope. * Get a build by key */ getBuildByKeyRaw(requestParameters: GetBuildByKeyRequest): Promise>; /** * Retrieve the currently stored build data for the given `pipelineId` and `buildNumber` combination. The result will be what is currently stored, ignoring any pending updates or deletes. Only apps that define the `jiraBuildInfoProvider` module can access this resource. This resource requires the \'READ\' scope. * Get a build by key */ getBuildByKey(requestParameters: GetBuildByKeyRequest): Promise; /** * Update / insert builds data. Builds are identified by the combination of `pipelineId` and `buildNumber`, and existing build data for the same build will be replaced if it exists and the `updateSequenceNumber` of the existing data is less than the incoming data. Submissions are performed 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 `getBuildByKey` operation can be used to confirm that data has been stored successfully (if needed). In the case of multiple builds being submitted in one request, each is validated individually prior to submission. Details of which build failed submission (if any) are available in the response object. Only apps that define the `jiraBuildInfoProvider` module can access this resource. This resource requires the \'WRITE\' scope. * Submit build data */ submitBuildsRaw(requestParameters: SubmitBuildsRequest): Promise>; /** * Update / insert builds data. Builds are identified by the combination of `pipelineId` and `buildNumber`, and existing build data for the same build will be replaced if it exists and the `updateSequenceNumber` of the existing data is less than the incoming data. Submissions are performed 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 `getBuildByKey` operation can be used to confirm that data has been stored successfully (if needed). In the case of multiple builds being submitted in one request, each is validated individually prior to submission. Details of which build failed submission (if any) are available in the response object. Only apps that define the `jiraBuildInfoProvider` module can access this resource. This resource requires the \'WRITE\' scope. * Submit build data */ submitBuilds(requestParameters: SubmitBuildsRequest): Promise; }