system-initiative-api-client
Version:
TypeScript/JavaScript SDK for the System Initiative Public API
9,179 lines • 304 kB
TypeScript
/**
* 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 type { Configuration } from './configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import type { RequestArgs } from './base';
import { BaseAPI } from './base';
/**
* @type ActionReference
* Reference to a management function by either name or ID. This allows clients to use the more human-friendly name approach or the more precise ID approach when working with actions.
* @export
*/
export type ActionReference = ActionReferenceOneOf | ActionReferenceOneOf1;
/**
*
* @export
* @interface ActionReferenceOneOf
*/
export interface ActionReferenceOneOf {
/**
*
* @type {string}
* @memberof ActionReferenceOneOf
*/
'function': string;
}
/**
*
* @export
* @interface ActionReferenceOneOf1
*/
export interface ActionReferenceOneOf1 {
/**
*
* @type {string}
* @memberof ActionReferenceOneOf1
*/
'actionPrototypeId': string;
}
/**
*
* @export
* @interface ActionV1RequestPath
*/
export interface ActionV1RequestPath {
/**
*
* @type {string}
* @memberof ActionV1RequestPath
*/
'action_id': string;
}
/**
*
* @export
* @interface ActionViewV1
*/
export interface ActionViewV1 {
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'componentId'?: string | null;
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'funcRunId'?: string | null;
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'id': string;
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'kind': string;
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'name': string;
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'originatingChangeSetId': string;
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'prototypeId': string;
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'state': string;
}
/**
*
* @export
* @interface AddActionV1Request
*/
export interface AddActionV1Request {
/**
*
* @type {ActionReference}
* @memberof AddActionV1Request
*/
'action': ActionReference;
}
/**
*
* @export
* @interface AddActionV1Response
*/
export interface AddActionV1Response {
/**
*
* @type {boolean}
* @memberof AddActionV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface AddToViewV1Request
*/
export interface AddToViewV1Request {
/**
*
* @type {Array<string>}
* @memberof AddToViewV1Request
*/
'componentIds': Array<string>;
/**
*
* @type {string}
* @memberof AddToViewV1Request
*/
'viewName': string;
}
/**
* Standard error response format for v1 API
* @export
* @interface ApiError
*/
export interface ApiError {
/**
*
* @type {number}
* @memberof ApiError
*/
'code'?: number | null;
/**
*
* @type {string}
* @memberof ApiError
*/
'message': string;
/**
*
* @type {number}
* @memberof ApiError
*/
'statusCode': number;
}
/**
* Standard success response format for v1 API
* @export
* @interface ApiSuccessString
*/
export interface ApiSuccessString {
/**
*
* @type {string}
* @memberof ApiSuccessString
*/
'data': string;
}
/**
*
* @export
* @interface AttributeArgumentBindingRequest
*/
export interface AttributeArgumentBindingRequest {
/**
* Element type for Array arguments. Required when kind is \'Array\'. Specifies the type of array elements.
* @type {string}
* @memberof AttributeArgumentBindingRequest
*/
'elementKind'?: string | null;
/**
* Type of the argument. Valid values: \"Any\", \"Array\", \"Boolean\", \"Float\", \"Integer\", \"Json\", \"Map\", \"Object\", \"String\". Use \'Array\' with element_kind for typed arrays.
* @type {string}
* @memberof AttributeArgumentBindingRequest
*/
'kind': string;
/**
* Name of the function argument (e.g., \"instanceType\", \"region\", \"tags\")
* @type {string}
* @memberof AttributeArgumentBindingRequest
*/
'name': string;
/**
* Prop ID to bind this argument to. Either prop_id or static_value must be provided.
* @type {string}
* @memberof AttributeArgumentBindingRequest
*/
'propId'?: string | null;
/**
*
* @type {any}
* @memberof AttributeArgumentBindingRequest
*/
'staticValue'?: any;
}
/**
* The response payload when materialized views or data is being built referenced by present or expected data.
* @export
* @interface BuildingResponseV1
*/
export interface BuildingResponseV1 {
/**
* The estimated time for the data being built to be completed.
* @type {number}
* @memberof BuildingResponseV1
*/
'estimatedCompletionSeconds': number;
/**
* The message reflecting the reason or state of the data being built.
* @type {string}
* @memberof BuildingResponseV1
*/
'message': string;
/**
* The number of seconds recommended between retries for the desired data.
* @type {number}
* @memberof BuildingResponseV1
*/
'retryAfterSeconds': number;
/**
* The status of the data being built.
* @type {string}
* @memberof BuildingResponseV1
*/
'status': string;
}
/**
*
* @export
* @interface CancelActionV1Response
*/
export interface CancelActionV1Response {
/**
*
* @type {boolean}
* @memberof CancelActionV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface ChangeSetViewV1
*/
export interface ChangeSetViewV1 {
/**
*
* @type {string}
* @memberof ChangeSetViewV1
*/
'id': string;
/**
*
* @type {boolean}
* @memberof ChangeSetViewV1
*/
'isHead': boolean;
/**
*
* @type {string}
* @memberof ChangeSetViewV1
*/
'name': string;
/**
*
* @type {string}
* @memberof ChangeSetViewV1
*/
'status': string;
}
/**
*
* @export
* @interface ComponentDetailsV1
*/
export interface ComponentDetailsV1 {
/**
*
* @type {any}
* @memberof ComponentDetailsV1
*/
'codegen'?: any;
/**
*
* @type {string}
* @memberof ComponentDetailsV1
*/
'componentId': string;
/**
*
* @type {string}
* @memberof ComponentDetailsV1
*/
'name': string;
/**
*
* @type {string}
* @memberof ComponentDetailsV1
*/
'schemaName': string;
}
/**
* @type ComponentPropKey
* @export
*/
export type ComponentPropKey = string;
/**
*
* @export
* @interface ComponentPropViewV1
*/
export interface ComponentPropViewV1 {
/**
*
* @type {string}
* @memberof ComponentPropViewV1
*/
'id': string;
/**
*
* @type {string}
* @memberof ComponentPropViewV1
*/
'path': string;
/**
*
* @type {string}
* @memberof ComponentPropViewV1
*/
'propId': string;
/**
*
* @type {any}
* @memberof ComponentPropViewV1
*/
'value'?: any;
}
/**
* @type ComponentReference
* @export
*/
export type ComponentReference = ComponentReferenceOneOf | ComponentReferenceOneOf1;
/**
*
* @export
* @interface ComponentReferenceOneOf
*/
export interface ComponentReferenceOneOf {
/**
*
* @type {string}
* @memberof ComponentReferenceOneOf
*/
'component': string;
}
/**
*
* @export
* @interface ComponentReferenceOneOf1
*/
export interface ComponentReferenceOneOf1 {
/**
*
* @type {string}
* @memberof ComponentReferenceOneOf1
*/
'componentId': string;
}
/**
* Component data in search results.
* @export
* @interface ComponentSearchResult
*/
export interface ComponentSearchResult {
/**
*
* @type {string}
* @memberof ComponentSearchResult
*/
'id': string;
/**
*
* @type {string}
* @memberof ComponentSearchResult
*/
'name': string;
/**
*
* @type {ComponentSearchResultSchema}
* @memberof ComponentSearchResult
*/
'schema': ComponentSearchResultSchema;
}
/**
* The schema for a component in search results.
* @export
* @interface ComponentSearchResultSchema
*/
export interface ComponentSearchResultSchema {
/**
*
* @type {string}
* @memberof ComponentSearchResultSchema
*/
'name': string;
}
/**
*
* @export
* @interface ComponentV1RequestPath
*/
export interface ComponentV1RequestPath {
/**
*
* @type {string}
* @memberof ComponentV1RequestPath
*/
'component_id': string;
}
/**
*
* @export
* @interface ComponentViewV1
*/
export interface ComponentViewV1 {
/**
*
* @type {{ [key: string]: any; }}
* @memberof ComponentViewV1
*/
'attributes': {
[key: string]: any;
};
/**
*
* @type {boolean}
* @memberof ComponentViewV1
*/
'canBeUpgraded': boolean;
/**
*
* @type {Array<ConnectionViewV1>}
* @memberof ComponentViewV1
*/
'connections': Array<ConnectionViewV1>;
/**
*
* @type {Array<ComponentPropViewV1>}
* @memberof ComponentViewV1
*/
'domainProps': Array<ComponentPropViewV1>;
/**
*
* @type {string}
* @memberof ComponentViewV1
*/
'id': string;
/**
*
* @type {string}
* @memberof ComponentViewV1
*/
'name': string;
/**
*
* @type {string}
* @memberof ComponentViewV1
*/
'resourceId': string;
/**
*
* @type {Array<ComponentPropViewV1>}
* @memberof ComponentViewV1
*/
'resourceProps': Array<ComponentPropViewV1>;
/**
*
* @type {string}
* @memberof ComponentViewV1
*/
'schemaId': string;
/**
*
* @type {string}
* @memberof ComponentViewV1
*/
'schemaVariantId': string;
/**
*
* @type {string}
* @memberof ComponentViewV1
*/
'secretId': string;
/**
*
* @type {boolean}
* @memberof ComponentViewV1
*/
'toDelete': boolean;
/**
*
* @type {Array<ViewV1>}
* @memberof ComponentViewV1
*/
'views': Array<ViewV1>;
}
/**
* @type ConnectionViewV1
* @export
*/
export type ConnectionViewV1 = ConnectionViewV1OneOf | ConnectionViewV1OneOf1;
/**
*
* @export
* @interface ConnectionViewV1OneOf
*/
export interface ConnectionViewV1OneOf {
/**
*
* @type {ManagingConnectionViewV1}
* @memberof ConnectionViewV1OneOf
*/
'managing': ManagingConnectionViewV1;
}
/**
*
* @export
* @interface ConnectionViewV1OneOf1
*/
export interface ConnectionViewV1OneOf1 {
/**
*
* @type {ManagedByConnectionViewV1}
* @memberof ConnectionViewV1OneOf1
*/
'managedBy': ManagedByConnectionViewV1;
}
/**
*
* @export
* @interface CreateChangeSetV1Request
*/
export interface CreateChangeSetV1Request {
/**
*
* @type {string}
* @memberof CreateChangeSetV1Request
*/
'changeSetName': string;
}
/**
*
* @export
* @interface CreateChangeSetV1Response
*/
export interface CreateChangeSetV1Response {
/**
*
* @type {ChangeSetViewV1}
* @memberof CreateChangeSetV1Response
*/
'changeSet': ChangeSetViewV1;
}
/**
*
* @export
* @interface CreateComponentV1Request
*/
export interface CreateComponentV1Request {
/**
*
* @type {{ [key: string]: any; }}
* @memberof CreateComponentV1Request
*/
'attributes'?: {
[key: string]: any;
};
/**
*
* @type {ComponentReference}
* @memberof CreateComponentV1Request
*/
'managedBy'?: ComponentReference;
/**
*
* @type {string}
* @memberof CreateComponentV1Request
*/
'name': string;
/**
*
* @type {string}
* @memberof CreateComponentV1Request
*/
'resourceId'?: string | null;
/**
*
* @type {string}
* @memberof CreateComponentV1Request
*/
'schemaName': string;
/**
*
* @type {boolean}
* @memberof CreateComponentV1Request
*/
'useWorkingCopy'?: boolean | null;
/**
*
* @type {string}
* @memberof CreateComponentV1Request
*/
'viewName'?: string | null;
}
/**
*
* @export
* @interface CreateComponentV1Response
*/
export interface CreateComponentV1Response {
/**
*
* @type {ComponentViewV1}
* @memberof CreateComponentV1Response
*/
'component': ComponentViewV1;
}
/**
*
* @export
* @interface CreateSchemaV1Request
*/
export interface CreateSchemaV1Request {
/**
*
* @type {string}
* @memberof CreateSchemaV1Request
*/
'category'?: string | null;
/**
*
* @type {string}
* @memberof CreateSchemaV1Request
*/
'code': string;
/**
*
* @type {string}
* @memberof CreateSchemaV1Request
*/
'color'?: string | null;
/**
*
* @type {string}
* @memberof CreateSchemaV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof CreateSchemaV1Request
*/
'link'?: string | null;
/**
*
* @type {string}
* @memberof CreateSchemaV1Request
*/
'name': string;
}
/**
*
* @export
* @interface CreateSecretV1Request
*/
export interface CreateSecretV1Request {
/**
*
* @type {string}
* @memberof CreateSecretV1Request
*/
'definitionName': string;
/**
*
* @type {string}
* @memberof CreateSecretV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof CreateSecretV1Request
*/
'name': string;
/**
*
* @type {{ [key: string]: string; }}
* @memberof CreateSecretV1Request
*/
'rawData'?: {
[key: string]: string;
};
}
/**
*
* @export
* @interface CreateSecretV1Response
*/
export interface CreateSecretV1Response {
/**
*
* @type {SecretV1}
* @memberof CreateSecretV1Response
*/
'secret': SecretV1;
}
/**
*
* @export
* @interface CreateTransformationFuncV1Request
*/
export interface CreateTransformationFuncV1Request {
/**
*
* @type {string}
* @memberof CreateTransformationFuncV1Request
*/
'code': string;
/**
*
* @type {string}
* @memberof CreateTransformationFuncV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof CreateTransformationFuncV1Request
*/
'displayName'?: string | null;
/**
*
* @type {string}
* @memberof CreateTransformationFuncV1Request
*/
'name': string;
}
/**
*
* @export
* @interface CreateTransformationFuncV1Response
*/
export interface CreateTransformationFuncV1Response {
/**
*
* @type {string}
* @memberof CreateTransformationFuncV1Response
*/
'funcId': string;
}
/**
*
* @export
* @interface CreateVariantActionFuncV1Request
*/
export interface CreateVariantActionFuncV1Request {
/**
*
* @type {string}
* @memberof CreateVariantActionFuncV1Request
*/
'code': string;
/**
*
* @type {string}
* @memberof CreateVariantActionFuncV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof CreateVariantActionFuncV1Request
*/
'displayName'?: string | null;
/**
*
* @type {string}
* @memberof CreateVariantActionFuncV1Request
*/
'kind': string;
/**
*
* @type {string}
* @memberof CreateVariantActionFuncV1Request
*/
'name': string;
/**
*
* @type {boolean}
* @memberof CreateVariantActionFuncV1Request
*/
'skipOverlay'?: boolean | null;
}
/**
*
* @export
* @interface CreateVariantActionFuncV1Response
*/
export interface CreateVariantActionFuncV1Response {
/**
*
* @type {string}
* @memberof CreateVariantActionFuncV1Response
*/
'funcId': string;
}
/**
*
* @export
* @interface CreateVariantAttributeFuncV1Request
*/
export interface CreateVariantAttributeFuncV1Request {
/**
* Function arguments with their bindings (input sources). Each argument defines its type and where its value comes from.
* @type {Array<AttributeArgumentBindingRequest>}
* @memberof CreateVariantAttributeFuncV1Request
*/
'argumentBindings': Array<AttributeArgumentBindingRequest>;
/**
* TypeScript code for the function. Should export a main function that takes arguments and returns a value.
* @type {string}
* @memberof CreateVariantAttributeFuncV1Request
*/
'code': string;
/**
* Optional component ID for component-level bindings. If not provided, creates a schema variant-level binding.
* @type {string}
* @memberof CreateVariantAttributeFuncV1Request
*/
'componentId'?: string | null;
/**
* Description of what the function does
* @type {string}
* @memberof CreateVariantAttributeFuncV1Request
*/
'description'?: string | null;
/**
* Human-readable display name
* @type {string}
* @memberof CreateVariantAttributeFuncV1Request
*/
'displayName'?: string | null;
/**
* Unique name for the function (e.g., \"awsEC2SetInstanceType\")
* @type {string}
* @memberof CreateVariantAttributeFuncV1Request
*/
'name': string;
/**
* Prop ID where the function output will be written (required)
* @type {string}
* @memberof CreateVariantAttributeFuncV1Request
*/
'propId': string;
/**
*
* @type {boolean}
* @memberof CreateVariantAttributeFuncV1Request
*/
'skipOverlay'?: boolean | null;
}
/**
*
* @export
* @interface CreateVariantAttributeFuncV1Response
*/
export interface CreateVariantAttributeFuncV1Response {
/**
*
* @type {string}
* @memberof CreateVariantAttributeFuncV1Response
*/
'attributePrototypeId': string;
/**
*
* @type {string}
* @memberof CreateVariantAttributeFuncV1Response
*/
'funcId': string;
}
/**
*
* @export
* @interface CreateVariantAuthenticationFuncV1Request
*/
export interface CreateVariantAuthenticationFuncV1Request {
/**
*
* @type {string}
* @memberof CreateVariantAuthenticationFuncV1Request
*/
'code': string;
/**
*
* @type {string}
* @memberof CreateVariantAuthenticationFuncV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof CreateVariantAuthenticationFuncV1Request
*/
'displayName'?: string | null;
/**
*
* @type {string}
* @memberof CreateVariantAuthenticationFuncV1Request
*/
'name': string;
}
/**
*
* @export
* @interface CreateVariantAuthenticationFuncV1Response
*/
export interface CreateVariantAuthenticationFuncV1Response {
/**
*
* @type {string}
* @memberof CreateVariantAuthenticationFuncV1Response
*/
'funcId': string;
}
/**
*
* @export
* @interface CreateVariantCodegenFuncV1Request
*/
export interface CreateVariantCodegenFuncV1Request {
/**
*
* @type {string}
* @memberof CreateVariantCodegenFuncV1Request
*/
'code': string;
/**
*
* @type {string}
* @memberof CreateVariantCodegenFuncV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof CreateVariantCodegenFuncV1Request
*/
'displayName'?: string | null;
/**
*
* @type {string}
* @memberof CreateVariantCodegenFuncV1Request
*/
'name': string;
/**
*
* @type {boolean}
* @memberof CreateVariantCodegenFuncV1Request
*/
'skipOverlay'?: boolean | null;
}
/**
*
* @export
* @interface CreateVariantCodegenFuncV1Response
*/
export interface CreateVariantCodegenFuncV1Response {
/**
*
* @type {string}
* @memberof CreateVariantCodegenFuncV1Response
*/
'funcId': string;
}
/**
*
* @export
* @interface CreateVariantManagementFuncV1Request
*/
export interface CreateVariantManagementFuncV1Request {
/**
*
* @type {string}
* @memberof CreateVariantManagementFuncV1Request
*/
'code': string;
/**
*
* @type {string}
* @memberof CreateVariantManagementFuncV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof CreateVariantManagementFuncV1Request
*/
'displayName'?: string | null;
/**
*
* @type {string}
* @memberof CreateVariantManagementFuncV1Request
*/
'name': string;
/**
*
* @type {boolean}
* @memberof CreateVariantManagementFuncV1Request
*/
'skipOverlay'?: boolean | null;
}
/**
*
* @export
* @interface CreateVariantManagementFuncV1Response
*/
export interface CreateVariantManagementFuncV1Response {
/**
*
* @type {string}
* @memberof CreateVariantManagementFuncV1Response
*/
'funcId': string;
}
/**
*
* @export
* @interface CreateVariantQualificationFuncV1Request
*/
export interface CreateVariantQualificationFuncV1Request {
/**
*
* @type {string}
* @memberof CreateVariantQualificationFuncV1Request
*/
'code': string;
/**
*
* @type {string}
* @memberof CreateVariantQualificationFuncV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof CreateVariantQualificationFuncV1Request
*/
'displayName'?: string | null;
/**
*
* @type {string}
* @memberof CreateVariantQualificationFuncV1Request
*/
'name': string;
/**
*
* @type {boolean}
* @memberof CreateVariantQualificationFuncV1Request
*/
'skipOverlay'?: boolean | null;
}
/**
*
* @export
* @interface CreateVariantQualificationFuncV1Response
*/
export interface CreateVariantQualificationFuncV1Response {
/**
*
* @type {string}
* @memberof CreateVariantQualificationFuncV1Response
*/
'funcId': string;
}
/**
*
* @export
* @interface CreateWorkspaceRequest
*/
export interface CreateWorkspaceRequest {
/**
*
* @type {string}
* @memberof CreateWorkspaceRequest
*/
'description': string;
/**
*
* @type {string}
* @memberof CreateWorkspaceRequest
*/
'displayName': string;
/**
*
* @type {string}
* @memberof CreateWorkspaceRequest
*/
'instanceUrl': string;
/**
*
* @type {boolean}
* @memberof CreateWorkspaceRequest
*/
'isDefault'?: boolean;
}
/**
*
* @export
* @interface CreatorUser
*/
export interface CreatorUser {
/**
*
* @type {string}
* @memberof CreatorUser
*/
'firstName'?: string | null;
/**
*
* @type {string}
* @memberof CreatorUser
*/
'lastName'?: string | null;
}
/**
*
* @export
* @interface DeleteChangeSetV1Response
*/
export interface DeleteChangeSetV1Response {
/**
*
* @type {boolean}
* @memberof DeleteChangeSetV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface DeleteComponentV1Response
*/
export interface DeleteComponentV1Response {
/**
*
* @type {string}
* @memberof DeleteComponentV1Response
*/
'status': string;
}
/**
*
* @export
* @interface DeleteSecretV1Response
*/
export interface DeleteSecretV1Response {
/**
*
* @type {boolean}
* @memberof DeleteSecretV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface DetachFuncBindingV1Response
*/
export interface DetachFuncBindingV1Response {
/**
*
* @type {boolean}
* @memberof DetachFuncBindingV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface DuplicateComponentsV1Request
*/
export interface DuplicateComponentsV1Request {
/**
*
* @type {Array<Array<string>>}
* @memberof DuplicateComponentsV1Request
*/
'components': Array<Array<string>>;
/**
*
* @type {string}
* @memberof DuplicateComponentsV1Request
*/
'prefix'?: string | null;
/**
*
* @type {string}
* @memberof DuplicateComponentsV1Request
*/
'viewName'?: string | null;
}
/**
*
* @export
* @interface DuplicateComponentsV1Response
*/
export interface DuplicateComponentsV1Response {
/**
*
* @type {Array<Array<string>>}
* @memberof DuplicateComponentsV1Response
*/
'components': Array<Array<string>>;
}
/**
*
* @export
* @interface EraseComponentV1Response
*/
export interface EraseComponentV1Response {
/**
*
* @type {boolean}
* @memberof EraseComponentV1Response
*/
'status': boolean;
}
/**
*
* @export
* @interface ErrorDetail
*/
export interface ErrorDetail {
/**
*
* @type {number}
* @memberof ErrorDetail
*/
'code': number;
/**
*
* @type {string}
* @memberof ErrorDetail
*/
'message': string;
/**
*
* @type {number}
* @memberof ErrorDetail
*/
'status_code': number;
}
/**
*
* @export
* @interface ErrorResponse
*/
export interface ErrorResponse {
/**
*
* @type {ErrorDetail}
* @memberof ErrorResponse
*/
'error': ErrorDetail;
}
/**
*
* @export
* @interface ExecDebugFuncV1Request
*/
export interface ExecDebugFuncV1Request {
/**
*
* @type {string}
* @memberof ExecDebugFuncV1Request
*/
'code': string;
/**
*
* @type {string}
* @memberof ExecDebugFuncV1Request
*/
'componentId': string;
/**
*
* @type {any}
* @memberof ExecDebugFuncV1Request
*/
'debugInput'?: any;
/**
*
* @type {string}
* @memberof ExecDebugFuncV1Request
*/
'handler': string;
/**
*
* @type {string}
* @memberof ExecDebugFuncV1Request
*/
'name': string;
}
/**
*
* @export
* @interface ExecDebugFuncV1Response
*/
export interface ExecDebugFuncV1Response {
/**
*
* @type {string}
* @memberof ExecDebugFuncV1Response
*/
'debugFuncJobStateId': string;
}
/**
*
* @export
* @interface ExecuteManagementFunctionV1Request
*/
export interface ExecuteManagementFunctionV1Request {
/**
*
* @type {ManagementFunctionReference}
* @memberof ExecuteManagementFunctionV1Request
*/
'managementFunction': ManagementFunctionReference;
/**
*
* @type {string}
* @memberof ExecuteManagementFunctionV1Request
*/
'viewName'?: string | null;
}
/**
*
* @export
* @interface ExecuteManagementFunctionV1Response
*/
export interface ExecuteManagementFunctionV1Response {
/**
*
* @type {string}
* @memberof ExecuteManagementFunctionV1Response
* @deprecated
*/
'funcRunId'?: string | null;
/**
*
* @type {string}
* @memberof ExecuteManagementFunctionV1Response
*/
'managementFuncJobStateId': string;
/**
*
* @type {string}
* @memberof ExecuteManagementFunctionV1Response
*/
'message'?: string | null;
/**
*
* @type {string}
* @memberof ExecuteManagementFunctionV1Response
*/
'status': string;
}
/**
*
* @export
* @interface FindComponentV1Params
*/
export interface FindComponentV1Params {
/**
*
* @type {string}
* @memberof FindComponentV1Params
*/
'component'?: string | null;
/**
*
* @type {string}
* @memberof FindComponentV1Params
*/
'componentId'?: string | null;
}
/**
*
* @export
* @interface FindSchemaV1Params
*/
export interface FindSchemaV1Params {
/**
*
* @type {string}
* @memberof FindSchemaV1Params
*/
'schema'?: string | null;
/**
*
* @type {string}
* @memberof FindSchemaV1Params
*/
'schemaId'?: string | null;
}
/**
*
* @export
* @interface FindSchemaV1Response
*/
export interface FindSchemaV1Response {
/**
*
* @type {string}
* @memberof FindSchemaV1Response
*/
'category'?: string | null;
/**
*
* @type {boolean}
* @memberof FindSchemaV1Response
*/
'installed': boolean;
/**
*
* @type {string}
* @memberof FindSchemaV1Response
*/
'schemaId': string;
/**
*
* @type {string}
* @memberof FindSchemaV1Response
*/
'schemaName': string;
}
/**
*
* @export
* @interface ForceApplyChangeSetV1Response
*/
export interface ForceApplyChangeSetV1Response {
/**
*
* @type {boolean}
* @memberof ForceApplyChangeSetV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface FuncRunLogViewV1
*/
export interface FuncRunLogViewV1 {
/**
*
* @type {string}
* @memberof FuncRunLogViewV1
*/
'createdAt': string;
/**
*
* @type {boolean}
* @memberof FuncRunLogViewV1
*/
'finalized': boolean;
/**
*
* @type {string}
* @memberof FuncRunLogViewV1
*/
'funcRunId': string;
/**
*
* @type {string}
* @memberof FuncRunLogViewV1
*/
'id': string;
/**
*
* @type {Array<object>}
* @memberof FuncRunLogViewV1
*/
'logs': Array<object>;
/**
*
* @type {string}
* @memberof FuncRunLogViewV1
*/
'updatedAt': string;
}
/**
*
* @export
* @interface FuncRunV1RequestPath
*/
export interface FuncRunV1RequestPath {
/**
*
* @type {string}
* @memberof FuncRunV1RequestPath
*/
'func_run_id': string;
}
/**
*
* @export
* @interface FuncRunViewV1
*/
export interface FuncRunViewV1 {
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionDisplayName'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionId'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionKind'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionOriginatingChangeSetId'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionOriginatingChangeSetName'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionPrototypeId'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionResultState'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'attributeValueId'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'backendKind': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'backendResponseType': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'componentId'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'componentName'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'createdAt': string;
/**
*
* @type {any}
* @memberof FuncRunViewV1
*/
'functionArgs': any;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionCodeBase64': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionDescription'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionDisplayName'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionKind': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionLink'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionName': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'id': string;
/**
*
* @type {FuncRunLogViewV1}
* @memberof FuncRunViewV1
*/
'logs'?: FuncRunLogViewV1 | null;
/**
*
* @type {any}
* @memberof FuncRunViewV1
*/
'resultValue'?: any;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'schemaName'?: string | null;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'state': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'updatedAt': string;
}
/**
*
* @export
* @interface GetActionsV1Response
*/
export interface GetActionsV1Response {
/**
*
* @type {Array<ActionViewV1>}
* @memberof GetActionsV1Response
*/
'actions': Array<ActionViewV1>;
}
/**
*
* @export
* @interface GetChangeSetV1Response
*/
export interface GetChangeSetV1Response {
/**
*
* @type {ChangeSetViewV1}
* @memberof GetChangeSetV1Response
*/
'changeSet': ChangeSetViewV1;
}
/**
*
* @export
* @interface GetComponentResourceDataV1Response
*/
export interface GetComponentResourceDataV1Response {
/**
*
* @type {string}
* @memberof GetComponentResourceDataV1Response
*/
'last_synced': string;
/**
*
* @type {any}
* @memberof GetComponentResourceDataV1Response
*/
'payload'?: any;
/**
*
* @type {string}
* @memberof GetComponentResourceDataV1Response
*/
'status': string;
}
/**
*
* @export
* @interface GetComponentV1Response
*/
export interface GetComponentV1Response {
/**
*
* @type {Array<GetComponentV1ResponseActionFunction>}
* @memberof GetComponentV1Response
*/
'actionFunctions': Array<GetComponentV1ResponseActionFunction>;
/**
*
* @type {ComponentViewV1}
* @memberof GetComponentV1Response
*/
'component': ComponentViewV1;
/**
*
* @type {Array<GetComponentV1ResponseManagementFunction>}
* @memberof GetComponentV1Response
*/
'managementFunctions': Array<GetComponentV1ResponseManagementFunction>;
}
/**
*
* @export
* @interface GetComponentV1ResponseActionFunction
*/
export interface GetComponentV1ResponseActionFunction {
/**
*
* @type {string}
* @memberof GetComponentV1ResponseActionFunction
*/
'funcName': string;
/**
*
* @type {string}
* @memberof GetComponentV1ResponseActionFunction
*/
'prototypeId': string;
}
/**
*
* @export
* @interface GetComponentV1ResponseManagementFunction
*/
export interface GetComponentV1ResponseManagementFunction {
/**
*
* @type {string}
* @memberof GetComponentV1ResponseManagementFunction
*/
'funcName': string;
/**
*
* @type {string}
* @memberof GetComponentV1ResponseManagementFunction
*/
'managementPrototypeId': string;
}
/**
*
* @export
* @interface GetDebugFuncJobStateV1Response
*/
export interface GetDebugFuncJobStateV1Response {
/**
*
* @type {string}
* @memberof GetDebugFuncJobStateV1Response
*/
'failure'?: string | null;
/**
*
* @type {string}
* @memberof GetDebugFuncJobStateV1Response
*/
'funcRunId'?: string | null;
/**
*
* @type {string}
* @memberof GetDebugFuncJobStateV1Response
*/
'id': string;
/**
*
* @type {any}
* @memberof GetDebugFuncJobStateV1Response
*/
'result'?: any;
/**
*
* @type {string}
* @memberof GetDebugFuncJobStateV1Response
*/
'state': string;
}
/**
*
* @export
* @interface GetFuncRunV1Response
*/
export interface GetFuncRunV1Response {
/**
*
* @type {FuncRunViewV1}
* @memberof GetFuncRunV1Response
*/
'funcRun': FuncRunViewV1;
}
/**
*
* @export
* @interface GetFuncV1Response
*/
export interface GetFuncV1Response {
/**
*
* @type {string}
* @memberof GetFuncV1Response
*/
'code': string;
/**
*
* @type {string}
* @memberof GetFuncV1Response
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof GetFuncV1Response
*/
'displayName'?: string | null;
/**
*
* @type {boolean}
* @memberof GetFuncV1Response
*/
'isLocked': boolean;
/**
*
* @type {string}
* @memberof GetFuncV1Response
*/
'kind': string;
/**
*
* @type {string}
* @memberof GetFuncV1Response
*/
'link'?: string | null;
/**
*
* @type {string}
* @memberof GetFuncV1Response
*/
'name': string;
}
/**
*
* @export
* @interface GetManagementFuncJobStateV1Response
*/
export interface GetManagementFuncJobStateV1Response {
/**
*
* @type {string}
* @memberof GetManagementFuncJobStateV1Response
*/
'funcRunId'?: string | null;
/**
*
* @type {string}
* @memberof GetManagementFuncJobStateV1Response
*/
'state': string;
}
/**
*
* @export
* @interface GetSchemaV1Response
*/
export interface GetSchemaV1Response {
/**
*
* @type {string}
* @memberof GetSchemaV1Response
*/
'defaultVariantId': string;
/**
*
* @type {string}
* @memberof GetSchemaV1Response
*/
'name': string;
/**
*
* @type {string}
* @memberof GetSchemaV1Response
*/
'schemaId': string;
/**
*
* @type {Array<string>}
* @memberof GetSchemaV1Response
*/
'variantIds': Array<string>;
}
/**
*
* @export
* @interface GetSchemaVariantV1Response
*/
export interface GetSchemaVariantV1Response {
/**
*
* @type {string}
* @memberof GetSchemaVariantV1Response
*/
'assetFuncId': string;
/**
*
* @type {string}
* @memberof GetSchemaVariantV1Response
*/
'category': string;
/**
*
* @type {string}
* @memberof GetSchemaVariantV1Response
*/
'color': string;
/**
*
* @type {string}
* @memberof GetSchemaVariantV1Response
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof GetSchemaVariantV1Response
*/
'displayName': string;
/**
*
* @type {PropSchemaV1}
* @memberof GetSchemaVariantV1Response
*/
'domainProps'?: PropSchemaV1 | null;
/**
*
* @type {boolean}
* @memberof GetSchemaVariantV1Response
*/
'installedFromUpstream': boolean;
/**
*
* @type {boolean}
* @memberof GetSchemaVariantV1Response
*/
'isDefaultVariant': boolean;
/**
*
* @type {boolean}
* @memberof GetSchemaVariantV1Response
*/
'isLocked': boolean;
/**
*
* @type {string}
* @memberof GetSchemaVariantV1Response
*/
'link'?: string | null;
/**
*
* @type {Array<string>}
* @memberof GetSchemaVariantV1Response
*/
'variantFuncIds': Array<string>;
/**
*
* @type {Array<SchemaVariantFunc>}
* @memberof GetSchemaVariantV1Response
*/
'variantFuncs': Array<SchemaVariantFunc>;
/**
*
* @type {string}
* @memberof GetSchemaVariantV1Response
*/
'variantId': string;
}
/**
*
* @export
* @interface HashMapValue
*/
export interface HashMapValue {
/**
*
* @type {SecretDefinitionV1}
* @memberof HashMapValue
*/
'definition': SecretDefinitionV1;
/**
*
* @type {Array<SecretV1>}
* @memberof HashMapValue
*/
'secrets': Array<SecretV1>;
}
/**
*
* @export
* @interface InitialApiToken
*/
export interface InitialApiToken {
/**
*
* @type {string}
* @memberof InitialApiToken
*/
'expiresAt'?: string | null;
/**
*
* @type {string}
* @memberof InitialApiToken
*/
'token': string;
}
/**
*
* @export
* @interface InviteMemberRequest
*/
export interface InviteMemberRequest {
/**
*
* @type {string}
* @memberof InviteMemberRequest
*/
'email': string;
}
/**
*
* @export
* @interface ListChangeSetV1Response
*/
export interface ListChangeSetV1Response {
/**
*
* @type {Array<object>}
* @memberof ListChangeSetV1Response
*/
'changeSets': Array<object>;
}
/**
*
* @export
* @interface ListComponentsV1Response
*/
export interface ListComponentsV1Response {
/**
*
* @type {Array<ComponentDetailsV1>}
* @memberof ListComponentsV1Response
*/
'componentDetails': Array<ComponentDetailsV1>;
/**
*
* @type {string}
* @memberof ListComponentsV1Response
*/
'nextCursor'?: string | null;
}
/**
*
* @export
* @interface ListSchemaV1Response
*/
export interface ListSchemaV1Response {
/**
*
* @type {string}
* @memberof ListSchemaV1Response
*/
'nextCursor'?: string | null;
/**
*
* @type {Array<SchemaResponse>}
* @memberof ListSchemaV1Response
*/
'schemas': Array<SchemaResponse>;
}
/**
*
* @export
* @interface ManageComponentV1Request
*/
export interface ManageComponentV1Request {
/**
*
* @type {string}
* @memberof ManageComponentV1Request
*/
'componentId': string;
}
/**
*
* @export
* @interface ManageComponentV1Response
*/
export interface ManageComponentV1Response {
/**
*
* @type {ComponentViewV1}
* @memberof ManageComponentV1Response
*/
'component': ComponentViewV1;
}
/**
*
* @export
* @interface ManagedByConnectionViewV1
*/
export interface ManagedByConnectionViewV1 {
/**
*
* @type {string}
* @memberof ManagedByConnectionViewV1
*/
'componentId': string;
/**
*
* @type {string}
* @memberof ManagedByConnectionViewV1
*/
'componentName': string;
}
/**
*
* @export
* @interface ManagementFuncJobStateV1RequestPath
*/
export interface ManagementFuncJobStateV1RequestPath {
/**
*
* @type {string}
* @memberof ManagementFuncJobStateV1RequestPath
*/
'management_func_job_state_id': string;
}
/**
* @type ManagementFunctionReference
* Reference to a management function by either name or ID. This allows clients to use the more human-friendly name approach or the more precise ID approach when working with management functions.
* @export
*/
export type ManagementFunctionReference = ManagementFunctionReferenceOneOf | ManagementFunctionReferenceOneOf1;
/**
*
* @export
* @interface ManagementFunctionReferenceOneOf
*/
export interface ManagementFunctionReferenceOneOf {
/**
*
* @type {string}
* @memberof ManagementFunctionReferenceOneOf
*/
'function': string;
}
/**
*
* @export
* @interface ManagementFunctionReferenceOneOf1
*/
export interface ManagementFunctionReferenceOneOf1 {
/**
*
* @type {string}
* @memberof ManagementFunctionReferenceOneOf1
*/
'managementPrototypeId': string;
}
/**
*
* @export
* @interface ManagingConnectionViewV1
*/
export interface ManagingConnectionViewV1 {
/**
*
* @type {string}
* @memberof ManagingConnectionViewV1
*/
'componentId': string;
/**
*
* @type {string}
* @memberof ManagingConnectionViewV1
*/
'componentName': string;
}
/**
*
* @export
* @interface Member
*/
export interface Member {
/**
*
* @type {string}
* @memberof Member
*/
'email': string;
/**
*
* @type {string}
* @memberof Member
*/
'nickname': string;
/**
*
* @type {string}
* @memberof Member
*/
'role': string;
/**
*
* @type {string}
* @memberof Member
*/
'signupAt'?: string | null;
/**
*
* @type {string}
* @memberof Member
*/
'userId': string;
}
/**
* Response for merge status
* @export
* @interface MergeStatusV1Response
*/
export interface MergeStatusV1Response {
/**
*
* @type {Array<MergeStatusV1ResponseAction>}
* @memberof MergeStatusV1Response
*/
'actions': Array<MergeStatusV1ResponseAction>;
/**
*
* @type {object}
* @memberof MergeStatusV1Response
*/
'changeSet': object;
}
/**
* Action item in merge status response
* @export
* @interface MergeStatusV1ResponseAction
*/
export interface MergeStatusV1ResponseAction {
/**
*
* @type {MergeStatusV1ResponseActionComponent}
* @memberof MergeStatusV1ResponseAction
*/
'component'?: MergeStatusV1ResponseActionComponent | null;
/**
*
* @type {string}
* @memberof MergeStatusV1ResponseAction
*/
'id': string;
/**
*
* @type {string}
* @memberof MergeStatusV1ResponseAction
*/
'kind': string;
/**
*
* @type {string}
* @memberof MergeStatusV1ResponseAction
*/
'name': string;
/**
*
* @type {string}
* @memberof MergeStatusV1ResponseAction
*/
'state': string;
}
/**
* Component details in action response
* @export
* @interface MergeStatusV1ResponseActionComponent
*/
export interface MergeStatusV1ResponseActionComponent {
/**
*
* @type {string}
* @memberof MergeStatusV1ResponseActionComponent
*/
'id': string;
/**
*
* @type {string}
* @memberof MergeStatusV1ResponseActionComponent
*/
'name': string;
}
/**
*
* @export
* @interface OutputLineViewV1
*/
export interface OutputLineViewV1 {
/**
*
* @type {string}
* @memberof OutputLineViewV1
*/
'executionId': string;
/**
*
* @type {string}
* @memberof OutputLineViewV1
*/
'group'?: string | null;
/**
*
* @type {string}
* @memberof OutputLineViewV1
*/
'level': string;
/**
*
* @type {string}
* @memberof OutputLineViewV1
*/
'message': string;
/**
*
* @type {string}
* @memberof OutputLineViewV1
*/
'stream': string;
/**
*
* @type {number}
* @memberof OutputLineViewV1
*/
'timestamp': number;
}
/**
*
* @export
* @interface PropSchemaV1
*/
export interface PropSchemaV1 {
/**
*
* @type {Array<PropSchemaV1>}
* @memberof PropSchemaV1
*/
'children'?: Array<PropSchemaV1> | null;
/**
*
* @type {any}
* @memberof PropSchemaV1
*/
'defaultValue'?: any;
/**
*
* @type {string}
* @memberof PropSchemaV1
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof PropSchemaV1
*/
'docLink'?: string | null;
/**
*
* @type {boolean}
* @memberof PropSchemaV1
*/
'hidden'?: boolean | null;
/**
*
* @type {string}
* @memberof PropSchemaV1
*/
'name': string;
/**
*
* @type {string}
* @memberof PropSchemaV1
*/
'propId': string;
/**
*
* @type {string}
* @memberof PropSchemaV1
*/
'propType': string;
/**
*
* @type {string}
* @memberof PropSchemaV1
*/
'validationFormat'?: string | null;
}
/**
*
* @export
* @interface PurgeOpenChangeSetsV1Response
*/
export interface PurgeOpenChangeSetsV1Response {
/**
*
* @type {boolean}
* @memberof PurgeOpenChangeSetsV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface PutOnHoldActionV1Response
*/
export interface PutOnHoldActionV1Response {
/**
*
* @type {boolean}
* @memberof PutOnHoldActionV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface RemoveMemberRequest
*/
export interface RemoveMemberRequest {
/**
*
* @type {string}
* @memberof RemoveMemberRequest
*/
'email': string;
}
/**
*
* @export
* @interface RequestApprovalChangeSetV1Response
*/
export interface RequestApprovalChangeSetV1Response {
/**
*
* @type {boolean}
* @memberof RequestApprovalChangeSetV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface RestoreComponentV1Response
*/
export interface RestoreComponentV1Response {
/**
*
* @type {boolean}
* @memberof RestoreComponentV1Response
*/
'status': boolean;
}
/**
*
* @export
* @interface RetryActionV1Response
*/
export interface RetryActionV1Response {
/**
*
* @type {boolean}
* @memberof RetryActionV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface SchemaResponse
*/
export interface SchemaResponse {
/**
*
* @type {string}
* @memberof SchemaResponse
*/
'category'?: string | null;
/**
*
* @type {boolean}
* @memberof SchemaResponse
*/
'installed': boolean;
/**
*
* @type {string}
* @memberof SchemaResponse
*/
'schemaId': string;
/**
*
* @type {string}
* @memberof SchemaResponse
*/
'schemaName': string;
}
/**
*
* @export
* @interface SchemaV1RequestPath
*/
export interface SchemaV1RequestPath {
/**
*
* @type {string}
* @memberof SchemaV1RequestPath
*/
'schema_id': string;
}
/**
*
* @export
* @interface SchemaVariantFunc
*/
export interface SchemaVariantFunc {
/**
*
* @type {SchemaVariantFuncKind}
* @memberof SchemaVariantFunc
*/
'funcKind': SchemaVariantFuncKind;
/**
*
* @type {string}
* @memberof SchemaVariantFunc
*/
'id': string;
/**
*
* @type {boolean}
* @memberof SchemaVariantFunc
*/
'isOverlay': boolean;
}
/**
* @type SchemaVariantFuncKind
* @export
*/
export type SchemaVariantFuncKind = SchemaVariantFuncKindOneOf | SchemaVariantFuncKindOneOf1 | SchemaVariantFuncKindOneOf2;
/**
* Action function; carries the specific `ActionKind`.
* @export
* @interface SchemaVariantFuncKindOneOf
*/
export interface SchemaVariantFuncKindOneOf {
/**
* Specific action kind
* @type {string}
* @memberof SchemaVariantFuncKindOneOf
*/
'actionKind': string;
/**
*
* @type {string}
* @memberof SchemaVariantFuncKindOneOf
*/
'kind': SchemaVariantFuncKindOneOfKindEnum;
}
/**
* @export
* @enum {string}
*/
export declare enum SchemaVariantFuncKindOneOfKindEnum {
ACTION = "action"
}
/**
* Management function; carries the specific `ManagementFuncKind`.
* @export
* @interface SchemaVariantFuncKindOneOf1
*/
export interface SchemaVariantFuncKindOneOf1 {
/**
*
* @type {string}
* @memberof SchemaVariantFuncKindOneOf1
*/
'kind': SchemaVariantFuncKindOneOf1KindEnum;
/**
* Specific management function kind
* @type {string}
* @memberof SchemaVariantFuncKindOneOf1
*/
'managementFuncKind': string;
}
/**
* @export
* @enum {string}
*/
export declare enum SchemaVariantFuncKindOneOf1KindEnum {
MANAGEMENT = "management"
}
/**
* Any other function; exposes the raw `FuncKind` category.
* @export
* @interface SchemaVariantFuncKindOneOf2
*/
export interface SchemaVariantFuncKindOneOf2 {
/**
*
* @type {string}
* @memberof SchemaVariantFuncKindOneOf2
*/
'funcKind': string;
/**
*
* @type {string}
* @memberof SchemaVariantFuncKindOneOf2
*/
'kind': SchemaVariantFuncKindOneOf2KindEnum;
}
/**
* @export
* @enum {string}
*/
export declare enum SchemaVariantFuncKindOneOf2KindEnum {
OTHER = "other"
}
/**
*
* @export
* @interface SchemaVariantV1RequestPath
*/
export interface SchemaVariantV1RequestPath {
/**
*
* @type {string}
* @memberof SchemaVariantV1RequestPath
*/
'schema_id': string;
/**
*
* @type {string}
* @memberof SchemaVariantV1RequestPath
*/
'schema_variant_id': string;
}
/**
*
* @export
* @interface SearchComponentsV1Request
*/
export interface SearchComponentsV1Request {
/**
*
* @type {string}
* @memberof SearchComponentsV1Request
*/
'queryString'?: string | null;
/**
*
* @type {string}
* @memberof SearchComponentsV1Request
*/
'schemaCategory'?: string | null;
/**
*
* @type {string}
* @memberof SearchComponentsV1Request
*/
'schemaName'?: string | null;
/**
*
* @type {boolean}
* @memberof SearchComponentsV1Request
*/
'upgradable'?: boolean | null;
}
/**
*
* @export
* @interface SearchComponentsV1Response
*/
export interface SearchComponentsV1Response {
/**
*
* @type {Array<Array<string>>}
* @memberof SearchComponentsV1Response
*/
'components': Array<Array<string>>;
}
/**
*
* @export
* @interface SearchSchemasV1Request
*/
export interface SearchSchemasV1Request {
/**
*
* @type {string}
* @memberof SearchSchemasV1Request
*/
'category'?: string | null;
}
/**
*
* @export
* @interface SearchSchemasV1Response
*/
export interface SearchSchemasV1Response {
/**
*
* @type {Array<SchemaResponse>}
* @memberof SearchSchemasV1Response
*/
'schemas': Array<SchemaResponse>;
}
/**
*
* @export
* @interface SearchV1Request
*/
export interface SearchV1Request {
/**
*
* @type {string}
* @memberof SearchV1Request
*/
'q': string;
}
/**
*
* @export
* @interface SearchV1Response
*/
export interface SearchV1Response {
/**
*
* @type {Array<ComponentSearchResult>}
* @memberof SearchV1Response
*/
'components': Array<ComponentSearchResult>;
}
/**
*
* @export
* @interface SecretDefinitionV1
*/
export interface SecretDefinitionV1 {
/**
*
* @type {Array<SecretFormDataV1>}
* @memberof SecretDefinitionV1
*/
'formData': Array<SecretFormDataV1>;
/**
*
* @type {string}
* @memberof SecretDefinitionV1
*/
'secretDefinition': string;
}
/**
*
* @export
* @interface SecretFormDataV1
*/
export interface SecretFormDataV1 {
/**
*
* @type {string}
* @memberof SecretFormDataV1
*/
'kind': string;
/**
*
* @type {string}
* @memberof SecretFormDataV1
*/
'name': string;
}
/**
* @type SecretPropKey
* @export
*/
export type SecretPropKey = string;
/**
*
* @export
* @interface SecretV1
*/
export interface SecretV1 {
/**
*
* @type {string}
* @memberof SecretV1
*/
'definition': string;
/**
*
* @type {string}
* @memberof SecretV1
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof SecretV1
*/
'id': string;
/**
*
* @type {string}
* @memberof SecretV1
*/
'name': string;
}
/**
*
* @export
* @interface SourceViewV1
*/
export interface SourceViewV1 {
/**
*
* @type {string}
* @memberof SourceViewV1
*/
'component': string;
/**
*
* @type {string}
* @memberof SourceViewV1
*/
'propPath': string;
}
/**
*
* @export
* @interface SystemStatusResponse
*/
export interface SystemStatusResponse {
/**
*
* @type {string}
* @memberof SystemStatusResponse
*/
'API Documentation': string;
}
/**
*
* @export
* @interface UnlockFuncV1Request
*/
export interface UnlockFuncV1Request {
/**
*
* @type {string}
* @memberof UnlockFuncV1Request
*/
'schemaVariantId': string;
}
/**
*
* @export
* @interface UnlockFuncV1Response
*/
export interface UnlockFuncV1Response {
/**
*
* @type {string}
* @memberof UnlockFuncV1Response
*/
'unlockedFuncId': string;
}
/**
*
* @export
* @interface UnlockedSchemaV1Response
*/
export interface UnlockedSchemaV1Response {
/**
*
* @type {string}
* @memberof UnlockedSchemaV1Response
*/
'schemaId': string;
/**
*
* @type {GetSchemaVariantV1Response}
* @memberof UnlockedSchemaV1Response
*/
'unlockedVariant': GetSchemaVariantV1Response;
/**
*
* @type {string}
* @memberof UnlockedSchemaV1Response
*/
'unlockedVariantId': string;
}
/**
*
* @export
* @interface UpdateComponentV1Request
*/
export interface UpdateComponentV1Request {
/**
*
* @type {{ [key: string]: any; }}
* @memberof UpdateComponentV1Request
*/
'attributes'?: {
[key: string]: any;
};
/**
*
* @type {string}
* @memberof UpdateComponentV1Request
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof UpdateComponentV1Request
*/
'resourceId'?: string | null;
/**
*
* @type {{ [key: string]: any; }}
* @memberof UpdateComponentV1Request
*/
'secrets'?: {
[key: string]: any;
};
}
/**
*
* @export
* @interface UpdateComponentV1Response
*/
export interface UpdateComponentV1Response {
/**
*
* @type {ComponentViewV1}
* @memberof UpdateComponentV1Response
*/
'component': ComponentViewV1;
}
/**
*
* @export
* @interface UpdateFuncV1Request
*/
export interface UpdateFuncV1Request {
/**
*
* @type {string}
* @memberof UpdateFuncV1Request
*/
'code': string;
/**
*
* @type {string}
* @memberof UpdateFuncV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof UpdateFuncV1Request
*/
'displayName'?: string | null;
}
/**
*
* @export
* @interface UpdateFuncV1Response
*/
export interface UpdateFuncV1Response {
/**
*
* @type {boolean}
* @memberof UpdateFuncV1Response
*/
'success': boolean;
}
/**
*
* @export
* @interface UpdateMemberRoleRequest
*/
export interface UpdateMemberRoleRequest {
/**
*
* @type {string}
* @memberof UpdateMemberRoleRequest
*/
'role': string;
/**
*
* @type {string}
* @memberof UpdateMemberRoleRequest
*/
'userId': string;
}
/**
*
* @export
* @interface UpdateSchemaVariantV1Request
*/
export interface UpdateSchemaVariantV1Request {
/**
*
* @type {string}
* @memberof UpdateSchemaVariantV1Request
*/
'category': string;
/**
*
* @type {string}
* @memberof UpdateSchemaVariantV1Request
*/
'code': string;
/**
*
* @type {string}
* @memberof UpdateSchemaVariantV1Request
*/
'color'?: string | null;
/**
*
* @type {string}
* @memberof UpdateSchemaVariantV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof UpdateSchemaVariantV1Request
*/
'link'?: string | null;
/**
*
* @type {string}
* @memberof UpdateSchemaVariantV1Request
*/
'name': string;
}
/**
*
* @export
* @interface UpdateSecretV1Request
*/
export interface UpdateSecretV1Request {
/**
*
* @type {string}
* @memberof UpdateSecretV1Request
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof UpdateSecretV1Request
*/
'id': string;
/**
*
* @type {string}
* @memberof UpdateSecretV1Request
*/
'name': string;
/**
*
* @type {{ [key: string]: string; }}
* @memberof UpdateSecretV1Request
*/
'rawData'?: {
[key: string]: string;
};
}
/**
*
* @export
* @interface UpdateSecretV1Response
*/
export interface UpdateSecretV1Response {
/**
*
* @type {SecretV1}
* @memberof UpdateSecretV1Response
*/
'secret': SecretV1;
}
/**
*
* @export
* @interface UpdateWorkspaceRequest
*/
export interface UpdateWorkspaceRequest {
/**
*
* @type {string}
* @memberof UpdateWorkspaceRequest
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof UpdateWorkspaceRequest
*/
'displayName'?: string | null;
/**
*
* @type {string}
* @memberof UpdateWorkspaceRequest
*/
'instanceUrl'?: string | null;
}
/**
*
* @export
* @interface UpgradeComponentV1Response
*/
export interface UpgradeComponentV1Response {
/**
*
* @type {ComponentViewV1}
* @memberof UpgradeComponentV1Response
*/
'component': ComponentViewV1;
}
/**
*
* @export
* @interface ViewV1
*/
export interface ViewV1 {
/**
*
* @type {string}
* @memberof ViewV1
*/
'id': string;
/**
*
* @type {boolean}
* @memberof ViewV1
*/
'isDefault': boolean;
/**
*
* @type {string}
* @memberof ViewV1
*/
'name': string;
}
/**
*
* @export
* @interface WhoamiResponse
*/
export interface WhoamiResponse {
/**
*
* @type {object}
* @memberof WhoamiResponse
*/
'token': object;
/**
*
* @type {string}
* @memberof WhoamiResponse
*/
'userEmail': string;
/**
*
* @type {string}
* @memberof WhoamiResponse
*/
'userId': string;
/**
*
* @type {string}
* @memberof WhoamiResponse
*/
'workspaceId': string;
}
/**
*
* @export
* @interface Workspace
*/
export interface Workspace {
/**
*
* @type {boolean}
* @memberof Workspace
*/
'approvalsEnabled': boolean;
/**
*
* @type {CreatorUser}
* @memberof Workspace
*/
'creatorUser'?: CreatorUser | null;
/**
*
* @type {string}
* @memberof Workspace
*/
'creatorUserId': string;
/**
*
* @type {string}
* @memberof Workspace
*/
'description'?: string | null;
/**
*
* @type {string}
* @memberof Workspace
*/
'displayName': string;
/**
*
* @type {string}
* @memberof Workspace
*/
'externalId'?: string | null;
/**
*
* @type {string}
* @memberof Workspace
*/
'id': string;
/**
*
* @type {InitialApiToken}
* @memberof Workspace
*/
'initialApiToken'?: InitialApiToken | null;
/**
*
* @type {string}
* @memberof Workspace
*/
'instanceEnvType': string;
/**
*
* @type {string}
* @memberof Workspace
*/
'instanceUrl'?: string | null;
/**
*
* @type {boolean}
* @memberof Workspace
*/
'isDefault': boolean;
/**
*
* @type {string}
* @memberof Workspace
*/
'quarantinedAt'?: string | null;
/**
*
* @type {string}
* @memberof Workspace
*/
'role'?: string | null;
}
/**
*
* @export
* @interface WorkspaceManagementRequestPath
*/
export interface WorkspaceManagementRequestPath {
/**
*
* @type {string}
* @memberof WorkspaceManagementRequestPath
*/
'workspace_id': string;
}
/**
* ActionsApi - axios parameter creator
* @export
*/
export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @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: (workspaceId: string, changeSetId: string, actionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary List queued actions
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getActions: (workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: (workspaceId: string, changeSetId: string, actionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: (workspaceId: string, changeSetId: string, actionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ActionsApi - functional programming interface
* @export
*/
export declare const ActionsApiFp: (configuration?: Configuration) => {
/**
*
* @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(workspaceId: string, changeSetId: string, actionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelActionV1Response>>;
/**
*
* @summary List queued actions
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getActions(workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionsV1Response>>;
/**
*
* @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(workspaceId: string, changeSetId: string, actionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutOnHoldActionV1Response>>;
/**
*
* @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(workspaceId: string, changeSetId: string, actionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetryActionV1Response>>;
};
/**
* ActionsApi - factory interface
* @export
*/
export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Remove queued action
* @param {ActionsApiCancelActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelAction(requestParameters: ActionsApiCancelActionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CancelActionV1Response>;
/**
*
* @summary List queued actions
* @param {ActionsApiGetActionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getActions(requestParameters: ActionsApiGetActionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetActionsV1Response>;
/**
*
* @summary Put action on-hold
* @param {ActionsApiPutOnHoldRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
putOnHold(requestParameters: ActionsApiPutOnHoldRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutOnHoldActionV1Response>;
/**
*
* @summary Retry action
* @param {ActionsApiRetryActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retryAction(requestParameters: ActionsApiRetryActionRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetryActionV1Response>;
};
/**
* ActionsApi - interface
* @export
* @interface ActionsApi
*/
export interface ActionsApiInterface {
/**
*
* @summary Remove queued action
* @param {ActionsApiCancelActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApiInterface
*/
cancelAction(requestParameters: ActionsApiCancelActionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CancelActionV1Response>;
/**
*
* @summary List queued actions
* @param {ActionsApiGetActionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApiInterface
*/
getActions(requestParameters: ActionsApiGetActionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetActionsV1Response>;
/**
*
* @summary Put action on-hold
* @param {ActionsApiPutOnHoldRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApiInterface
*/
putOnHold(requestParameters: ActionsApiPutOnHoldRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutOnHoldActionV1Response>;
/**
*
* @summary Retry action
* @param {ActionsApiRetryActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApiInterface
*/
retryAction(requestParameters: ActionsApiRetryActionRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetryActionV1Response>;
}
/**
* Request parameters for cancelAction operation in ActionsApi.
* @export
* @interface ActionsApiCancelActionRequest
*/
export interface ActionsApiCancelActionRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ActionsApiCancelAction
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ActionsApiCancelAction
*/
readonly changeSetId: string;
/**
* Action identifier
* @type {string}
* @memberof ActionsApiCancelAction
*/
readonly actionId: string;
}
/**
* Request parameters for getActions operation in ActionsApi.
* @export
* @interface ActionsApiGetActionsRequest
*/
export interface ActionsApiGetActionsRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ActionsApiGetActions
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ActionsApiGetActions
*/
readonly changeSetId: string;
}
/**
* Request parameters for putOnHold operation in ActionsApi.
* @export
* @interface ActionsApiPutOnHoldRequest
*/
export interface ActionsApiPutOnHoldRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ActionsApiPutOnHold
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ActionsApiPutOnHold
*/
readonly changeSetId: string;
/**
* Action identifier
* @type {string}
* @memberof ActionsApiPutOnHold
*/
readonly actionId: string;
}
/**
* Request parameters for retryAction operation in ActionsApi.
* @export
* @interface ActionsApiRetryActionRequest
*/
export interface ActionsApiRetryActionRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ActionsApiRetryAction
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ActionsApiRetryAction
*/
readonly changeSetId: string;
/**
* Action identifier
* @type {string}
* @memberof ActionsApiRetryAction
*/
readonly actionId: string;
}
/**
* ActionsApi - object-oriented interface
* @export
* @class ActionsApi
* @extends {BaseAPI}
*/
export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
/**
*
* @summary Remove queued action
* @param {ActionsApiCancelActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApi
*/
cancelAction(requestParameters: ActionsApiCancelActionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelActionV1Response, any, {}>>;
/**
*
* @summary List queued actions
* @param {ActionsApiGetActionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApi
*/
getActions(requestParameters: ActionsApiGetActionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionsV1Response, any, {}>>;
/**
*
* @summary Put action on-hold
* @param {ActionsApiPutOnHoldRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApi
*/
putOnHold(requestParameters: ActionsApiPutOnHoldRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PutOnHoldActionV1Response, any, {}>>;
/**
*
* @summary Retry action
* @param {ActionsApiRetryActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ActionsApi
*/
retryAction(requestParameters: ActionsApiRetryActionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetryActionV1Response, any, {}>>;
}
/**
* ChangeSetsApi - axios parameter creator
* @export
*/
export declare const ChangeSetsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @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: (workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create a Change Set
* @param {string} workspaceId Workspace identifier
* @param {CreateChangeSetV1Request} createChangeSetV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createChangeSet: (workspaceId: string, createChangeSetV1Request: CreateChangeSetV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: (workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: (workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary List all active Change Sets
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listChangeSets: (workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: (workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Abandon all active Change Sets
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purgeOpen: (workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @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: (workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ChangeSetsApi - functional programming interface
* @export
*/
export declare const ChangeSetsApiFp: (configuration?: Configuration) => {
/**
*
* @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(workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteChangeSetV1Response>>;
/**
*
* @summary Create a Change Set
* @param {string} workspaceId Workspace identifier
* @param {CreateChangeSetV1Request} createChangeSetV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createChangeSet(workspaceId: string, createChangeSetV1Request: CreateChangeSetV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChangeSetV1Response>>;
/**
*
* @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(workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForceApplyChangeSetV1Response>>;
/**
*
* @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(workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangeSetV1Response>>;
/**
*
* @summary List all active Change Sets
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listChangeSets(workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListChangeSetV1Response>>;
/**
*
* @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(workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MergeStatusV1Response>>;
/**
*
* @summary Abandon all active Change Sets
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purgeOpen(workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurgeOpenChangeSetsV1Response>>;
/**
*
* @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(workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestApprovalChangeSetV1Response>>;
};
/**
* ChangeSetsApi - factory interface
* @export
*/
export declare const ChangeSetsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Delete a Change Set
* @param {ChangeSetsApiAbandonChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
abandonChangeSet(requestParameters: ChangeSetsApiAbandonChangeSetRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteChangeSetV1Response>;
/**
*
* @summary Create a Change Set
* @param {ChangeSetsApiCreateChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createChangeSet(requestParameters: ChangeSetsApiCreateChangeSetRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChangeSetV1Response>;
/**
*
* @summary Merge Change Set without approval
* @param {ChangeSetsApiForceApplyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
forceApply(requestParameters: ChangeSetsApiForceApplyRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForceApplyChangeSetV1Response>;
/**
*
* @summary Get a Change Set by Change Set Id
* @param {ChangeSetsApiGetChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getChangeSet(requestParameters: ChangeSetsApiGetChangeSetRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetChangeSetV1Response>;
/**
*
* @summary List all active Change Sets
* @param {ChangeSetsApiListChangeSetsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listChangeSets(requestParameters: ChangeSetsApiListChangeSetsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListChangeSetV1Response>;
/**
*
* @summary Get Change Set post merge status
* @param {ChangeSetsApiMergeStatusRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
mergeStatus(requestParameters: ChangeSetsApiMergeStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<MergeStatusV1Response>;
/**
*
* @summary Abandon all active Change Sets
* @param {ChangeSetsApiPurgeOpenRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purgeOpen(requestParameters: ChangeSetsApiPurgeOpenRequest, options?: RawAxiosRequestConfig): AxiosPromise<PurgeOpenChangeSetsV1Response>;
/**
*
* @summary Request Change Set merge approval
* @param {ChangeSetsApiRequestApprovalRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
requestApproval(requestParameters: ChangeSetsApiRequestApprovalRequest, options?: RawAxiosRequestConfig): AxiosPromise<RequestApprovalChangeSetV1Response>;
};
/**
* ChangeSetsApi - interface
* @export
* @interface ChangeSetsApi
*/
export interface ChangeSetsApiInterface {
/**
*
* @summary Delete a Change Set
* @param {ChangeSetsApiAbandonChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApiInterface
*/
abandonChangeSet(requestParameters: ChangeSetsApiAbandonChangeSetRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteChangeSetV1Response>;
/**
*
* @summary Create a Change Set
* @param {ChangeSetsApiCreateChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApiInterface
*/
createChangeSet(requestParameters: ChangeSetsApiCreateChangeSetRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChangeSetV1Response>;
/**
*
* @summary Merge Change Set without approval
* @param {ChangeSetsApiForceApplyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApiInterface
*/
forceApply(requestParameters: ChangeSetsApiForceApplyRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForceApplyChangeSetV1Response>;
/**
*
* @summary Get a Change Set by Change Set Id
* @param {ChangeSetsApiGetChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApiInterface
*/
getChangeSet(requestParameters: ChangeSetsApiGetChangeSetRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetChangeSetV1Response>;
/**
*
* @summary List all active Change Sets
* @param {ChangeSetsApiListChangeSetsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApiInterface
*/
listChangeSets(requestParameters: ChangeSetsApiListChangeSetsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListChangeSetV1Response>;
/**
*
* @summary Get Change Set post merge status
* @param {ChangeSetsApiMergeStatusRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApiInterface
*/
mergeStatus(requestParameters: ChangeSetsApiMergeStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<MergeStatusV1Response>;
/**
*
* @summary Abandon all active Change Sets
* @param {ChangeSetsApiPurgeOpenRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApiInterface
*/
purgeOpen(requestParameters: ChangeSetsApiPurgeOpenRequest, options?: RawAxiosRequestConfig): AxiosPromise<PurgeOpenChangeSetsV1Response>;
/**
*
* @summary Request Change Set merge approval
* @param {ChangeSetsApiRequestApprovalRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApiInterface
*/
requestApproval(requestParameters: ChangeSetsApiRequestApprovalRequest, options?: RawAxiosRequestConfig): AxiosPromise<RequestApprovalChangeSetV1Response>;
}
/**
* Request parameters for abandonChangeSet operation in ChangeSetsApi.
* @export
* @interface ChangeSetsApiAbandonChangeSetRequest
*/
export interface ChangeSetsApiAbandonChangeSetRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ChangeSetsApiAbandonChangeSet
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ChangeSetsApiAbandonChangeSet
*/
readonly changeSetId: string;
}
/**
* Request parameters for createChangeSet operation in ChangeSetsApi.
* @export
* @interface ChangeSetsApiCreateChangeSetRequest
*/
export interface ChangeSetsApiCreateChangeSetRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ChangeSetsApiCreateChangeSet
*/
readonly workspaceId: string;
/**
*
* @type {CreateChangeSetV1Request}
* @memberof ChangeSetsApiCreateChangeSet
*/
readonly createChangeSetV1Request: CreateChangeSetV1Request;
}
/**
* Request parameters for forceApply operation in ChangeSetsApi.
* @export
* @interface ChangeSetsApiForceApplyRequest
*/
export interface ChangeSetsApiForceApplyRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ChangeSetsApiForceApply
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ChangeSetsApiForceApply
*/
readonly changeSetId: string;
}
/**
* Request parameters for getChangeSet operation in ChangeSetsApi.
* @export
* @interface ChangeSetsApiGetChangeSetRequest
*/
export interface ChangeSetsApiGetChangeSetRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ChangeSetsApiGetChangeSet
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ChangeSetsApiGetChangeSet
*/
readonly changeSetId: string;
}
/**
* Request parameters for listChangeSets operation in ChangeSetsApi.
* @export
* @interface ChangeSetsApiListChangeSetsRequest
*/
export interface ChangeSetsApiListChangeSetsRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ChangeSetsApiListChangeSets
*/
readonly workspaceId: string;
}
/**
* Request parameters for mergeStatus operation in ChangeSetsApi.
* @export
* @interface ChangeSetsApiMergeStatusRequest
*/
export interface ChangeSetsApiMergeStatusRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ChangeSetsApiMergeStatus
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ChangeSetsApiMergeStatus
*/
readonly changeSetId: string;
}
/**
* Request parameters for purgeOpen operation in ChangeSetsApi.
* @export
* @interface ChangeSetsApiPurgeOpenRequest
*/
export interface ChangeSetsApiPurgeOpenRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ChangeSetsApiPurgeOpen
*/
readonly workspaceId: string;
}
/**
* Request parameters for requestApproval operation in ChangeSetsApi.
* @export
* @interface ChangeSetsApiRequestApprovalRequest
*/
export interface ChangeSetsApiRequestApprovalRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ChangeSetsApiRequestApproval
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ChangeSetsApiRequestApproval
*/
readonly changeSetId: string;
}
/**
* ChangeSetsApi - object-oriented interface
* @export
* @class ChangeSetsApi
* @extends {BaseAPI}
*/
export declare class ChangeSetsApi extends BaseAPI implements ChangeSetsApiInterface {
/**
*
* @summary Delete a Change Set
* @param {ChangeSetsApiAbandonChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
abandonChangeSet(requestParameters: ChangeSetsApiAbandonChangeSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteChangeSetV1Response, any, {}>>;
/**
*
* @summary Create a Change Set
* @param {ChangeSetsApiCreateChangeSetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
createChangeSet(requestParameters: ChangeSetsApiCreateChangeSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateChangeSetV1Response, any, {}>>;
/**
*
* @summary Merge Change Set without approval
* @param {ChangeSetsApiForceApplyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
forceApply(requestParameters: ChangeSetsApiForceApplyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ForceApplyChangeSetV1Response, any, {}>>;
/**
*
* @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: ChangeSetsApiGetChangeSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetChangeSetV1Response, any, {}>>;
/**
*
* @summary List all active Change Sets
* @param {ChangeSetsApiListChangeSetsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
listChangeSets(requestParameters: ChangeSetsApiListChangeSetsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListChangeSetV1Response, any, {}>>;
/**
*
* @summary Get Change Set post merge status
* @param {ChangeSetsApiMergeStatusRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
mergeStatus(requestParameters: ChangeSetsApiMergeStatusRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MergeStatusV1Response, any, {}>>;
/**
*
* @summary Abandon all active Change Sets
* @param {ChangeSetsApiPurgeOpenRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
purgeOpen(requestParameters: ChangeSetsApiPurgeOpenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PurgeOpenChangeSetsV1Response, any, {}>>;
/**
*
* @summary Request Change Set merge approval
* @param {ChangeSetsApiRequestApprovalRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ChangeSetsApi
*/
requestApproval(requestParameters: ChangeSetsApiRequestApprovalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RequestApprovalChangeSetV1Response, any, {}>>;
}
/**
* ComponentsApi - axios parameter creator
* @export
*/
export declare const ComponentsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @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: (workspaceId: string, changeSetId: string, componentId: string, addActionV1Request: AddActionV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Adds multiple components to a view by name. If the view doesn\'t exist, it will be created automatically.
* @summary Add components to a view
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {AddToViewV1Request} addToViewV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addToView: (workspaceId: string, changeSetId: string, addToViewV1Request: AddToViewV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create a component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {CreateComponentV1Request} createComponentV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createComponent: (workspaceId: string, changeSetId: string, createComponentV1Request: CreateComponentV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete a component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Duplicate a list of components
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {DuplicateComponentsV1Request} duplicateComponentsV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
duplicateComponents: (workspaceId: string, changeSetId: string, duplicateComponentsV1Request: DuplicateComponentsV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Erase a component without queuing a delete action
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
eraseComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Execute a component\'s management function
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {ExecuteManagementFunctionV1Request} executeManagementFunctionV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
executeManagementFunction: (workspaceId: string, changeSetId: string, componentId: string, executeManagementFunctionV1Request: ExecuteManagementFunctionV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Find a component by name or component Id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string | null} [component]
* @param {string | null} [componentId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findComponent: (workspaceId: string, changeSetId: string, component?: string | null, componentId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get a component by component Id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get a component resource by component Id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComponentResource: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary List all components
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} [limit] Maximum number of results to return (default: 50, max: 300)
* @param {string} [cursor] Cursor for pagination (ComponentId of the last item from previous page)
* @param {boolean} [includeCodegen] Allow returning the codegen for the cloudformation template for the component (if it exists)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listComponents: (workspaceId: string, changeSetId: string, limit?: string, cursor?: string, includeCodegen?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Putting a component under the management of another component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {ManageComponentV1Request} manageComponentV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
manageComponent: (workspaceId: string, changeSetId: string, componentId: string, manageComponentV1Request: ManageComponentV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Restore a component that is marked for deletion
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
restoreComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Complex search for components
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {SearchComponentsV1Request} searchComponentsV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
searchComponents: (workspaceId: string, changeSetId: string, searchComponentsV1Request: SearchComponentsV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update a component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {UpdateComponentV1Request} updateComponentV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateComponent: (workspaceId: string, changeSetId: string, componentId: string, updateComponentV1Request: UpdateComponentV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Upgrade a component to the latest schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
upgradeComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ComponentsApi - functional programming interface
* @export
*/
export declare const ComponentsApiFp: (configuration?: Configuration) => {
/**
*
* @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(workspaceId: string, changeSetId: string, componentId: string, addActionV1Request: AddActionV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddActionV1Response>>;
/**
* Adds multiple components to a view by name. If the view doesn\'t exist, it will be created automatically.
* @summary Add components to a view
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {AddToViewV1Request} addToViewV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addToView(workspaceId: string, changeSetId: string, addToViewV1Request: AddToViewV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Create a component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {CreateComponentV1Request} createComponentV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createComponent(workspaceId: string, changeSetId: string, createComponentV1Request: CreateComponentV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateComponentV1Response>>;
/**
*
* @summary Delete a component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteComponentV1Response>>;
/**
*
* @summary Duplicate a list of components
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {DuplicateComponentsV1Request} duplicateComponentsV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
duplicateComponents(workspaceId: string, changeSetId: string, duplicateComponentsV1Request: DuplicateComponentsV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DuplicateComponentsV1Response>>;
/**
*
* @summary Erase a component without queuing a delete action
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
eraseComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EraseComponentV1Response>>;
/**
*
* @summary Execute a component\'s management function
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {ExecuteManagementFunctionV1Request} executeManagementFunctionV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
executeManagementFunction(workspaceId: string, changeSetId: string, componentId: string, executeManagementFunctionV1Request: ExecuteManagementFunctionV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecuteManagementFunctionV1Response>>;
/**
*
* @summary Find a component by name or component Id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string | null} [component]
* @param {string | null} [componentId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findComponent(workspaceId: string, changeSetId: string, component?: string | null, componentId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetComponentV1Response>>;
/**
*
* @summary Get a component by component Id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetComponentV1Response>>;
/**
*
* @summary Get a component resource by component Id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComponentResource(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetComponentResourceDataV1Response>>;
/**
*
* @summary List all components
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} [limit] Maximum number of results to return (default: 50, max: 300)
* @param {string} [cursor] Cursor for pagination (ComponentId of the last item from previous page)
* @param {boolean} [includeCodegen] Allow returning the codegen for the cloudformation template for the component (if it exists)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listComponents(workspaceId: string, changeSetId: string, limit?: string, cursor?: string, includeCodegen?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListComponentsV1Response>>;
/**
*
* @summary Putting a component under the management of another component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {ManageComponentV1Request} manageComponentV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
manageComponent(workspaceId: string, changeSetId: string, componentId: string, manageComponentV1Request: ManageComponentV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManageComponentV1Response>>;
/**
*
* @summary Restore a component that is marked for deletion
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
restoreComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestoreComponentV1Response>>;
/**
*
* @summary Complex search for components
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {SearchComponentsV1Request} searchComponentsV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
searchComponents(workspaceId: string, changeSetId: string, searchComponentsV1Request: SearchComponentsV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchComponentsV1Response>>;
/**
*
* @summary Update a component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {UpdateComponentV1Request} updateComponentV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateComponent(workspaceId: string, changeSetId: string, componentId: string, updateComponentV1Request: UpdateComponentV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateComponentV1Response>>;
/**
*
* @summary Upgrade a component to the latest schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} componentId Component identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
upgradeComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpgradeComponentV1Response>>;
};
/**
* ComponentsApi - factory interface
* @export
*/
export declare const ComponentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Queue action for a component
* @param {ComponentsApiAddActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addAction(requestParameters: ComponentsApiAddActionRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddActionV1Response>;
/**
* Adds multiple components to a view by name. If the view doesn\'t exist, it will be created automatically.
* @summary Add components to a view
* @param {ComponentsApiAddToViewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addToView(requestParameters: ComponentsApiAddToViewRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Create a component
* @param {ComponentsApiCreateComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createComponent(requestParameters: ComponentsApiCreateComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateComponentV1Response>;
/**
*
* @summary Delete a component
* @param {ComponentsApiDeleteComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteComponent(requestParameters: ComponentsApiDeleteComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteComponentV1Response>;
/**
*
* @summary Duplicate a list of components
* @param {ComponentsApiDuplicateComponentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
duplicateComponents(requestParameters: ComponentsApiDuplicateComponentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DuplicateComponentsV1Response>;
/**
*
* @summary Erase a component without queuing a delete action
* @param {ComponentsApiEraseComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
eraseComponent(requestParameters: ComponentsApiEraseComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<EraseComponentV1Response>;
/**
*
* @summary Execute a component\'s management function
* @param {ComponentsApiExecuteManagementFunctionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
executeManagementFunction(requestParameters: ComponentsApiExecuteManagementFunctionRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteManagementFunctionV1Response>;
/**
*
* @summary Find a component by name or component Id
* @param {ComponentsApiFindComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
/**
*
* @summary Get a component by component Id
* @param {ComponentsApiGetComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComponent(requestParameters: ComponentsApiGetComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
/**
*
* @summary Get a component resource by component Id
* @param {ComponentsApiGetComponentResourceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComponentResource(requestParameters: ComponentsApiGetComponentResourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentResourceDataV1Response>;
/**
*
* @summary List all components
* @param {ComponentsApiListComponentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listComponents(requestParameters: ComponentsApiListComponentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListComponentsV1Response>;
/**
*
* @summary Putting a component under the management of another component
* @param {ComponentsApiManageComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
manageComponent(requestParameters: ComponentsApiManageComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ManageComponentV1Response>;
/**
*
* @summary Restore a component that is marked for deletion
* @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
restoreComponent(requestParameters: ComponentsApiRestoreComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<RestoreComponentV1Response>;
/**
*
* @summary Complex search for components
* @param {ComponentsApiSearchComponentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
searchComponents(requestParameters: ComponentsApiSearchComponentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchComponentsV1Response>;
/**
*
* @summary Update a component
* @param {ComponentsApiUpdateComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateComponent(requestParameters: ComponentsApiUpdateComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateComponentV1Response>;
/**
*
* @summary Upgrade a component to the latest schema variant
* @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
upgradeComponent(requestParameters: ComponentsApiUpgradeComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpgradeComponentV1Response>;
};
/**
* ComponentsApi - interface
* @export
* @interface ComponentsApi
*/
export interface ComponentsApiInterface {
/**
*
* @summary Queue action for a component
* @param {ComponentsApiAddActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
addAction(requestParameters: ComponentsApiAddActionRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddActionV1Response>;
/**
* Adds multiple components to a view by name. If the view doesn\'t exist, it will be created automatically.
* @summary Add components to a view
* @param {ComponentsApiAddToViewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
addToView(requestParameters: ComponentsApiAddToViewRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Create a component
* @param {ComponentsApiCreateComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
createComponent(requestParameters: ComponentsApiCreateComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateComponentV1Response>;
/**
*
* @summary Delete a component
* @param {ComponentsApiDeleteComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
deleteComponent(requestParameters: ComponentsApiDeleteComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteComponentV1Response>;
/**
*
* @summary Duplicate a list of components
* @param {ComponentsApiDuplicateComponentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
duplicateComponents(requestParameters: ComponentsApiDuplicateComponentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DuplicateComponentsV1Response>;
/**
*
* @summary Erase a component without queuing a delete action
* @param {ComponentsApiEraseComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
eraseComponent(requestParameters: ComponentsApiEraseComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<EraseComponentV1Response>;
/**
*
* @summary Execute a component\'s management function
* @param {ComponentsApiExecuteManagementFunctionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
executeManagementFunction(requestParameters: ComponentsApiExecuteManagementFunctionRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecuteManagementFunctionV1Response>;
/**
*
* @summary Find a component by name or component Id
* @param {ComponentsApiFindComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
/**
*
* @summary Get a component by component Id
* @param {ComponentsApiGetComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
getComponent(requestParameters: ComponentsApiGetComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
/**
*
* @summary Get a component resource by component Id
* @param {ComponentsApiGetComponentResourceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
getComponentResource(requestParameters: ComponentsApiGetComponentResourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentResourceDataV1Response>;
/**
*
* @summary List all components
* @param {ComponentsApiListComponentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
listComponents(requestParameters: ComponentsApiListComponentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListComponentsV1Response>;
/**
*
* @summary Putting a component under the management of another component
* @param {ComponentsApiManageComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
manageComponent(requestParameters: ComponentsApiManageComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ManageComponentV1Response>;
/**
*
* @summary Restore a component that is marked for deletion
* @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
restoreComponent(requestParameters: ComponentsApiRestoreComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<RestoreComponentV1Response>;
/**
*
* @summary Complex search for components
* @param {ComponentsApiSearchComponentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
searchComponents(requestParameters: ComponentsApiSearchComponentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchComponentsV1Response>;
/**
*
* @summary Update a component
* @param {ComponentsApiUpdateComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
updateComponent(requestParameters: ComponentsApiUpdateComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateComponentV1Response>;
/**
*
* @summary Upgrade a component to the latest schema variant
* @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApiInterface
*/
upgradeComponent(requestParameters: ComponentsApiUpgradeComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpgradeComponentV1Response>;
}
/**
* Request parameters for addAction operation in ComponentsApi.
* @export
* @interface ComponentsApiAddActionRequest
*/
export interface ComponentsApiAddActionRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiAddAction
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiAddAction
*/
readonly changeSetId: string;
/**
* Component identifier
* @type {string}
* @memberof ComponentsApiAddAction
*/
readonly componentId: string;
/**
*
* @type {AddActionV1Request}
* @memberof ComponentsApiAddAction
*/
readonly addActionV1Request: AddActionV1Request;
}
/**
* Request parameters for addToView operation in ComponentsApi.
* @export
* @interface ComponentsApiAddToViewRequest
*/
export interface ComponentsApiAddToViewRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiAddToView
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiAddToView
*/
readonly changeSetId: string;
/**
*
* @type {AddToViewV1Request}
* @memberof ComponentsApiAddToView
*/
readonly addToViewV1Request: AddToViewV1Request;
}
/**
* Request parameters for createComponent operation in ComponentsApi.
* @export
* @interface ComponentsApiCreateComponentRequest
*/
export interface ComponentsApiCreateComponentRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiCreateComponent
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiCreateComponent
*/
readonly changeSetId: string;
/**
*
* @type {CreateComponentV1Request}
* @memberof ComponentsApiCreateComponent
*/
readonly createComponentV1Request: CreateComponentV1Request;
}
/**
* Request parameters for deleteComponent operation in ComponentsApi.
* @export
* @interface ComponentsApiDeleteComponentRequest
*/
export interface ComponentsApiDeleteComponentRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiDeleteComponent
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiDeleteComponent
*/
readonly changeSetId: string;
/**
* Component identifier
* @type {string}
* @memberof ComponentsApiDeleteComponent
*/
readonly componentId: string;
}
/**
* Request parameters for duplicateComponents operation in ComponentsApi.
* @export
* @interface ComponentsApiDuplicateComponentsRequest
*/
export interface ComponentsApiDuplicateComponentsRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiDuplicateComponents
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiDuplicateComponents
*/
readonly changeSetId: string;
/**
*
* @type {DuplicateComponentsV1Request}
* @memberof ComponentsApiDuplicateComponents
*/
readonly duplicateComponentsV1Request: DuplicateComponentsV1Request;
}
/**
* Request parameters for eraseComponent operation in ComponentsApi.
* @export
* @interface ComponentsApiEraseComponentRequest
*/
export interface ComponentsApiEraseComponentRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiEraseComponent
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiEraseComponent
*/
readonly changeSetId: string;
/**
* Component identifier
* @type {string}
* @memberof ComponentsApiEraseComponent
*/
readonly componentId: string;
}
/**
* Request parameters for executeManagementFunction operation in ComponentsApi.
* @export
* @interface ComponentsApiExecuteManagementFunctionRequest
*/
export interface ComponentsApiExecuteManagementFunctionRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiExecuteManagementFunction
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiExecuteManagementFunction
*/
readonly changeSetId: string;
/**
* Component identifier
* @type {string}
* @memberof ComponentsApiExecuteManagementFunction
*/
readonly componentId: string;
/**
*
* @type {ExecuteManagementFunctionV1Request}
* @memberof ComponentsApiExecuteManagementFunction
*/
readonly executeManagementFunctionV1Request: ExecuteManagementFunctionV1Request;
}
/**
* Request parameters for findComponent operation in ComponentsApi.
* @export
* @interface ComponentsApiFindComponentRequest
*/
export interface ComponentsApiFindComponentRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiFindComponent
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiFindComponent
*/
readonly changeSetId: string;
/**
*
* @type {string}
* @memberof ComponentsApiFindComponent
*/
readonly component?: string | null;
/**
*
* @type {string}
* @memberof ComponentsApiFindComponent
*/
readonly componentId?: string | null;
}
/**
* Request parameters for getComponent operation in ComponentsApi.
* @export
* @interface ComponentsApiGetComponentRequest
*/
export interface ComponentsApiGetComponentRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiGetComponent
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiGetComponent
*/
readonly changeSetId: string;
/**
* Component identifier
* @type {string}
* @memberof ComponentsApiGetComponent
*/
readonly componentId: string;
}
/**
* Request parameters for getComponentResource operation in ComponentsApi.
* @export
* @interface ComponentsApiGetComponentResourceRequest
*/
export interface ComponentsApiGetComponentResourceRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiGetComponentResource
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiGetComponentResource
*/
readonly changeSetId: string;
/**
* Component identifier
* @type {string}
* @memberof ComponentsApiGetComponentResource
*/
readonly componentId: string;
}
/**
* Request parameters for listComponents operation in ComponentsApi.
* @export
* @interface ComponentsApiListComponentsRequest
*/
export interface ComponentsApiListComponentsRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiListComponents
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiListComponents
*/
readonly changeSetId: string;
/**
* Maximum number of results to return (default: 50, max: 300)
* @type {string}
* @memberof ComponentsApiListComponents
*/
readonly limit?: string;
/**
* Cursor for pagination (ComponentId of the last item from previous page)
* @type {string}
* @memberof ComponentsApiListComponents
*/
readonly cursor?: string;
/**
* Allow returning the codegen for the cloudformation template for the component (if it exists)
* @type {boolean}
* @memberof ComponentsApiListComponents
*/
readonly includeCodegen?: boolean;
}
/**
* Request parameters for manageComponent operation in ComponentsApi.
* @export
* @interface ComponentsApiManageComponentRequest
*/
export interface ComponentsApiManageComponentRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiManageComponent
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiManageComponent
*/
readonly changeSetId: string;
/**
* Component identifier
* @type {string}
* @memberof ComponentsApiManageComponent
*/
readonly componentId: string;
/**
*
* @type {ManageComponentV1Request}
* @memberof ComponentsApiManageComponent
*/
readonly manageComponentV1Request: ManageComponentV1Request;
}
/**
* Request parameters for restoreComponent operation in ComponentsApi.
* @export
* @interface ComponentsApiRestoreComponentRequest
*/
export interface ComponentsApiRestoreComponentRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiRestoreComponent
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiRestoreComponent
*/
readonly changeSetId: string;
/**
* Component identifier
* @type {string}
* @memberof ComponentsApiRestoreComponent
*/
readonly componentId: string;
}
/**
* Request parameters for searchComponents operation in ComponentsApi.
* @export
* @interface ComponentsApiSearchComponentsRequest
*/
export interface ComponentsApiSearchComponentsRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiSearchComponents
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiSearchComponents
*/
readonly changeSetId: string;
/**
*
* @type {SearchComponentsV1Request}
* @memberof ComponentsApiSearchComponents
*/
readonly searchComponentsV1Request: SearchComponentsV1Request;
}
/**
* Request parameters for updateComponent operation in ComponentsApi.
* @export
* @interface ComponentsApiUpdateComponentRequest
*/
export interface ComponentsApiUpdateComponentRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiUpdateComponent
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiUpdateComponent
*/
readonly changeSetId: string;
/**
* Component identifier
* @type {string}
* @memberof ComponentsApiUpdateComponent
*/
readonly componentId: string;
/**
*
* @type {UpdateComponentV1Request}
* @memberof ComponentsApiUpdateComponent
*/
readonly updateComponentV1Request: UpdateComponentV1Request;
}
/**
* Request parameters for upgradeComponent operation in ComponentsApi.
* @export
* @interface ComponentsApiUpgradeComponentRequest
*/
export interface ComponentsApiUpgradeComponentRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ComponentsApiUpgradeComponent
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ComponentsApiUpgradeComponent
*/
readonly changeSetId: string;
/**
* Component identifier
* @type {string}
* @memberof ComponentsApiUpgradeComponent
*/
readonly componentId: string;
}
/**
* ComponentsApi - object-oriented interface
* @export
* @class ComponentsApi
* @extends {BaseAPI}
*/
export declare class ComponentsApi extends BaseAPI implements ComponentsApiInterface {
/**
*
* @summary Queue action for a component
* @param {ComponentsApiAddActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
addAction(requestParameters: ComponentsApiAddActionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddActionV1Response, any, {}>>;
/**
* Adds multiple components to a view by name. If the view doesn\'t exist, it will be created automatically.
* @summary Add components to a view
* @param {ComponentsApiAddToViewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
addToView(requestParameters: ComponentsApiAddToViewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
/**
*
* @summary Create a component
* @param {ComponentsApiCreateComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
createComponent(requestParameters: ComponentsApiCreateComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateComponentV1Response, any, {}>>;
/**
*
* @summary Delete a component
* @param {ComponentsApiDeleteComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
deleteComponent(requestParameters: ComponentsApiDeleteComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteComponentV1Response, any, {}>>;
/**
*
* @summary Duplicate a list of components
* @param {ComponentsApiDuplicateComponentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
duplicateComponents(requestParameters: ComponentsApiDuplicateComponentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DuplicateComponentsV1Response, any, {}>>;
/**
*
* @summary Erase a component without queuing a delete action
* @param {ComponentsApiEraseComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
eraseComponent(requestParameters: ComponentsApiEraseComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EraseComponentV1Response, any, {}>>;
/**
*
* @summary Execute a component\'s management function
* @param {ComponentsApiExecuteManagementFunctionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
executeManagementFunction(requestParameters: ComponentsApiExecuteManagementFunctionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteManagementFunctionV1Response, any, {}>>;
/**
*
* @summary Find a component by name or component Id
* @param {ComponentsApiFindComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetComponentV1Response, any, {}>>;
/**
*
* @summary Get a component by component Id
* @param {ComponentsApiGetComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
getComponent(requestParameters: ComponentsApiGetComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetComponentV1Response, any, {}>>;
/**
*
* @summary Get a component resource by component Id
* @param {ComponentsApiGetComponentResourceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
getComponentResource(requestParameters: ComponentsApiGetComponentResourceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetComponentResourceDataV1Response, any, {}>>;
/**
*
* @summary List all components
* @param {ComponentsApiListComponentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
listComponents(requestParameters: ComponentsApiListComponentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListComponentsV1Response, any, {}>>;
/**
*
* @summary Putting a component under the management of another component
* @param {ComponentsApiManageComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
manageComponent(requestParameters: ComponentsApiManageComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ManageComponentV1Response, any, {}>>;
/**
*
* @summary Restore a component that is marked for deletion
* @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
restoreComponent(requestParameters: ComponentsApiRestoreComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RestoreComponentV1Response, any, {}>>;
/**
*
* @summary Complex search for components
* @param {ComponentsApiSearchComponentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
searchComponents(requestParameters: ComponentsApiSearchComponentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchComponentsV1Response, any, {}>>;
/**
*
* @summary Update a component
* @param {ComponentsApiUpdateComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
updateComponent(requestParameters: ComponentsApiUpdateComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateComponentV1Response, any, {}>>;
/**
*
* @summary Upgrade a component to the latest schema variant
* @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ComponentsApi
*/
upgradeComponent(requestParameters: ComponentsApiUpgradeComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpgradeComponentV1Response, any, {}>>;
}
/**
* DebugFuncsApi - axios parameter creator
* @export
*/
export declare const DebugFuncsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Execute a debug function in the context of a component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {ExecDebugFuncV1Request} execDebugFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
execDebugFunc: (workspaceId: string, changeSetId: string, execDebugFuncV1Request: ExecDebugFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get debug funcs job state details
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} debugFuncJobStateId Debug Func Job identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDebugFuncState: (workspaceId: string, changeSetId: string, debugFuncJobStateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* DebugFuncsApi - functional programming interface
* @export
*/
export declare const DebugFuncsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Execute a debug function in the context of a component
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {ExecDebugFuncV1Request} execDebugFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
execDebugFunc(workspaceId: string, changeSetId: string, execDebugFuncV1Request: ExecDebugFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecDebugFuncV1Response>>;
/**
*
* @summary Get debug funcs job state details
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} debugFuncJobStateId Debug Func Job identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDebugFuncState(workspaceId: string, changeSetId: string, debugFuncJobStateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDebugFuncJobStateV1Response>>;
};
/**
* DebugFuncsApi - factory interface
* @export
*/
export declare const DebugFuncsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Execute a debug function in the context of a component
* @param {DebugFuncsApiExecDebugFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
execDebugFunc(requestParameters: DebugFuncsApiExecDebugFuncRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecDebugFuncV1Response>;
/**
*
* @summary Get debug funcs job state details
* @param {DebugFuncsApiGetDebugFuncStateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDebugFuncState(requestParameters: DebugFuncsApiGetDebugFuncStateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDebugFuncJobStateV1Response>;
};
/**
* DebugFuncsApi - interface
* @export
* @interface DebugFuncsApi
*/
export interface DebugFuncsApiInterface {
/**
*
* @summary Execute a debug function in the context of a component
* @param {DebugFuncsApiExecDebugFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DebugFuncsApiInterface
*/
execDebugFunc(requestParameters: DebugFuncsApiExecDebugFuncRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecDebugFuncV1Response>;
/**
*
* @summary Get debug funcs job state details
* @param {DebugFuncsApiGetDebugFuncStateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DebugFuncsApiInterface
*/
getDebugFuncState(requestParameters: DebugFuncsApiGetDebugFuncStateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDebugFuncJobStateV1Response>;
}
/**
* Request parameters for execDebugFunc operation in DebugFuncsApi.
* @export
* @interface DebugFuncsApiExecDebugFuncRequest
*/
export interface DebugFuncsApiExecDebugFuncRequest {
/**
* Workspace identifier
* @type {string}
* @memberof DebugFuncsApiExecDebugFunc
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof DebugFuncsApiExecDebugFunc
*/
readonly changeSetId: string;
/**
*
* @type {ExecDebugFuncV1Request}
* @memberof DebugFuncsApiExecDebugFunc
*/
readonly execDebugFuncV1Request: ExecDebugFuncV1Request;
}
/**
* Request parameters for getDebugFuncState operation in DebugFuncsApi.
* @export
* @interface DebugFuncsApiGetDebugFuncStateRequest
*/
export interface DebugFuncsApiGetDebugFuncStateRequest {
/**
* Workspace identifier
* @type {string}
* @memberof DebugFuncsApiGetDebugFuncState
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof DebugFuncsApiGetDebugFuncState
*/
readonly changeSetId: string;
/**
* Debug Func Job identifier
* @type {string}
* @memberof DebugFuncsApiGetDebugFuncState
*/
readonly debugFuncJobStateId: string;
}
/**
* DebugFuncsApi - object-oriented interface
* @export
* @class DebugFuncsApi
* @extends {BaseAPI}
*/
export declare class DebugFuncsApi extends BaseAPI implements DebugFuncsApiInterface {
/**
*
* @summary Execute a debug function in the context of a component
* @param {DebugFuncsApiExecDebugFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DebugFuncsApi
*/
execDebugFunc(requestParameters: DebugFuncsApiExecDebugFuncRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecDebugFuncV1Response, any, {}>>;
/**
*
* @summary Get debug funcs job state details
* @param {DebugFuncsApiGetDebugFuncStateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DebugFuncsApi
*/
getDebugFuncState(requestParameters: DebugFuncsApiGetDebugFuncStateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDebugFuncJobStateV1Response, any, {}>>;
}
/**
* FuncsApi - axios parameter creator
* @export
*/
export declare const FuncsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Create a transformation function
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {CreateTransformationFuncV1Request} createTransformationFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createTransformation: (workspaceId: string, changeSetId: string, createTransformationFuncV1Request: CreateTransformationFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get function details
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFunc: (workspaceId: string, changeSetId: string, funcId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get func execution run logs
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} funcRunId Func run identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFuncRun: (workspaceId: string, changeSetId: string, funcRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Unlocks a func - if there\'s already an unlocked function, then we return that
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} funcId Func identifier
* @param {UnlockFuncV1Request} unlockFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unlockFunc: (workspaceId: string, changeSetId: string, funcId: string, unlockFuncV1Request: UnlockFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update a func
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} funcId Func identifier
* @param {UpdateFuncV1Request} updateFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateFunc: (workspaceId: string, changeSetId: string, funcId: string, updateFuncV1Request: UpdateFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* FuncsApi - functional programming interface
* @export
*/
export declare const FuncsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Create a transformation function
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {CreateTransformationFuncV1Request} createTransformationFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createTransformation(workspaceId: string, changeSetId: string, createTransformationFuncV1Request: CreateTransformationFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTransformationFuncV1Response>>;
/**
*
* @summary Get function details
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFunc(workspaceId: string, changeSetId: string, funcId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFuncV1Response>>;
/**
*
* @summary Get func execution run logs
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} funcRunId Func run identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFuncRun(workspaceId: string, changeSetId: string, funcRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFuncRunV1Response>>;
/**
*
* @summary Unlocks a func - if there\'s already an unlocked function, then we return that
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} funcId Func identifier
* @param {UnlockFuncV1Request} unlockFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unlockFunc(workspaceId: string, changeSetId: string, funcId: string, unlockFuncV1Request: UnlockFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnlockFuncV1Response>>;
/**
*
* @summary Update a func
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} funcId Func identifier
* @param {UpdateFuncV1Request} updateFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateFunc(workspaceId: string, changeSetId: string, funcId: string, updateFuncV1Request: UpdateFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFuncV1Response>>;
};
/**
* FuncsApi - factory interface
* @export
*/
export declare const FuncsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Create a transformation function
* @param {FuncsApiCreateTransformationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createTransformation(requestParameters: FuncsApiCreateTransformationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateTransformationFuncV1Response>;
/**
*
* @summary Get function details
* @param {FuncsApiGetFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFunc(requestParameters: FuncsApiGetFuncRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFuncV1Response>;
/**
*
* @summary Get func execution run logs
* @param {FuncsApiGetFuncRunRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFuncRun(requestParameters: FuncsApiGetFuncRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFuncRunV1Response>;
/**
*
* @summary Unlocks a func - if there\'s already an unlocked function, then we return that
* @param {FuncsApiUnlockFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unlockFunc(requestParameters: FuncsApiUnlockFuncRequest, options?: RawAxiosRequestConfig): AxiosPromise<UnlockFuncV1Response>;
/**
*
* @summary Update a func
* @param {FuncsApiUpdateFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateFunc(requestParameters: FuncsApiUpdateFuncRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateFuncV1Response>;
};
/**
* FuncsApi - interface
* @export
* @interface FuncsApi
*/
export interface FuncsApiInterface {
/**
*
* @summary Create a transformation function
* @param {FuncsApiCreateTransformationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuncsApiInterface
*/
createTransformation(requestParameters: FuncsApiCreateTransformationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateTransformationFuncV1Response>;
/**
*
* @summary Get function details
* @param {FuncsApiGetFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuncsApiInterface
*/
getFunc(requestParameters: FuncsApiGetFuncRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFuncV1Response>;
/**
*
* @summary Get func execution run logs
* @param {FuncsApiGetFuncRunRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuncsApiInterface
*/
getFuncRun(requestParameters: FuncsApiGetFuncRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFuncRunV1Response>;
/**
*
* @summary Unlocks a func - if there\'s already an unlocked function, then we return that
* @param {FuncsApiUnlockFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuncsApiInterface
*/
unlockFunc(requestParameters: FuncsApiUnlockFuncRequest, options?: RawAxiosRequestConfig): AxiosPromise<UnlockFuncV1Response>;
/**
*
* @summary Update a func
* @param {FuncsApiUpdateFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuncsApiInterface
*/
updateFunc(requestParameters: FuncsApiUpdateFuncRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateFuncV1Response>;
}
/**
* Request parameters for createTransformation operation in FuncsApi.
* @export
* @interface FuncsApiCreateTransformationRequest
*/
export interface FuncsApiCreateTransformationRequest {
/**
* Workspace identifier
* @type {string}
* @memberof FuncsApiCreateTransformation
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof FuncsApiCreateTransformation
*/
readonly changeSetId: string;
/**
*
* @type {CreateTransformationFuncV1Request}
* @memberof FuncsApiCreateTransformation
*/
readonly createTransformationFuncV1Request: CreateTransformationFuncV1Request;
}
/**
* Request parameters for getFunc operation in FuncsApi.
* @export
* @interface FuncsApiGetFuncRequest
*/
export interface FuncsApiGetFuncRequest {
/**
* Workspace identifier
* @type {string}
* @memberof FuncsApiGetFunc
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof FuncsApiGetFunc
*/
readonly changeSetId: string;
/**
* Func identifier
* @type {string}
* @memberof FuncsApiGetFunc
*/
readonly funcId: string;
}
/**
* Request parameters for getFuncRun operation in FuncsApi.
* @export
* @interface FuncsApiGetFuncRunRequest
*/
export interface FuncsApiGetFuncRunRequest {
/**
* Workspace identifier
* @type {string}
* @memberof FuncsApiGetFuncRun
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof FuncsApiGetFuncRun
*/
readonly changeSetId: string;
/**
* Func run identifier
* @type {string}
* @memberof FuncsApiGetFuncRun
*/
readonly funcRunId: string;
}
/**
* Request parameters for unlockFunc operation in FuncsApi.
* @export
* @interface FuncsApiUnlockFuncRequest
*/
export interface FuncsApiUnlockFuncRequest {
/**
* Workspace identifier
* @type {string}
* @memberof FuncsApiUnlockFunc
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof FuncsApiUnlockFunc
*/
readonly changeSetId: string;
/**
* Func identifier
* @type {string}
* @memberof FuncsApiUnlockFunc
*/
readonly funcId: string;
/**
*
* @type {UnlockFuncV1Request}
* @memberof FuncsApiUnlockFunc
*/
readonly unlockFuncV1Request: UnlockFuncV1Request;
}
/**
* Request parameters for updateFunc operation in FuncsApi.
* @export
* @interface FuncsApiUpdateFuncRequest
*/
export interface FuncsApiUpdateFuncRequest {
/**
* Workspace identifier
* @type {string}
* @memberof FuncsApiUpdateFunc
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof FuncsApiUpdateFunc
*/
readonly changeSetId: string;
/**
* Func identifier
* @type {string}
* @memberof FuncsApiUpdateFunc
*/
readonly funcId: string;
/**
*
* @type {UpdateFuncV1Request}
* @memberof FuncsApiUpdateFunc
*/
readonly updateFuncV1Request: UpdateFuncV1Request;
}
/**
* FuncsApi - object-oriented interface
* @export
* @class FuncsApi
* @extends {BaseAPI}
*/
export declare class FuncsApi extends BaseAPI implements FuncsApiInterface {
/**
*
* @summary Create a transformation function
* @param {FuncsApiCreateTransformationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuncsApi
*/
createTransformation(requestParameters: FuncsApiCreateTransformationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTransformationFuncV1Response, any, {}>>;
/**
*
* @summary Get function details
* @param {FuncsApiGetFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuncsApi
*/
getFunc(requestParameters: FuncsApiGetFuncRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFuncV1Response, any, {}>>;
/**
*
* @summary Get func execution run logs
* @param {FuncsApiGetFuncRunRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuncsApi
*/
getFuncRun(requestParameters: FuncsApiGetFuncRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFuncRunV1Response, any, {}>>;
/**
*
* @summary Unlocks a func - if there\'s already an unlocked function, then we return that
* @param {FuncsApiUnlockFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuncsApi
*/
unlockFunc(requestParameters: FuncsApiUnlockFuncRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UnlockFuncV1Response, any, {}>>;
/**
*
* @summary Update a func
* @param {FuncsApiUpdateFuncRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuncsApi
*/
updateFunc(requestParameters: FuncsApiUpdateFuncRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFuncV1Response, any, {}>>;
}
/**
* ManagementFuncsApi - axios parameter creator
* @export
*/
export declare const ManagementFuncsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get management funcs job state details
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} managementFuncJobStateId Management Func Job identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getManagementFuncRunState: (workspaceId: string, changeSetId: string, managementFuncJobStateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ManagementFuncsApi - functional programming interface
* @export
*/
export declare const ManagementFuncsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get management funcs job state details
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} managementFuncJobStateId Management Func Job identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getManagementFuncRunState(workspaceId: string, changeSetId: string, managementFuncJobStateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetManagementFuncJobStateV1Response>>;
};
/**
* ManagementFuncsApi - factory interface
* @export
*/
export declare const ManagementFuncsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get management funcs job state details
* @param {ManagementFuncsApiGetManagementFuncRunStateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getManagementFuncRunState(requestParameters: ManagementFuncsApiGetManagementFuncRunStateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetManagementFuncJobStateV1Response>;
};
/**
* ManagementFuncsApi - interface
* @export
* @interface ManagementFuncsApi
*/
export interface ManagementFuncsApiInterface {
/**
*
* @summary Get management funcs job state details
* @param {ManagementFuncsApiGetManagementFuncRunStateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ManagementFuncsApiInterface
*/
getManagementFuncRunState(requestParameters: ManagementFuncsApiGetManagementFuncRunStateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetManagementFuncJobStateV1Response>;
}
/**
* Request parameters for getManagementFuncRunState operation in ManagementFuncsApi.
* @export
* @interface ManagementFuncsApiGetManagementFuncRunStateRequest
*/
export interface ManagementFuncsApiGetManagementFuncRunStateRequest {
/**
* Workspace identifier
* @type {string}
* @memberof ManagementFuncsApiGetManagementFuncRunState
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof ManagementFuncsApiGetManagementFuncRunState
*/
readonly changeSetId: string;
/**
* Management Func Job identifier
* @type {string}
* @memberof ManagementFuncsApiGetManagementFuncRunState
*/
readonly managementFuncJobStateId: string;
}
/**
* ManagementFuncsApi - object-oriented interface
* @export
* @class ManagementFuncsApi
* @extends {BaseAPI}
*/
export declare class ManagementFuncsApi extends BaseAPI implements ManagementFuncsApiInterface {
/**
*
* @summary Get management funcs job state details
* @param {ManagementFuncsApiGetManagementFuncRunStateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ManagementFuncsApi
*/
getManagementFuncRunState(requestParameters: ManagementFuncsApiGetManagementFuncRunStateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetManagementFuncJobStateV1Response, any, {}>>;
}
/**
* RootApi - axios parameter creator
* @export
*/
export declare const RootApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
systemStatusRoute: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* RootApi - functional programming interface
* @export
*/
export declare const RootApiFp: (configuration?: Configuration) => {
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
systemStatusRoute(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemStatusResponse>>;
};
/**
* RootApi - factory interface
* @export
*/
export declare const RootApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
systemStatusRoute(options?: RawAxiosRequestConfig): AxiosPromise<SystemStatusResponse>;
};
/**
* RootApi - interface
* @export
* @interface RootApi
*/
export interface RootApiInterface {
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RootApiInterface
*/
systemStatusRoute(options?: RawAxiosRequestConfig): AxiosPromise<SystemStatusResponse>;
}
/**
* RootApi - object-oriented interface
* @export
* @class RootApi
* @extends {BaseAPI}
*/
export declare class RootApi extends BaseAPI implements RootApiInterface {
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RootApi
*/
systemStatusRoute(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SystemStatusResponse, any, {}>>;
}
/**
* SchemasApi - axios parameter creator
* @export
*/
export declare const SchemasApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Contribute the default variant of a schema to the module index
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
contribute: (workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create a schema and it\'s default variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {CreateSchemaV1Request} createSchemaV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSchema: (workspaceId: string, changeSetId: string, createSchemaV1Request: CreateSchemaV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create an action function and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantActionFuncV1Request} createVariantActionFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantAction: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantActionFuncV1Request: CreateVariantActionFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create an attribute function and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantAttributeFuncV1Request} createVariantAttributeFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantAttribute: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantAttributeFuncV1Request: CreateVariantAttributeFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create an authentication function and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantAuthenticationFuncV1Request} createVariantAuthenticationFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantAuthentication: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantAuthenticationFuncV1Request: CreateVariantAuthenticationFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create a codegen function and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantCodegenFuncV1Request} createVariantCodegenFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantCodegen: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantCodegenFuncV1Request: CreateVariantCodegenFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create a management function and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantManagementFuncV1Request} createVariantManagementFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantManagement: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantManagementFuncV1Request: CreateVariantManagementFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create a qualification and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantQualificationFuncV1Request} createVariantQualificationFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantQualification: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantQualificationFuncV1Request: CreateVariantQualificationFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete the binding between an action func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachActionFuncBinding: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete the binding between an attribute func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachAttributeFuncBinding: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete the binding between an authentication func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachAuthenticationFuncBinding: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete the binding between a codegen func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachCodegenFuncBinding: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete the binding between a management func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachManagementFuncBinding: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete the binding between a qualification func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachQualificationFuncBinding: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Find schema by name or schema id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string | null} [schema]
* @param {string | null} [schemaId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findSchema: (workspaceId: string, changeSetId: string, schema?: string | null, schemaId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get the default variant for a schema id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDefaultVariant: (workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get a schema by schema id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSchema: (workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get a schema variant by schema id and schema variant id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVariant: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
installSchema: (workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary List all schemas (paginated endpoint)
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} [limit] Maximum number of results to return (default: 50, max: 300)
* @param {string} [cursor] Cursor for pagination (SchemaId of the last item from previous page)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listSchemas: (workspaceId: string, changeSetId: string, limit?: string, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Complex search for schemas
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {SearchSchemasV1Request} searchSchemasV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
searchSchemas: (workspaceId: string, changeSetId: string, searchSchemasV1Request: SearchSchemasV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Unlocks a schema - if there\'s already an unlocked variant, then we return that
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unlockSchema: (workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update the schema variant and regenerate
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {UpdateSchemaVariantV1Request} updateSchemaVariantV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSchemaVariant: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, updateSchemaVariantV1Request: UpdateSchemaVariantV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* SchemasApi - functional programming interface
* @export
*/
export declare const SchemasApiFp: (configuration?: Configuration) => {
/**
*
* @summary Contribute the default variant of a schema to the module index
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
contribute(workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Create a schema and it\'s default variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {CreateSchemaV1Request} createSchemaV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSchema(workspaceId: string, changeSetId: string, createSchemaV1Request: CreateSchemaV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSchemaV1Response>>;
/**
*
* @summary Create an action function and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantActionFuncV1Request} createVariantActionFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantAction(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantActionFuncV1Request: CreateVariantActionFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateVariantActionFuncV1Response>>;
/**
*
* @summary Create an attribute function and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantAttributeFuncV1Request} createVariantAttributeFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantAttribute(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantAttributeFuncV1Request: CreateVariantAttributeFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateVariantAttributeFuncV1Response>>;
/**
*
* @summary Create an authentication function and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantAuthenticationFuncV1Request} createVariantAuthenticationFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantAuthentication(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantAuthenticationFuncV1Request: CreateVariantAuthenticationFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateVariantAuthenticationFuncV1Response>>;
/**
*
* @summary Create a codegen function and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantCodegenFuncV1Request} createVariantCodegenFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantCodegen(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantCodegenFuncV1Request: CreateVariantCodegenFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateVariantCodegenFuncV1Response>>;
/**
*
* @summary Create a management function and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantManagementFuncV1Request} createVariantManagementFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantManagement(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantManagementFuncV1Request: CreateVariantManagementFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateVariantManagementFuncV1Response>>;
/**
*
* @summary Create a qualification and attach to a schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {CreateVariantQualificationFuncV1Request} createVariantQualificationFuncV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantQualification(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, createVariantQualificationFuncV1Request: CreateVariantQualificationFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateVariantQualificationFuncV1Response>>;
/**
*
* @summary Delete the binding between an action func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachActionFuncBinding(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetachFuncBindingV1Response>>;
/**
*
* @summary Delete the binding between an attribute func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachAttributeFuncBinding(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetachFuncBindingV1Response>>;
/**
*
* @summary Delete the binding between an authentication func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachAuthenticationFuncBinding(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetachFuncBindingV1Response>>;
/**
*
* @summary Delete the binding between a codegen func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachCodegenFuncBinding(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetachFuncBindingV1Response>>;
/**
*
* @summary Delete the binding between a management func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachManagementFuncBinding(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetachFuncBindingV1Response>>;
/**
*
* @summary Delete the binding between a qualification func and the schema variant
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {string} funcId Func identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachQualificationFuncBinding(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, funcId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetachFuncBindingV1Response>>;
/**
*
* @summary Find schema by name or schema id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string | null} [schema]
* @param {string | null} [schemaId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findSchema(workspaceId: string, changeSetId: string, schema?: string | null, schemaId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FindSchemaV1Response>>;
/**
*
* @summary Get the default variant for a schema id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDefaultVariant(workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSchemaVariantV1Response>>;
/**
*
* @summary Get a schema by schema id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSchema(workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSchemaV1Response>>;
/**
*
* @summary Get a schema variant by schema id and schema variant id
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVariant(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSchemaVariantV1Response>>;
/**
*
* @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
installSchema(workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSchemaV1Response>>;
/**
*
* @summary List all schemas (paginated endpoint)
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} [limit] Maximum number of results to return (default: 50, max: 300)
* @param {string} [cursor] Cursor for pagination (SchemaId of the last item from previous page)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listSchemas(workspaceId: string, changeSetId: string, limit?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSchemaV1Response>>;
/**
*
* @summary Complex search for schemas
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {SearchSchemasV1Request} searchSchemasV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
searchSchemas(workspaceId: string, changeSetId: string, searchSchemasV1Request: SearchSchemasV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchSchemasV1Response>>;
/**
*
* @summary Unlocks a schema - if there\'s already an unlocked variant, then we return that
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unlockSchema(workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnlockedSchemaV1Response>>;
/**
*
* @summary Update the schema variant and regenerate
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} schemaId Schema identifier
* @param {string} schemaVariantId Schema variant identifier
* @param {UpdateSchemaVariantV1Request} updateSchemaVariantV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSchemaVariant(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, updateSchemaVariantV1Request: UpdateSchemaVariantV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSchemaVariantV1Response>>;
};
/**
* SchemasApi - factory interface
* @export
*/
export declare const SchemasApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Contribute the default variant of a schema to the module index
* @param {SchemasApiContributeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
contribute(requestParameters: SchemasApiContributeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Create a schema and it\'s default variant
* @param {SchemasApiCreateSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSchema(requestParameters: SchemasApiCreateSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaV1Response>;
/**
*
* @summary Create an action function and attach to a schema variant
* @param {SchemasApiCreateVariantActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantAction(requestParameters: SchemasApiCreateVariantActionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantActionFuncV1Response>;
/**
*
* @summary Create an attribute function and attach to a schema variant
* @param {SchemasApiCreateVariantAttributeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantAttribute(requestParameters: SchemasApiCreateVariantAttributeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantAttributeFuncV1Response>;
/**
*
* @summary Create an authentication function and attach to a schema variant
* @param {SchemasApiCreateVariantAuthenticationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantAuthentication(requestParameters: SchemasApiCreateVariantAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantAuthenticationFuncV1Response>;
/**
*
* @summary Create a codegen function and attach to a schema variant
* @param {SchemasApiCreateVariantCodegenRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantCodegen(requestParameters: SchemasApiCreateVariantCodegenRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantCodegenFuncV1Response>;
/**
*
* @summary Create a management function and attach to a schema variant
* @param {SchemasApiCreateVariantManagementRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantManagement(requestParameters: SchemasApiCreateVariantManagementRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantManagementFuncV1Response>;
/**
*
* @summary Create a qualification and attach to a schema variant
* @param {SchemasApiCreateVariantQualificationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createVariantQualification(requestParameters: SchemasApiCreateVariantQualificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantQualificationFuncV1Response>;
/**
*
* @summary Delete the binding between an action func and the schema variant
* @param {SchemasApiDetachActionFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachActionFuncBinding(requestParameters: SchemasApiDetachActionFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Delete the binding between an attribute func and the schema variant
* @param {SchemasApiDetachAttributeFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachAttributeFuncBinding(requestParameters: SchemasApiDetachAttributeFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Delete the binding between an authentication func and the schema variant
* @param {SchemasApiDetachAuthenticationFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachAuthenticationFuncBinding(requestParameters: SchemasApiDetachAuthenticationFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Delete the binding between a codegen func and the schema variant
* @param {SchemasApiDetachCodegenFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachCodegenFuncBinding(requestParameters: SchemasApiDetachCodegenFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Delete the binding between a management func and the schema variant
* @param {SchemasApiDetachManagementFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachManagementFuncBinding(requestParameters: SchemasApiDetachManagementFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Delete the binding between a qualification func and the schema variant
* @param {SchemasApiDetachQualificationFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
detachQualificationFuncBinding(requestParameters: SchemasApiDetachQualificationFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Find schema by name or schema id
* @param {SchemasApiFindSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
findSchema(requestParameters: SchemasApiFindSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<FindSchemaV1Response>;
/**
*
* @summary Get the default variant for a schema id
* @param {SchemasApiGetDefaultVariantRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDefaultVariant(requestParameters: SchemasApiGetDefaultVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
/**
*
* @summary Get a schema by schema id
* @param {SchemasApiGetSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSchema(requestParameters: SchemasApiGetSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaV1Response>;
/**
*
* @summary Get a schema variant by schema id and schema variant id
* @param {SchemasApiGetVariantRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVariant(requestParameters: SchemasApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
/**
*
* @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
* @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
installSchema(requestParameters: SchemasApiInstallSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaV1Response>;
/**
*
* @summary List all schemas (paginated endpoint)
* @param {SchemasApiListSchemasRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listSchemas(requestParameters: SchemasApiListSchemasRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListSchemaV1Response>;
/**
*
* @summary Complex search for schemas
* @param {SchemasApiSearchSchemasRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
searchSchemas(requestParameters: SchemasApiSearchSchemasRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchSchemasV1Response>;
/**
*
* @summary Unlocks a schema - if there\'s already an unlocked variant, then we return that
* @param {SchemasApiUnlockSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unlockSchema(requestParameters: SchemasApiUnlockSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<UnlockedSchemaV1Response>;
/**
*
* @summary Update the schema variant and regenerate
* @param {SchemasApiUpdateSchemaVariantRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSchemaVariant(requestParameters: SchemasApiUpdateSchemaVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
};
/**
* SchemasApi - interface
* @export
* @interface SchemasApi
*/
export interface SchemasApiInterface {
/**
*
* @summary Contribute the default variant of a schema to the module index
* @param {SchemasApiContributeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
contribute(requestParameters: SchemasApiContributeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Create a schema and it\'s default variant
* @param {SchemasApiCreateSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
createSchema(requestParameters: SchemasApiCreateSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaV1Response>;
/**
*
* @summary Create an action function and attach to a schema variant
* @param {SchemasApiCreateVariantActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
createVariantAction(requestParameters: SchemasApiCreateVariantActionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantActionFuncV1Response>;
/**
*
* @summary Create an attribute function and attach to a schema variant
* @param {SchemasApiCreateVariantAttributeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
createVariantAttribute(requestParameters: SchemasApiCreateVariantAttributeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantAttributeFuncV1Response>;
/**
*
* @summary Create an authentication function and attach to a schema variant
* @param {SchemasApiCreateVariantAuthenticationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
createVariantAuthentication(requestParameters: SchemasApiCreateVariantAuthenticationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantAuthenticationFuncV1Response>;
/**
*
* @summary Create a codegen function and attach to a schema variant
* @param {SchemasApiCreateVariantCodegenRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
createVariantCodegen(requestParameters: SchemasApiCreateVariantCodegenRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantCodegenFuncV1Response>;
/**
*
* @summary Create a management function and attach to a schema variant
* @param {SchemasApiCreateVariantManagementRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
createVariantManagement(requestParameters: SchemasApiCreateVariantManagementRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantManagementFuncV1Response>;
/**
*
* @summary Create a qualification and attach to a schema variant
* @param {SchemasApiCreateVariantQualificationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
createVariantQualification(requestParameters: SchemasApiCreateVariantQualificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateVariantQualificationFuncV1Response>;
/**
*
* @summary Delete the binding between an action func and the schema variant
* @param {SchemasApiDetachActionFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
detachActionFuncBinding(requestParameters: SchemasApiDetachActionFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Delete the binding between an attribute func and the schema variant
* @param {SchemasApiDetachAttributeFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
detachAttributeFuncBinding(requestParameters: SchemasApiDetachAttributeFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Delete the binding between an authentication func and the schema variant
* @param {SchemasApiDetachAuthenticationFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
detachAuthenticationFuncBinding(requestParameters: SchemasApiDetachAuthenticationFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Delete the binding between a codegen func and the schema variant
* @param {SchemasApiDetachCodegenFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
detachCodegenFuncBinding(requestParameters: SchemasApiDetachCodegenFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Delete the binding between a management func and the schema variant
* @param {SchemasApiDetachManagementFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
detachManagementFuncBinding(requestParameters: SchemasApiDetachManagementFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Delete the binding between a qualification func and the schema variant
* @param {SchemasApiDetachQualificationFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
detachQualificationFuncBinding(requestParameters: SchemasApiDetachQualificationFuncBindingRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetachFuncBindingV1Response>;
/**
*
* @summary Find schema by name or schema id
* @param {SchemasApiFindSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
findSchema(requestParameters: SchemasApiFindSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<FindSchemaV1Response>;
/**
*
* @summary Get the default variant for a schema id
* @param {SchemasApiGetDefaultVariantRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
getDefaultVariant(requestParameters: SchemasApiGetDefaultVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
/**
*
* @summary Get a schema by schema id
* @param {SchemasApiGetSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
getSchema(requestParameters: SchemasApiGetSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaV1Response>;
/**
*
* @summary Get a schema variant by schema id and schema variant id
* @param {SchemasApiGetVariantRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
getVariant(requestParameters: SchemasApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
/**
*
* @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
* @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
installSchema(requestParameters: SchemasApiInstallSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaV1Response>;
/**
*
* @summary List all schemas (paginated endpoint)
* @param {SchemasApiListSchemasRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
listSchemas(requestParameters: SchemasApiListSchemasRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListSchemaV1Response>;
/**
*
* @summary Complex search for schemas
* @param {SchemasApiSearchSchemasRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
searchSchemas(requestParameters: SchemasApiSearchSchemasRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchSchemasV1Response>;
/**
*
* @summary Unlocks a schema - if there\'s already an unlocked variant, then we return that
* @param {SchemasApiUnlockSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
unlockSchema(requestParameters: SchemasApiUnlockSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<UnlockedSchemaV1Response>;
/**
*
* @summary Update the schema variant and regenerate
* @param {SchemasApiUpdateSchemaVariantRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApiInterface
*/
updateSchemaVariant(requestParameters: SchemasApiUpdateSchemaVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
}
/**
* Request parameters for contribute operation in SchemasApi.
* @export
* @interface SchemasApiContributeRequest
*/
export interface SchemasApiContributeRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiContribute
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiContribute
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiContribute
*/
readonly schemaId: string;
}
/**
* Request parameters for createSchema operation in SchemasApi.
* @export
* @interface SchemasApiCreateSchemaRequest
*/
export interface SchemasApiCreateSchemaRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiCreateSchema
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiCreateSchema
*/
readonly changeSetId: string;
/**
*
* @type {CreateSchemaV1Request}
* @memberof SchemasApiCreateSchema
*/
readonly createSchemaV1Request: CreateSchemaV1Request;
}
/**
* Request parameters for createVariantAction operation in SchemasApi.
* @export
* @interface SchemasApiCreateVariantActionRequest
*/
export interface SchemasApiCreateVariantActionRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiCreateVariantAction
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiCreateVariantAction
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiCreateVariantAction
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiCreateVariantAction
*/
readonly schemaVariantId: string;
/**
*
* @type {CreateVariantActionFuncV1Request}
* @memberof SchemasApiCreateVariantAction
*/
readonly createVariantActionFuncV1Request: CreateVariantActionFuncV1Request;
}
/**
* Request parameters for createVariantAttribute operation in SchemasApi.
* @export
* @interface SchemasApiCreateVariantAttributeRequest
*/
export interface SchemasApiCreateVariantAttributeRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiCreateVariantAttribute
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiCreateVariantAttribute
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiCreateVariantAttribute
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiCreateVariantAttribute
*/
readonly schemaVariantId: string;
/**
*
* @type {CreateVariantAttributeFuncV1Request}
* @memberof SchemasApiCreateVariantAttribute
*/
readonly createVariantAttributeFuncV1Request: CreateVariantAttributeFuncV1Request;
}
/**
* Request parameters for createVariantAuthentication operation in SchemasApi.
* @export
* @interface SchemasApiCreateVariantAuthenticationRequest
*/
export interface SchemasApiCreateVariantAuthenticationRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiCreateVariantAuthentication
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiCreateVariantAuthentication
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiCreateVariantAuthentication
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiCreateVariantAuthentication
*/
readonly schemaVariantId: string;
/**
*
* @type {CreateVariantAuthenticationFuncV1Request}
* @memberof SchemasApiCreateVariantAuthentication
*/
readonly createVariantAuthenticationFuncV1Request: CreateVariantAuthenticationFuncV1Request;
}
/**
* Request parameters for createVariantCodegen operation in SchemasApi.
* @export
* @interface SchemasApiCreateVariantCodegenRequest
*/
export interface SchemasApiCreateVariantCodegenRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiCreateVariantCodegen
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiCreateVariantCodegen
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiCreateVariantCodegen
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiCreateVariantCodegen
*/
readonly schemaVariantId: string;
/**
*
* @type {CreateVariantCodegenFuncV1Request}
* @memberof SchemasApiCreateVariantCodegen
*/
readonly createVariantCodegenFuncV1Request: CreateVariantCodegenFuncV1Request;
}
/**
* Request parameters for createVariantManagement operation in SchemasApi.
* @export
* @interface SchemasApiCreateVariantManagementRequest
*/
export interface SchemasApiCreateVariantManagementRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiCreateVariantManagement
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiCreateVariantManagement
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiCreateVariantManagement
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiCreateVariantManagement
*/
readonly schemaVariantId: string;
/**
*
* @type {CreateVariantManagementFuncV1Request}
* @memberof SchemasApiCreateVariantManagement
*/
readonly createVariantManagementFuncV1Request: CreateVariantManagementFuncV1Request;
}
/**
* Request parameters for createVariantQualification operation in SchemasApi.
* @export
* @interface SchemasApiCreateVariantQualificationRequest
*/
export interface SchemasApiCreateVariantQualificationRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiCreateVariantQualification
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiCreateVariantQualification
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiCreateVariantQualification
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiCreateVariantQualification
*/
readonly schemaVariantId: string;
/**
*
* @type {CreateVariantQualificationFuncV1Request}
* @memberof SchemasApiCreateVariantQualification
*/
readonly createVariantQualificationFuncV1Request: CreateVariantQualificationFuncV1Request;
}
/**
* Request parameters for detachActionFuncBinding operation in SchemasApi.
* @export
* @interface SchemasApiDetachActionFuncBindingRequest
*/
export interface SchemasApiDetachActionFuncBindingRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiDetachActionFuncBinding
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiDetachActionFuncBinding
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiDetachActionFuncBinding
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiDetachActionFuncBinding
*/
readonly schemaVariantId: string;
/**
* Func identifier
* @type {string}
* @memberof SchemasApiDetachActionFuncBinding
*/
readonly funcId: string;
}
/**
* Request parameters for detachAttributeFuncBinding operation in SchemasApi.
* @export
* @interface SchemasApiDetachAttributeFuncBindingRequest
*/
export interface SchemasApiDetachAttributeFuncBindingRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiDetachAttributeFuncBinding
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiDetachAttributeFuncBinding
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiDetachAttributeFuncBinding
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiDetachAttributeFuncBinding
*/
readonly schemaVariantId: string;
/**
* Func identifier
* @type {string}
* @memberof SchemasApiDetachAttributeFuncBinding
*/
readonly funcId: string;
}
/**
* Request parameters for detachAuthenticationFuncBinding operation in SchemasApi.
* @export
* @interface SchemasApiDetachAuthenticationFuncBindingRequest
*/
export interface SchemasApiDetachAuthenticationFuncBindingRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiDetachAuthenticationFuncBinding
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiDetachAuthenticationFuncBinding
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiDetachAuthenticationFuncBinding
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiDetachAuthenticationFuncBinding
*/
readonly schemaVariantId: string;
/**
* Func identifier
* @type {string}
* @memberof SchemasApiDetachAuthenticationFuncBinding
*/
readonly funcId: string;
}
/**
* Request parameters for detachCodegenFuncBinding operation in SchemasApi.
* @export
* @interface SchemasApiDetachCodegenFuncBindingRequest
*/
export interface SchemasApiDetachCodegenFuncBindingRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiDetachCodegenFuncBinding
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiDetachCodegenFuncBinding
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiDetachCodegenFuncBinding
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiDetachCodegenFuncBinding
*/
readonly schemaVariantId: string;
/**
* Func identifier
* @type {string}
* @memberof SchemasApiDetachCodegenFuncBinding
*/
readonly funcId: string;
}
/**
* Request parameters for detachManagementFuncBinding operation in SchemasApi.
* @export
* @interface SchemasApiDetachManagementFuncBindingRequest
*/
export interface SchemasApiDetachManagementFuncBindingRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiDetachManagementFuncBinding
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiDetachManagementFuncBinding
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiDetachManagementFuncBinding
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiDetachManagementFuncBinding
*/
readonly schemaVariantId: string;
/**
* Func identifier
* @type {string}
* @memberof SchemasApiDetachManagementFuncBinding
*/
readonly funcId: string;
}
/**
* Request parameters for detachQualificationFuncBinding operation in SchemasApi.
* @export
* @interface SchemasApiDetachQualificationFuncBindingRequest
*/
export interface SchemasApiDetachQualificationFuncBindingRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiDetachQualificationFuncBinding
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiDetachQualificationFuncBinding
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiDetachQualificationFuncBinding
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiDetachQualificationFuncBinding
*/
readonly schemaVariantId: string;
/**
* Func identifier
* @type {string}
* @memberof SchemasApiDetachQualificationFuncBinding
*/
readonly funcId: string;
}
/**
* Request parameters for findSchema operation in SchemasApi.
* @export
* @interface SchemasApiFindSchemaRequest
*/
export interface SchemasApiFindSchemaRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiFindSchema
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiFindSchema
*/
readonly changeSetId: string;
/**
*
* @type {string}
* @memberof SchemasApiFindSchema
*/
readonly schema?: string | null;
/**
*
* @type {string}
* @memberof SchemasApiFindSchema
*/
readonly schemaId?: string | null;
}
/**
* Request parameters for getDefaultVariant operation in SchemasApi.
* @export
* @interface SchemasApiGetDefaultVariantRequest
*/
export interface SchemasApiGetDefaultVariantRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiGetDefaultVariant
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiGetDefaultVariant
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiGetDefaultVariant
*/
readonly schemaId: string;
}
/**
* Request parameters for getSchema operation in SchemasApi.
* @export
* @interface SchemasApiGetSchemaRequest
*/
export interface SchemasApiGetSchemaRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiGetSchema
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiGetSchema
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiGetSchema
*/
readonly schemaId: string;
}
/**
* Request parameters for getVariant operation in SchemasApi.
* @export
* @interface SchemasApiGetVariantRequest
*/
export interface SchemasApiGetVariantRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiGetVariant
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiGetVariant
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiGetVariant
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiGetVariant
*/
readonly schemaVariantId: string;
}
/**
* Request parameters for installSchema operation in SchemasApi.
* @export
* @interface SchemasApiInstallSchemaRequest
*/
export interface SchemasApiInstallSchemaRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiInstallSchema
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiInstallSchema
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiInstallSchema
*/
readonly schemaId: string;
}
/**
* Request parameters for listSchemas operation in SchemasApi.
* @export
* @interface SchemasApiListSchemasRequest
*/
export interface SchemasApiListSchemasRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiListSchemas
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiListSchemas
*/
readonly changeSetId: string;
/**
* Maximum number of results to return (default: 50, max: 300)
* @type {string}
* @memberof SchemasApiListSchemas
*/
readonly limit?: string;
/**
* Cursor for pagination (SchemaId of the last item from previous page)
* @type {string}
* @memberof SchemasApiListSchemas
*/
readonly cursor?: string;
}
/**
* Request parameters for searchSchemas operation in SchemasApi.
* @export
* @interface SchemasApiSearchSchemasRequest
*/
export interface SchemasApiSearchSchemasRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiSearchSchemas
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiSearchSchemas
*/
readonly changeSetId: string;
/**
*
* @type {SearchSchemasV1Request}
* @memberof SchemasApiSearchSchemas
*/
readonly searchSchemasV1Request: SearchSchemasV1Request;
}
/**
* Request parameters for unlockSchema operation in SchemasApi.
* @export
* @interface SchemasApiUnlockSchemaRequest
*/
export interface SchemasApiUnlockSchemaRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiUnlockSchema
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiUnlockSchema
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiUnlockSchema
*/
readonly schemaId: string;
}
/**
* Request parameters for updateSchemaVariant operation in SchemasApi.
* @export
* @interface SchemasApiUpdateSchemaVariantRequest
*/
export interface SchemasApiUpdateSchemaVariantRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SchemasApiUpdateSchemaVariant
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SchemasApiUpdateSchemaVariant
*/
readonly changeSetId: string;
/**
* Schema identifier
* @type {string}
* @memberof SchemasApiUpdateSchemaVariant
*/
readonly schemaId: string;
/**
* Schema variant identifier
* @type {string}
* @memberof SchemasApiUpdateSchemaVariant
*/
readonly schemaVariantId: string;
/**
*
* @type {UpdateSchemaVariantV1Request}
* @memberof SchemasApiUpdateSchemaVariant
*/
readonly updateSchemaVariantV1Request: UpdateSchemaVariantV1Request;
}
/**
* SchemasApi - object-oriented interface
* @export
* @class SchemasApi
* @extends {BaseAPI}
*/
export declare class SchemasApi extends BaseAPI implements SchemasApiInterface {
/**
*
* @summary Contribute the default variant of a schema to the module index
* @param {SchemasApiContributeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
contribute(requestParameters: SchemasApiContributeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
/**
*
* @summary Create a schema and it\'s default variant
* @param {SchemasApiCreateSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
createSchema(requestParameters: SchemasApiCreateSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaV1Response, any, {}>>;
/**
*
* @summary Create an action function and attach to a schema variant
* @param {SchemasApiCreateVariantActionRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
createVariantAction(requestParameters: SchemasApiCreateVariantActionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVariantActionFuncV1Response, any, {}>>;
/**
*
* @summary Create an attribute function and attach to a schema variant
* @param {SchemasApiCreateVariantAttributeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
createVariantAttribute(requestParameters: SchemasApiCreateVariantAttributeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVariantAttributeFuncV1Response, any, {}>>;
/**
*
* @summary Create an authentication function and attach to a schema variant
* @param {SchemasApiCreateVariantAuthenticationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
createVariantAuthentication(requestParameters: SchemasApiCreateVariantAuthenticationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVariantAuthenticationFuncV1Response, any, {}>>;
/**
*
* @summary Create a codegen function and attach to a schema variant
* @param {SchemasApiCreateVariantCodegenRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
createVariantCodegen(requestParameters: SchemasApiCreateVariantCodegenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVariantCodegenFuncV1Response, any, {}>>;
/**
*
* @summary Create a management function and attach to a schema variant
* @param {SchemasApiCreateVariantManagementRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
createVariantManagement(requestParameters: SchemasApiCreateVariantManagementRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVariantManagementFuncV1Response, any, {}>>;
/**
*
* @summary Create a qualification and attach to a schema variant
* @param {SchemasApiCreateVariantQualificationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
createVariantQualification(requestParameters: SchemasApiCreateVariantQualificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateVariantQualificationFuncV1Response, any, {}>>;
/**
*
* @summary Delete the binding between an action func and the schema variant
* @param {SchemasApiDetachActionFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
detachActionFuncBinding(requestParameters: SchemasApiDetachActionFuncBindingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetachFuncBindingV1Response, any, {}>>;
/**
*
* @summary Delete the binding between an attribute func and the schema variant
* @param {SchemasApiDetachAttributeFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
detachAttributeFuncBinding(requestParameters: SchemasApiDetachAttributeFuncBindingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetachFuncBindingV1Response, any, {}>>;
/**
*
* @summary Delete the binding between an authentication func and the schema variant
* @param {SchemasApiDetachAuthenticationFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
detachAuthenticationFuncBinding(requestParameters: SchemasApiDetachAuthenticationFuncBindingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetachFuncBindingV1Response, any, {}>>;
/**
*
* @summary Delete the binding between a codegen func and the schema variant
* @param {SchemasApiDetachCodegenFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
detachCodegenFuncBinding(requestParameters: SchemasApiDetachCodegenFuncBindingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetachFuncBindingV1Response, any, {}>>;
/**
*
* @summary Delete the binding between a management func and the schema variant
* @param {SchemasApiDetachManagementFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
detachManagementFuncBinding(requestParameters: SchemasApiDetachManagementFuncBindingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetachFuncBindingV1Response, any, {}>>;
/**
*
* @summary Delete the binding between a qualification func and the schema variant
* @param {SchemasApiDetachQualificationFuncBindingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
detachQualificationFuncBinding(requestParameters: SchemasApiDetachQualificationFuncBindingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetachFuncBindingV1Response, any, {}>>;
/**
*
* @summary Find schema by name or schema id
* @param {SchemasApiFindSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
findSchema(requestParameters: SchemasApiFindSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FindSchemaV1Response, any, {}>>;
/**
*
* @summary Get the default variant for a schema id
* @param {SchemasApiGetDefaultVariantRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
getDefaultVariant(requestParameters: SchemasApiGetDefaultVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaVariantV1Response, any, {}>>;
/**
*
* @summary Get a schema by schema id
* @param {SchemasApiGetSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
getSchema(requestParameters: SchemasApiGetSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaV1Response, any, {}>>;
/**
*
* @summary Get a schema variant by schema id and schema variant id
* @param {SchemasApiGetVariantRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
getVariant(requestParameters: SchemasApiGetVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaVariantV1Response, any, {}>>;
/**
*
* @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
* @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
installSchema(requestParameters: SchemasApiInstallSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaV1Response, any, {}>>;
/**
*
* @summary List all schemas (paginated endpoint)
* @param {SchemasApiListSchemasRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
listSchemas(requestParameters: SchemasApiListSchemasRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListSchemaV1Response, any, {}>>;
/**
*
* @summary Complex search for schemas
* @param {SchemasApiSearchSchemasRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
searchSchemas(requestParameters: SchemasApiSearchSchemasRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchSchemasV1Response, any, {}>>;
/**
*
* @summary Unlocks a schema - if there\'s already an unlocked variant, then we return that
* @param {SchemasApiUnlockSchemaRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
unlockSchema(requestParameters: SchemasApiUnlockSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UnlockedSchemaV1Response, any, {}>>;
/**
*
* @summary Update the schema variant and regenerate
* @param {SchemasApiUpdateSchemaVariantRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SchemasApi
*/
updateSchemaVariant(requestParameters: SchemasApiUpdateSchemaVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaVariantV1Response, any, {}>>;
}
/**
* SearchApi - axios parameter creator
* @export
*/
export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Complex search for components
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
search: (workspaceId: string, changeSetId: string, q: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* SearchApi - functional programming interface
* @export
*/
export declare const SearchApiFp: (configuration?: Configuration) => {
/**
*
* @summary Complex search for components
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
search(workspaceId: string, changeSetId: string, q: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchV1Response>>;
};
/**
* SearchApi - factory interface
* @export
*/
export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Complex search for components
* @param {SearchApiSearchRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchV1Response>;
};
/**
* SearchApi - interface
* @export
* @interface SearchApi
*/
export interface SearchApiInterface {
/**
*
* @summary Complex search for components
* @param {SearchApiSearchRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SearchApiInterface
*/
search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchV1Response>;
}
/**
* Request parameters for search operation in SearchApi.
* @export
* @interface SearchApiSearchRequest
*/
export interface SearchApiSearchRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SearchApiSearch
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SearchApiSearch
*/
readonly changeSetId: string;
/**
* Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
* @type {string}
* @memberof SearchApiSearch
*/
readonly q: string;
}
/**
* SearchApi - object-oriented interface
* @export
* @class SearchApi
* @extends {BaseAPI}
*/
export declare class SearchApi extends BaseAPI implements SearchApiInterface {
/**
*
* @summary Complex search for components
* @param {SearchApiSearchRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SearchApi
*/
search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchV1Response, any, {}>>;
}
/**
* SecretsApi - axios parameter creator
* @export
*/
export declare const SecretsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Create a secret
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {CreateSecretV1Request} createSecretV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSecret: (workspaceId: string, changeSetId: string, createSecretV1Request: CreateSecretV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete a secret
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} secretId Secret identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteSecret: (workspaceId: string, changeSetId: string, secretId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary List all secrets
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSecrets: (workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update a secret
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} secretId Secret identifier
* @param {UpdateSecretV1Request} updateSecretV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSecret: (workspaceId: string, changeSetId: string, secretId: string, updateSecretV1Request: UpdateSecretV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* SecretsApi - functional programming interface
* @export
*/
export declare const SecretsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Create a secret
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {CreateSecretV1Request} createSecretV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSecret(workspaceId: string, changeSetId: string, createSecretV1Request: CreateSecretV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSecretV1Response>>;
/**
*
* @summary Delete a secret
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} secretId Secret identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteSecret(workspaceId: string, changeSetId: string, secretId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteSecretV1Response>>;
/**
*
* @summary List all secrets
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSecrets(workspaceId: string, changeSetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
[key: string]: HashMapValue;
}>>;
/**
*
* @summary Update a secret
* @param {string} workspaceId Workspace identifier
* @param {string} changeSetId Change Set identifier
* @param {string} secretId Secret identifier
* @param {UpdateSecretV1Request} updateSecretV1Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSecret(workspaceId: string, changeSetId: string, secretId: string, updateSecretV1Request: UpdateSecretV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateSecretV1Response>>;
};
/**
* SecretsApi - factory interface
* @export
*/
export declare const SecretsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Create a secret
* @param {SecretsApiCreateSecretRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSecret(requestParameters: SecretsApiCreateSecretRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateSecretV1Response>;
/**
*
* @summary Delete a secret
* @param {SecretsApiDeleteSecretRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteSecret(requestParameters: SecretsApiDeleteSecretRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteSecretV1Response>;
/**
*
* @summary List all secrets
* @param {SecretsApiGetSecretsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSecrets(requestParameters: SecretsApiGetSecretsRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
[key: string]: HashMapValue;
}>;
/**
*
* @summary Update a secret
* @param {SecretsApiUpdateSecretRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSecret(requestParameters: SecretsApiUpdateSecretRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateSecretV1Response>;
};
/**
* SecretsApi - interface
* @export
* @interface SecretsApi
*/
export interface SecretsApiInterface {
/**
*
* @summary Create a secret
* @param {SecretsApiCreateSecretRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SecretsApiInterface
*/
createSecret(requestParameters: SecretsApiCreateSecretRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateSecretV1Response>;
/**
*
* @summary Delete a secret
* @param {SecretsApiDeleteSecretRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SecretsApiInterface
*/
deleteSecret(requestParameters: SecretsApiDeleteSecretRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteSecretV1Response>;
/**
*
* @summary List all secrets
* @param {SecretsApiGetSecretsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SecretsApiInterface
*/
getSecrets(requestParameters: SecretsApiGetSecretsRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
[key: string]: HashMapValue;
}>;
/**
*
* @summary Update a secret
* @param {SecretsApiUpdateSecretRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SecretsApiInterface
*/
updateSecret(requestParameters: SecretsApiUpdateSecretRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateSecretV1Response>;
}
/**
* Request parameters for createSecret operation in SecretsApi.
* @export
* @interface SecretsApiCreateSecretRequest
*/
export interface SecretsApiCreateSecretRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SecretsApiCreateSecret
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SecretsApiCreateSecret
*/
readonly changeSetId: string;
/**
*
* @type {CreateSecretV1Request}
* @memberof SecretsApiCreateSecret
*/
readonly createSecretV1Request: CreateSecretV1Request;
}
/**
* Request parameters for deleteSecret operation in SecretsApi.
* @export
* @interface SecretsApiDeleteSecretRequest
*/
export interface SecretsApiDeleteSecretRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SecretsApiDeleteSecret
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SecretsApiDeleteSecret
*/
readonly changeSetId: string;
/**
* Secret identifier
* @type {string}
* @memberof SecretsApiDeleteSecret
*/
readonly secretId: string;
}
/**
* Request parameters for getSecrets operation in SecretsApi.
* @export
* @interface SecretsApiGetSecretsRequest
*/
export interface SecretsApiGetSecretsRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SecretsApiGetSecrets
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SecretsApiGetSecrets
*/
readonly changeSetId: string;
}
/**
* Request parameters for updateSecret operation in SecretsApi.
* @export
* @interface SecretsApiUpdateSecretRequest
*/
export interface SecretsApiUpdateSecretRequest {
/**
* Workspace identifier
* @type {string}
* @memberof SecretsApiUpdateSecret
*/
readonly workspaceId: string;
/**
* Change Set identifier
* @type {string}
* @memberof SecretsApiUpdateSecret
*/
readonly changeSetId: string;
/**
* Secret identifier
* @type {string}
* @memberof SecretsApiUpdateSecret
*/
readonly secretId: string;
/**
*
* @type {UpdateSecretV1Request}
* @memberof SecretsApiUpdateSecret
*/
readonly updateSecretV1Request: UpdateSecretV1Request;
}
/**
* SecretsApi - object-oriented interface
* @export
* @class SecretsApi
* @extends {BaseAPI}
*/
export declare class SecretsApi extends BaseAPI implements SecretsApiInterface {
/**
*
* @summary Create a secret
* @param {SecretsApiCreateSecretRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SecretsApi
*/
createSecret(requestParameters: SecretsApiCreateSecretRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSecretV1Response, any, {}>>;
/**
*
* @summary Delete a secret
* @param {SecretsApiDeleteSecretRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SecretsApi
*/
deleteSecret(requestParameters: SecretsApiDeleteSecretRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteSecretV1Response, any, {}>>;
/**
*
* @summary List all secrets
* @param {SecretsApiGetSecretsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SecretsApi
*/
getSecrets(requestParameters: SecretsApiGetSecretsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
[key: string]: HashMapValue;
}, any, {}>>;
/**
*
* @summary Update a secret
* @param {SecretsApiUpdateSecretRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SecretsApi
*/
updateSecret(requestParameters: SecretsApiUpdateSecretRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateSecretV1Response, any, {}>>;
}
/**
* WhoamiApi - axios parameter creator
* @export
*/
export declare const WhoamiApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
whoami: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* WhoamiApi - functional programming interface
* @export
*/
export declare const WhoamiApiFp: (configuration?: Configuration) => {
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
whoami(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WhoamiResponse>>;
};
/**
* WhoamiApi - factory interface
* @export
*/
export declare const WhoamiApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
whoami(options?: RawAxiosRequestConfig): AxiosPromise<WhoamiResponse>;
};
/**
* WhoamiApi - interface
* @export
* @interface WhoamiApi
*/
export interface WhoamiApiInterface {
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WhoamiApiInterface
*/
whoami(options?: RawAxiosRequestConfig): AxiosPromise<WhoamiResponse>;
}
/**
* WhoamiApi - object-oriented interface
* @export
* @class WhoamiApi
* @extends {BaseAPI}
*/
export declare class WhoamiApi extends BaseAPI implements WhoamiApiInterface {
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WhoamiApi
*/
whoami(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WhoamiResponse, any, {}>>;
}
/**
* WorkspaceManagementApi - axios parameter creator
* @export
*/
export declare const WorkspaceManagementApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Create a new workspace
* @param {CreateWorkspaceRequest} createWorkspaceRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createWorkspace: (createWorkspaceRequest: CreateWorkspaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete a workspace - please note, this is a soft delete and workspaces can be recovered
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWorkspace: (workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get the details of a workspace
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWorkspace: (workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Invite a new member to the workspace
* @param {string} workspaceId Workspace identifier
* @param {InviteMemberRequest} inviteMemberRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inviteMember: (workspaceId: string, inviteMemberRequest: InviteMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Leave a workspace (remove yourself)
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
leaveWorkspace: (workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary List all members of a workspace
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listMembers: (workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary List workspaces
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listWorkspaces: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Remove a member from the workspace
* @param {string} workspaceId Workspace identifier
* @param {RemoveMemberRequest} removeMemberRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeMember: (workspaceId: string, removeMemberRequest: RemoveMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update a member\'s role in the workspace
* @param {string} workspaceId Workspace identifier
* @param {UpdateMemberRoleRequest} updateMemberRoleRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateMemberRole: (workspaceId: string, updateMemberRoleRequest: UpdateMemberRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update the details of a workspace
* @param {string} workspaceId Workspace identifier
* @param {UpdateWorkspaceRequest} updateWorkspaceRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateWorkspace: (workspaceId: string, updateWorkspaceRequest: UpdateWorkspaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* WorkspaceManagementApi - functional programming interface
* @export
*/
export declare const WorkspaceManagementApiFp: (configuration?: Configuration) => {
/**
*
* @summary Create a new workspace
* @param {CreateWorkspaceRequest} createWorkspaceRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createWorkspace(createWorkspaceRequest: CreateWorkspaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workspace>>;
/**
*
* @summary Delete a workspace - please note, this is a soft delete and workspaces can be recovered
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWorkspace(workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Get the details of a workspace
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWorkspace(workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workspace>>;
/**
*
* @summary Invite a new member to the workspace
* @param {string} workspaceId Workspace identifier
* @param {InviteMemberRequest} inviteMemberRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inviteMember(workspaceId: string, inviteMemberRequest: InviteMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Member>>>;
/**
*
* @summary Leave a workspace (remove yourself)
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
leaveWorkspace(workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Member>>>;
/**
*
* @summary List all members of a workspace
* @param {string} workspaceId Workspace identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listMembers(workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Member>>>;
/**
*
* @summary List workspaces
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listWorkspaces(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Workspace>>>;
/**
*
* @summary Remove a member from the workspace
* @param {string} workspaceId Workspace identifier
* @param {RemoveMemberRequest} removeMemberRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeMember(workspaceId: string, removeMemberRequest: RemoveMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Member>>>;
/**
*
* @summary Update a member\'s role in the workspace
* @param {string} workspaceId Workspace identifier
* @param {UpdateMemberRoleRequest} updateMemberRoleRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateMemberRole(workspaceId: string, updateMemberRoleRequest: UpdateMemberRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Member>>>;
/**
*
* @summary Update the details of a workspace
* @param {string} workspaceId Workspace identifier
* @param {UpdateWorkspaceRequest} updateWorkspaceRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateWorkspace(workspaceId: string, updateWorkspaceRequest: UpdateWorkspaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workspace>>;
};
/**
* WorkspaceManagementApi - factory interface
* @export
*/
export declare const WorkspaceManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Create a new workspace
* @param {WorkspaceManagementApiCreateWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createWorkspace(requestParameters: WorkspaceManagementApiCreateWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Workspace>;
/**
*
* @summary Delete a workspace - please note, this is a soft delete and workspaces can be recovered
* @param {WorkspaceManagementApiDeleteWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWorkspace(requestParameters: WorkspaceManagementApiDeleteWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Get the details of a workspace
* @param {WorkspaceManagementApiGetWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWorkspace(requestParameters: WorkspaceManagementApiGetWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Workspace>;
/**
*
* @summary Invite a new member to the workspace
* @param {WorkspaceManagementApiInviteMemberRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inviteMember(requestParameters: WorkspaceManagementApiInviteMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
/**
*
* @summary Leave a workspace (remove yourself)
* @param {WorkspaceManagementApiLeaveWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
leaveWorkspace(requestParameters: WorkspaceManagementApiLeaveWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
/**
*
* @summary List all members of a workspace
* @param {WorkspaceManagementApiListMembersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listMembers(requestParameters: WorkspaceManagementApiListMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
/**
*
* @summary List workspaces
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listWorkspaces(options?: RawAxiosRequestConfig): AxiosPromise<Array<Workspace>>;
/**
*
* @summary Remove a member from the workspace
* @param {WorkspaceManagementApiRemoveMemberRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeMember(requestParameters: WorkspaceManagementApiRemoveMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
/**
*
* @summary Update a member\'s role in the workspace
* @param {WorkspaceManagementApiUpdateMemberRoleRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateMemberRole(requestParameters: WorkspaceManagementApiUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
/**
*
* @summary Update the details of a workspace
* @param {WorkspaceManagementApiUpdateWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateWorkspace(requestParameters: WorkspaceManagementApiUpdateWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Workspace>;
};
/**
* WorkspaceManagementApi - interface
* @export
* @interface WorkspaceManagementApi
*/
export interface WorkspaceManagementApiInterface {
/**
*
* @summary Create a new workspace
* @param {WorkspaceManagementApiCreateWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApiInterface
*/
createWorkspace(requestParameters: WorkspaceManagementApiCreateWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Workspace>;
/**
*
* @summary Delete a workspace - please note, this is a soft delete and workspaces can be recovered
* @param {WorkspaceManagementApiDeleteWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApiInterface
*/
deleteWorkspace(requestParameters: WorkspaceManagementApiDeleteWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Get the details of a workspace
* @param {WorkspaceManagementApiGetWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApiInterface
*/
getWorkspace(requestParameters: WorkspaceManagementApiGetWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Workspace>;
/**
*
* @summary Invite a new member to the workspace
* @param {WorkspaceManagementApiInviteMemberRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApiInterface
*/
inviteMember(requestParameters: WorkspaceManagementApiInviteMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
/**
*
* @summary Leave a workspace (remove yourself)
* @param {WorkspaceManagementApiLeaveWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApiInterface
*/
leaveWorkspace(requestParameters: WorkspaceManagementApiLeaveWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
/**
*
* @summary List all members of a workspace
* @param {WorkspaceManagementApiListMembersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApiInterface
*/
listMembers(requestParameters: WorkspaceManagementApiListMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
/**
*
* @summary List workspaces
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApiInterface
*/
listWorkspaces(options?: RawAxiosRequestConfig): AxiosPromise<Array<Workspace>>;
/**
*
* @summary Remove a member from the workspace
* @param {WorkspaceManagementApiRemoveMemberRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApiInterface
*/
removeMember(requestParameters: WorkspaceManagementApiRemoveMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
/**
*
* @summary Update a member\'s role in the workspace
* @param {WorkspaceManagementApiUpdateMemberRoleRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApiInterface
*/
updateMemberRole(requestParameters: WorkspaceManagementApiUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
/**
*
* @summary Update the details of a workspace
* @param {WorkspaceManagementApiUpdateWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApiInterface
*/
updateWorkspace(requestParameters: WorkspaceManagementApiUpdateWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Workspace>;
}
/**
* Request parameters for createWorkspace operation in WorkspaceManagementApi.
* @export
* @interface WorkspaceManagementApiCreateWorkspaceRequest
*/
export interface WorkspaceManagementApiCreateWorkspaceRequest {
/**
*
* @type {CreateWorkspaceRequest}
* @memberof WorkspaceManagementApiCreateWorkspace
*/
readonly createWorkspaceRequest: CreateWorkspaceRequest;
}
/**
* Request parameters for deleteWorkspace operation in WorkspaceManagementApi.
* @export
* @interface WorkspaceManagementApiDeleteWorkspaceRequest
*/
export interface WorkspaceManagementApiDeleteWorkspaceRequest {
/**
* Workspace identifier
* @type {string}
* @memberof WorkspaceManagementApiDeleteWorkspace
*/
readonly workspaceId: string;
}
/**
* Request parameters for getWorkspace operation in WorkspaceManagementApi.
* @export
* @interface WorkspaceManagementApiGetWorkspaceRequest
*/
export interface WorkspaceManagementApiGetWorkspaceRequest {
/**
* Workspace identifier
* @type {string}
* @memberof WorkspaceManagementApiGetWorkspace
*/
readonly workspaceId: string;
}
/**
* Request parameters for inviteMember operation in WorkspaceManagementApi.
* @export
* @interface WorkspaceManagementApiInviteMemberRequest
*/
export interface WorkspaceManagementApiInviteMemberRequest {
/**
* Workspace identifier
* @type {string}
* @memberof WorkspaceManagementApiInviteMember
*/
readonly workspaceId: string;
/**
*
* @type {InviteMemberRequest}
* @memberof WorkspaceManagementApiInviteMember
*/
readonly inviteMemberRequest: InviteMemberRequest;
}
/**
* Request parameters for leaveWorkspace operation in WorkspaceManagementApi.
* @export
* @interface WorkspaceManagementApiLeaveWorkspaceRequest
*/
export interface WorkspaceManagementApiLeaveWorkspaceRequest {
/**
* Workspace identifier
* @type {string}
* @memberof WorkspaceManagementApiLeaveWorkspace
*/
readonly workspaceId: string;
}
/**
* Request parameters for listMembers operation in WorkspaceManagementApi.
* @export
* @interface WorkspaceManagementApiListMembersRequest
*/
export interface WorkspaceManagementApiListMembersRequest {
/**
* Workspace identifier
* @type {string}
* @memberof WorkspaceManagementApiListMembers
*/
readonly workspaceId: string;
}
/**
* Request parameters for removeMember operation in WorkspaceManagementApi.
* @export
* @interface WorkspaceManagementApiRemoveMemberRequest
*/
export interface WorkspaceManagementApiRemoveMemberRequest {
/**
* Workspace identifier
* @type {string}
* @memberof WorkspaceManagementApiRemoveMember
*/
readonly workspaceId: string;
/**
*
* @type {RemoveMemberRequest}
* @memberof WorkspaceManagementApiRemoveMember
*/
readonly removeMemberRequest: RemoveMemberRequest;
}
/**
* Request parameters for updateMemberRole operation in WorkspaceManagementApi.
* @export
* @interface WorkspaceManagementApiUpdateMemberRoleRequest
*/
export interface WorkspaceManagementApiUpdateMemberRoleRequest {
/**
* Workspace identifier
* @type {string}
* @memberof WorkspaceManagementApiUpdateMemberRole
*/
readonly workspaceId: string;
/**
*
* @type {UpdateMemberRoleRequest}
* @memberof WorkspaceManagementApiUpdateMemberRole
*/
readonly updateMemberRoleRequest: UpdateMemberRoleRequest;
}
/**
* Request parameters for updateWorkspace operation in WorkspaceManagementApi.
* @export
* @interface WorkspaceManagementApiUpdateWorkspaceRequest
*/
export interface WorkspaceManagementApiUpdateWorkspaceRequest {
/**
* Workspace identifier
* @type {string}
* @memberof WorkspaceManagementApiUpdateWorkspace
*/
readonly workspaceId: string;
/**
*
* @type {UpdateWorkspaceRequest}
* @memberof WorkspaceManagementApiUpdateWorkspace
*/
readonly updateWorkspaceRequest: UpdateWorkspaceRequest;
}
/**
* WorkspaceManagementApi - object-oriented interface
* @export
* @class WorkspaceManagementApi
* @extends {BaseAPI}
*/
export declare class WorkspaceManagementApi extends BaseAPI implements WorkspaceManagementApiInterface {
/**
*
* @summary Create a new workspace
* @param {WorkspaceManagementApiCreateWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApi
*/
createWorkspace(requestParameters: WorkspaceManagementApiCreateWorkspaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace, any, {}>>;
/**
*
* @summary Delete a workspace - please note, this is a soft delete and workspaces can be recovered
* @param {WorkspaceManagementApiDeleteWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApi
*/
deleteWorkspace(requestParameters: WorkspaceManagementApiDeleteWorkspaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
/**
*
* @summary Get the details of a workspace
* @param {WorkspaceManagementApiGetWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApi
*/
getWorkspace(requestParameters: WorkspaceManagementApiGetWorkspaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace, any, {}>>;
/**
*
* @summary Invite a new member to the workspace
* @param {WorkspaceManagementApiInviteMemberRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApi
*/
inviteMember(requestParameters: WorkspaceManagementApiInviteMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Member[], any, {}>>;
/**
*
* @summary Leave a workspace (remove yourself)
* @param {WorkspaceManagementApiLeaveWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApi
*/
leaveWorkspace(requestParameters: WorkspaceManagementApiLeaveWorkspaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Member[], any, {}>>;
/**
*
* @summary List all members of a workspace
* @param {WorkspaceManagementApiListMembersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApi
*/
listMembers(requestParameters: WorkspaceManagementApiListMembersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Member[], any, {}>>;
/**
*
* @summary List workspaces
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApi
*/
listWorkspaces(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace[], any, {}>>;
/**
*
* @summary Remove a member from the workspace
* @param {WorkspaceManagementApiRemoveMemberRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApi
*/
removeMember(requestParameters: WorkspaceManagementApiRemoveMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Member[], any, {}>>;
/**
*
* @summary Update a member\'s role in the workspace
* @param {WorkspaceManagementApiUpdateMemberRoleRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApi
*/
updateMemberRole(requestParameters: WorkspaceManagementApiUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Member[], any, {}>>;
/**
*
* @summary Update the details of a workspace
* @param {WorkspaceManagementApiUpdateWorkspaceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WorkspaceManagementApi
*/
updateWorkspace(requestParameters: WorkspaceManagementApiUpdateWorkspaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace, any, {}>>;
}