system-initiative-api-client
Version:
TypeScript/JavaScript SDK for the System Initiative Public API
956 lines • 359 kB
JavaScript
/* tslint:disable */
/* eslint-disable */
/**
* System Initiative API
* The API Server for interacting with a System Initiative workspace
*
* The version of the OpenAPI document: 1.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 globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
// @ts-ignore
import { BASE_PATH, BaseAPI, operationServerMap } from './base';
/**
* @export
* @enum {string}
*/
export var SchemaVariantFuncKindOneOfKindEnum;
(function (SchemaVariantFuncKindOneOfKindEnum) {
SchemaVariantFuncKindOneOfKindEnum["ACTION"] = "action";
})(SchemaVariantFuncKindOneOfKindEnum || (SchemaVariantFuncKindOneOfKindEnum = {}));
/**
* @export
* @enum {string}
*/
export var SchemaVariantFuncKindOneOf1KindEnum;
(function (SchemaVariantFuncKindOneOf1KindEnum) {
SchemaVariantFuncKindOneOf1KindEnum["MANAGEMENT"] = "management";
})(SchemaVariantFuncKindOneOf1KindEnum || (SchemaVariantFuncKindOneOf1KindEnum = {}));
/**
* @export
* @enum {string}
*/
export var SchemaVariantFuncKindOneOf2KindEnum;
(function (SchemaVariantFuncKindOneOf2KindEnum) {
SchemaVariantFuncKindOneOf2KindEnum["OTHER"] = "other";
})(SchemaVariantFuncKindOneOf2KindEnum || (SchemaVariantFuncKindOneOf2KindEnum = {}));
/**
* ActionsApi - axios parameter creator
* @export
*/
export const ActionsApiAxiosParamCreator = function (configuration) {
return {
/**
*
* @summary Remove queued action
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} actionId Action identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelAction: async (workspaceId, changeSetId, actionId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('cancelAction', 'workspaceId', workspaceId);
// verify required parameter 'changeSetId' is not null or undefined
assertParamExists('cancelAction', 'changeSetId', changeSetId);
// verify required parameter 'actionId' is not null or undefined
assertParamExists('cancelAction', 'actionId', actionId);
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/actions/{action_id}/cancel`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
.replace(`{${"action_id"}}`, encodeURIComponent(String(actionId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary List queued actions
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getActions: async (workspaceId, changeSetId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('getActions', 'workspaceId', workspaceId);
// verify required parameter 'changeSetId' is not null or undefined
assertParamExists('getActions', 'changeSetId', changeSetId);
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/actions`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Put action on-hold
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} actionId Action identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putOnHold: async (workspaceId, changeSetId, actionId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('putOnHold', 'workspaceId', workspaceId);
// verify required parameter 'changeSetId' is not null or undefined
assertParamExists('putOnHold', 'changeSetId', changeSetId);
// verify required parameter 'actionId' is not null or undefined
assertParamExists('putOnHold', 'actionId', actionId);
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/actions/{action_id}/put_on_hold`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
.replace(`{${"action_id"}}`, encodeURIComponent(String(actionId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Retry action
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} actionId Action identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retryAction: async (workspaceId, changeSetId, actionId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('retryAction', 'workspaceId', workspaceId);
// verify required parameter 'changeSetId' is not null or undefined
assertParamExists('retryAction', 'changeSetId', changeSetId);
// verify required parameter 'actionId' is not null or undefined
assertParamExists('retryAction', 'actionId', actionId);
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/actions/{action_id}/retry`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
.replace(`{${"action_id"}}`, encodeURIComponent(String(actionId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
/**
* ActionsApi - functional programming interface
* @export
*/
export const ActionsApiFp = function (configuration) {
const localVarAxiosParamCreator = ActionsApiAxiosParamCreator(configuration);
return {
/**
*
* @summary Remove queued action
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} actionId Action identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async cancelAction(workspaceId, changeSetId, actionId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAction(workspaceId, changeSetId, actionId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ActionsApi.cancelAction']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary List queued actions
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getActions(workspaceId, changeSetId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.getActions(workspaceId, changeSetId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ActionsApi.getActions']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Put action on-hold
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} actionId Action identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async putOnHold(workspaceId, changeSetId, actionId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.putOnHold(workspaceId, changeSetId, actionId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ActionsApi.putOnHold']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Retry action
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} actionId Action identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async retryAction(workspaceId, changeSetId, actionId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.retryAction(workspaceId, changeSetId, actionId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ActionsApi.retryAction']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
};
};
/**
* ActionsApi - factory interface
* @export
*/
export const ActionsApiFactory = function (configuration, basePath, axios) {
const localVarFp = ActionsApiFp(configuration);
return {
/**
*
* @summary Remove queued action
* @param {ActionsApiCancelActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelAction(requestParameters, options) {
return localVarFp.cancelAction(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.actionId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary List queued actions
* @param {ActionsApiGetActionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getActions(requestParameters, options) {
return localVarFp.getActions(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Put action on-hold
* @param {ActionsApiPutOnHoldRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putOnHold(requestParameters, options) {
return localVarFp.putOnHold(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.actionId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Retry action
* @param {ActionsApiRetryActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retryAction(requestParameters, options) {
return localVarFp.retryAction(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.actionId, options).then((request) => request(axios, basePath));
},
};
};
/**
* ActionsApi - object-oriented interface
* @export
* @class ActionsApi
* @extends {BaseAPI}
*/
export class ActionsApi extends BaseAPI {
/**
*
* @summary Remove queued action
* @param {ActionsApiCancelActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApi
*/
cancelAction(requestParameters, options) {
return ActionsApiFp(this.configuration).cancelAction(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.actionId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary List queued actions
* @param {ActionsApiGetActionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApi
*/
getActions(requestParameters, options) {
return ActionsApiFp(this.configuration).getActions(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Put action on-hold
* @param {ActionsApiPutOnHoldRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApi
*/
putOnHold(requestParameters, options) {
return ActionsApiFp(this.configuration).putOnHold(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.actionId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Retry action
* @param {ActionsApiRetryActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApi
*/
retryAction(requestParameters, options) {
return ActionsApiFp(this.configuration).retryAction(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.actionId, options).then((request) => request(this.axios, this.basePath));
}
}
/**
* ChangeSetsApi - axios parameter creator
* @export
*/
export const ChangeSetsApiAxiosParamCreator = function (configuration) {
return {
/**
*
* @summary Delete a Change Set
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
abandonChangeSet: async (workspaceId, changeSetId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('abandonChangeSet', 'workspaceId', workspaceId);
// verify required parameter 'changeSetId' is not null or undefined
assertParamExists('abandonChangeSet', 'changeSetId', changeSetId);
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Create a Change Set
* @param {string} workspaceId Workspace identifier
* @param {CreateChangeSetV1Request} createChangeSetV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createChangeSet: async (workspaceId, createChangeSetV1Request, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('createChangeSet', 'workspaceId', workspaceId);
// verify required parameter 'createChangeSetV1Request' is not null or undefined
assertParamExists('createChangeSet', 'createChangeSetV1Request', createChangeSetV1Request);
const localVarPath = `/v1/w/{workspace_id}/change-sets`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
localVarRequestOptions.data = serializeDataIfNeeded(createChangeSetV1Request, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Merge Change Set without approval
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
forceApply: async (workspaceId, changeSetId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('forceApply', 'workspaceId', workspaceId);
// verify required parameter 'changeSetId' is not null or undefined
assertParamExists('forceApply', 'changeSetId', changeSetId);
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/force_apply`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Get a Change Set by Change Set Id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getChangeSet: async (workspaceId, changeSetId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('getChangeSet', 'workspaceId', workspaceId);
// verify required parameter 'changeSetId' is not null or undefined
assertParamExists('getChangeSet', 'changeSetId', changeSetId);
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary List all active Change Sets
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listChangeSets: async (workspaceId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('listChangeSets', 'workspaceId', workspaceId);
const localVarPath = `/v1/w/{workspace_id}/change-sets`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Get Change Set post merge status
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
mergeStatus: async (workspaceId, changeSetId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('mergeStatus', 'workspaceId', workspaceId);
// verify required parameter 'changeSetId' is not null or undefined
assertParamExists('mergeStatus', 'changeSetId', changeSetId);
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/merge_status`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Abandon all active Change Sets
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purgeOpen: async (workspaceId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('purgeOpen', 'workspaceId', workspaceId);
const localVarPath = `/v1/w/{workspace_id}/change-sets/purge_open`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Request Change Set merge approval
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
requestApproval: async (workspaceId, changeSetId, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('requestApproval', 'workspaceId', workspaceId);
// verify required parameter 'changeSetId' is not null or undefined
assertParamExists('requestApproval', 'changeSetId', changeSetId);
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/request_approval`
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
/**
* ChangeSetsApi - functional programming interface
* @export
*/
export const ChangeSetsApiFp = function (configuration) {
const localVarAxiosParamCreator = ChangeSetsApiAxiosParamCreator(configuration);
return {
/**
*
* @summary Delete a Change Set
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async abandonChangeSet(workspaceId, changeSetId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.abandonChangeSet(workspaceId, changeSetId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ChangeSetsApi.abandonChangeSet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Create a Change Set
* @param {string} workspaceId Workspace identifier
* @param {CreateChangeSetV1Request} createChangeSetV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createChangeSet(workspaceId, createChangeSetV1Request, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.createChangeSet(workspaceId, createChangeSetV1Request, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ChangeSetsApi.createChangeSet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Merge Change Set without approval
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async forceApply(workspaceId, changeSetId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.forceApply(workspaceId, changeSetId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ChangeSetsApi.forceApply']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Get a Change Set by Change Set Id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getChangeSet(workspaceId, changeSetId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.getChangeSet(workspaceId, changeSetId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ChangeSetsApi.getChangeSet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary List all active Change Sets
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listChangeSets(workspaceId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.listChangeSets(workspaceId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ChangeSetsApi.listChangeSets']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Get Change Set post merge status
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async mergeStatus(workspaceId, changeSetId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.mergeStatus(workspaceId, changeSetId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ChangeSetsApi.mergeStatus']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Abandon all active Change Sets
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async purgeOpen(workspaceId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.purgeOpen(workspaceId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ChangeSetsApi.purgeOpen']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Request Change Set merge approval
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async requestApproval(workspaceId, changeSetId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.requestApproval(workspaceId, changeSetId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ChangeSetsApi.requestApproval']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
};
};
/**
* ChangeSetsApi - factory interface
* @export
*/
export const ChangeSetsApiFactory = function (configuration, basePath, axios) {
const localVarFp = ChangeSetsApiFp(configuration);
return {
/**
*
* @summary Delete a Change Set
* @param {ChangeSetsApiAbandonChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
abandonChangeSet(requestParameters, options) {
return localVarFp.abandonChangeSet(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Create a Change Set
* @param {ChangeSetsApiCreateChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createChangeSet(requestParameters, options) {
return localVarFp.createChangeSet(requestParameters.workspaceId, requestParameters.createChangeSetV1Request, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Merge Change Set without approval
* @param {ChangeSetsApiForceApplyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
forceApply(requestParameters, options) {
return localVarFp.forceApply(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get a Change Set by Change Set Id
* @param {ChangeSetsApiGetChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getChangeSet(requestParameters, options) {
return localVarFp.getChangeSet(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary List all active Change Sets
* @param {ChangeSetsApiListChangeSetsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listChangeSets(requestParameters, options) {
return localVarFp.listChangeSets(requestParameters.workspaceId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get Change Set post merge status
* @param {ChangeSetsApiMergeStatusRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
mergeStatus(requestParameters, options) {
return localVarFp.mergeStatus(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Abandon all active Change Sets
* @param {ChangeSetsApiPurgeOpenRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purgeOpen(requestParameters, options) {
return localVarFp.purgeOpen(requestParameters.workspaceId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Request Change Set merge approval
* @param {ChangeSetsApiRequestApprovalRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
requestApproval(requestParameters, options) {
return localVarFp.requestApproval(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(axios, basePath));
},
};
};
/**
* ChangeSetsApi - object-oriented interface
* @export
* @class ChangeSetsApi
* @extends {BaseAPI}
*/
export class ChangeSetsApi extends BaseAPI {
/**
*
* @summary Delete a Change Set
* @param {ChangeSetsApiAbandonChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
abandonChangeSet(requestParameters, options) {
return ChangeSetsApiFp(this.configuration).abandonChangeSet(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Create a Change Set
* @param {ChangeSetsApiCreateChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
createChangeSet(requestParameters, options) {
return ChangeSetsApiFp(this.configuration).createChangeSet(requestParameters.workspaceId, requestParameters.createChangeSetV1Request, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Merge Change Set without approval
* @param {ChangeSetsApiForceApplyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
forceApply(requestParameters, options) {
return ChangeSetsApiFp(this.configuration).forceApply(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Get a Change Set by Change Set Id
* @param {ChangeSetsApiGetChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
getChangeSet(requestParameters, options) {
return ChangeSetsApiFp(this.configuration).getChangeSet(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary List all active Change Sets
* @param {ChangeSetsApiListChangeSetsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
listChangeSets(requestParameters, options) {
return ChangeSetsApiFp(this.configuration).listChangeSets(requestParameters.workspaceId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Get Change Set post merge status
* @param {ChangeSetsApiMergeStatusRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
mergeStatus(requestParameters, options) {
return ChangeSetsApiFp(this.configuration).mergeStatus(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Abandon all active Change Sets
* @param {ChangeSetsApiPurgeOpenRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
purgeOpen(requestParameters, options) {
return ChangeSetsApiFp(this.configuration).purgeOpen(requestParameters.workspaceId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Request Change Set merge approval
* @param {ChangeSetsApiRequestApprovalRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
requestApproval(requestParameters, options) {
return ChangeSetsApiFp(this.configuration).requestApproval(requestParameters.workspaceId, requestParameters.changeSetId, options).then((request) => request(this.axios, this.basePath));
}
}
/**
* ComponentsApi - axios parameter creator
* @export
*/
export const ComponentsApiAxiosParamCreator = function (configuration) {
return {
/**
*
* @summary Queue action for a component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {AddActionV1Request} addActionV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addAction: async (workspaceId, changeSetId, componentId, addActionV1Request, options = {}) => {
// verify required parameter 'workspaceId' is not null or undefined
assertParamExists('addAction', 'workspaceId', workspaceId);
// verify required parameter 'changeSetId' is not null or undefined
assertParamExists('addAction', 'changeSetId', changeSetId);
// verify required parameter 'componentId' is not null or undefined
assertParam