system-initiative-api-client
Version:
TypeScript/JavaScript SDK for the System Initiative Public API
2,573 lines • 161 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;
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'description': string;
/**
*
* @type {string}
* @memberof ActionViewV1
*/
'funcRunId': string;
/**
*
* @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;
}
/**
* 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 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 {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 {object}
* @memberof ComponentPropViewV1
*/
'value': object;
}
/**
* @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;
}
/**
*
* @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 {Array<SocketViewV1>}
* @memberof ComponentViewV1
*/
'sockets': Array<SocketViewV1>;
/**
*
* @type {boolean}
* @memberof ComponentViewV1
*/
'toDelete': boolean;
/**
*
* @type {Array<ViewV1>}
* @memberof ComponentViewV1
*/
'views': Array<ViewV1>;
}
/**
* @type Connection
* @export
*/
export type Connection = ConnectionOneOf | ConnectionOneOf1;
/**
*
* @export
* @interface ConnectionDetails
*/
export interface ConnectionDetails {
/**
*
* @type {Array<Connection>}
* @memberof ConnectionDetails
*/
'add'?: Array<Connection>;
/**
*
* @type {Array<Connection>}
* @memberof ConnectionDetails
*/
'remove'?: Array<Connection>;
}
/**
*
* @export
* @interface ConnectionOneOf
*/
export interface ConnectionOneOf {
/**
*
* @type {ConnectionPoint}
* @memberof ConnectionOneOf
*/
'from': ConnectionPoint;
/**
*
* @type {string}
* @memberof ConnectionOneOf
*/
'to': string;
}
/**
*
* @export
* @interface ConnectionOneOf1
*/
export interface ConnectionOneOf1 {
/**
*
* @type {string}
* @memberof ConnectionOneOf1
*/
'from': string;
/**
*
* @type {ConnectionPoint}
* @memberof ConnectionOneOf1
*/
'to': ConnectionPoint;
}
/**
*
* @export
* @interface ConnectionPoint
*/
export interface ConnectionPoint {
/**
*
* @type {string}
* @memberof ConnectionPoint
*/
'component': string;
/**
*
* @type {string}
* @memberof ConnectionPoint
*/
'componentId': string;
/**
*
* @type {string}
* @memberof ConnectionPoint
*/
'socketName': string;
}
/**
* @type ConnectionViewV1
* @export
*/
export type ConnectionViewV1 = ConnectionViewV1OneOf | ConnectionViewV1OneOf1 | ConnectionViewV1OneOf2 | ConnectionViewV1OneOf3;
/**
*
* @export
* @interface ConnectionViewV1OneOf
*/
export interface ConnectionViewV1OneOf {
/**
*
* @type {IncomingConnectionViewV1}
* @memberof ConnectionViewV1OneOf
*/
'incoming': IncomingConnectionViewV1;
}
/**
*
* @export
* @interface ConnectionViewV1OneOf1
*/
export interface ConnectionViewV1OneOf1 {
/**
*
* @type {OutgoingConnectionViewV1}
* @memberof ConnectionViewV1OneOf1
*/
'outgoing': OutgoingConnectionViewV1;
}
/**
*
* @export
* @interface ConnectionViewV1OneOf2
*/
export interface ConnectionViewV1OneOf2 {
/**
*
* @type {ManagingConnectionViewV1}
* @memberof ConnectionViewV1OneOf2
*/
'managing': ManagingConnectionViewV1;
}
/**
*
* @export
* @interface ConnectionViewV1OneOf3
*/
export interface ConnectionViewV1OneOf3 {
/**
*
* @type {ManagedByConnectionViewV1}
* @memberof ConnectionViewV1OneOf3
*/
'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 {Array<Connection>}
* @memberof CreateComponentV1Request
*/
'connections'?: Array<Connection>;
/**
*
* @type {{ [key: string]: any; }}
* @memberof CreateComponentV1Request
* @deprecated
*/
'domain'?: {
[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 {{ [key: string]: any; }}
* @memberof CreateComponentV1Request
* @deprecated
*/
'secrets'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: Subscription; }}
* @memberof CreateComponentV1Request
* @deprecated
*/
'subscriptions'?: {
[key: string]: Subscription;
};
/**
*
* @type {string}
* @memberof CreateComponentV1Request
*/
'viewName'?: string | null;
}
/**
*
* @export
* @interface CreateComponentV1Response
*/
export interface CreateComponentV1Response {
/**
*
* @type {ComponentViewV1}
* @memberof CreateComponentV1Response
*/
'component': ComponentViewV1;
}
/**
*
* @export
* @interface CreateSecretV1Request
*/
export interface CreateSecretV1Request {
/**
*
* @type {string}
* @memberof CreateSecretV1Request
*/
'definitionName': string;
/**
*
* @type {string}
* @memberof CreateSecretV1Request
*/
'description': string;
/**
*
* @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 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 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 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 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;
/**
*
* @type {string}
* @memberof ExecuteManagementFunctionV1Response
*/
'managementFuncJobStateId': string;
/**
*
* @type {string}
* @memberof ExecuteManagementFunctionV1Response
*/
'message'?: string;
/**
*
* @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;
}
/**
*
* @export
* @interface FindSchemaV1Params
*/
export interface FindSchemaV1Params {
/**
*
* @type {string}
* @memberof FindSchemaV1Params
*/
'schema'?: string | null;
/**
*
* @type {string}
* @memberof FindSchemaV1Params
*/
'schemaId': string;
}
/**
*
* @export
* @interface FindSchemaV1Response
*/
export interface FindSchemaV1Response {
/**
*
* @type {string}
* @memberof FindSchemaV1Response
*/
'category': string;
/**
*
* @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;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionId': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionKind': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionOriginatingChangeSetId': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionOriginatingChangeSetName': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionPrototypeId': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'actionResultState': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'attributeValueId': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'backendKind': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'backendResponseType': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'componentId': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'componentName': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'createdAt': string;
/**
*
* @type {any}
* @memberof FuncRunViewV1
*/
'functionArgs': any;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionCodeBase64': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionDescription': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionDisplayName': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionKind': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'functionLink': string;
/**
*
* @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;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'state': string;
/**
*
* @type {string}
* @memberof FuncRunViewV1
*/
'updatedAt': string;
}
/**
*
* @export
* @interface GenerateTemplateV1Request
*/
export interface GenerateTemplateV1Request {
/**
*
* @type {string}
* @memberof GenerateTemplateV1Request
*/
'assetName': string;
/**
*
* @type {string}
* @memberof GenerateTemplateV1Request
*/
'category'?: string | null;
/**
*
* @type {Array<string>}
* @memberof GenerateTemplateV1Request
*/
'componentIds': Array<string>;
/**
*
* @type {string}
* @memberof GenerateTemplateV1Request
*/
'funcName': string;
}
/**
*
* @export
* @interface GenerateTemplateV1Response
*/
export interface GenerateTemplateV1Response {
/**
*
* @type {string}
* @memberof GenerateTemplateV1Response
*/
'funcId': string;
/**
*
* @type {string}
* @memberof GenerateTemplateV1Response
*/
'schemaVariantId': 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 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 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;
/**
*
* @type {string}
* @memberof GetFuncV1Response
*/
'displayName': string;
/**
*
* @type {boolean}
* @memberof GetFuncV1Response
*/
'isLocked': boolean;
/**
*
* @type {string}
* @memberof GetFuncV1Response
*/
'kind': string;
/**
*
* @type {string}
* @memberof GetFuncV1Response
*/
'link': string;
/**
*
* @type {string}
* @memberof GetFuncV1Response
*/
'name': string;
}
/**
*
* @export
* @interface GetManagementFuncJobStateV1Response
*/
export interface GetManagementFuncJobStateV1Response {
/**
*
* @type {string}
* @memberof GetManagementFuncJobStateV1Response
*/
'funcRunId': string;
/**
*
* @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 {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;
/**
*
* @type {string}
* @memberof GetSchemaVariantV1Response
*/
'displayName': string;
/**
*
* @type {PropSchemaV1}
* @memberof GetSchemaVariantV1Response
*/
'domainProps': PropSchemaV1;
/**
*
* @type {boolean}
* @memberof GetSchemaVariantV1Response
*/
'isDefaultVariant': boolean;
/**
*
* @type {boolean}
* @memberof GetSchemaVariantV1Response
*/
'isLocked': boolean;
/**
*
* @type {string}
* @memberof GetSchemaVariantV1Response
*/
'link': string;
/**
*
* @type {Array<string>}
* @memberof GetSchemaVariantV1Response
*/
'variantFuncIds': Array<string>;
/**
*
* @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 IncomingConnectionViewV1
*/
export interface IncomingConnectionViewV1 {
/**
*
* @type {string}
* @memberof IncomingConnectionViewV1
*/
'from': string;
/**
*
* @type {string}
* @memberof IncomingConnectionViewV1
*/
'fromComponentId': string;
/**
*
* @type {string}
* @memberof IncomingConnectionViewV1
*/
'fromComponentName': string;
/**
*
* @type {string}
* @memberof IncomingConnectionViewV1
*/
'to': 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 {Array<Array<string>>}
* @memberof ListComponentsV1Response
*/
'components': Array<Array<string>>;
/**
*
* @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;
}
/**
* 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 OutgoingConnectionViewV1
*/
export interface OutgoingConnectionViewV1 {
/**
*
* @type {string}
* @memberof OutgoingConnectionViewV1
*/
'from': string;
/**
*
* @type {string}
* @memberof OutgoingConnectionViewV1
*/
'toComponentId': string;
/**
*
* @type {string}
* @memberof OutgoingConnectionViewV1
*/
'toComponentName': 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>;
/**
*
* @type {string}
* @memberof PropSchemaV1
*/
'description': string;
/**
*
* @type {string}
* @memberof PropSchemaV1
*/
'name': string;
/**
*
* @type {string}
* @memberof PropSchemaV1
*/
'propId': string;
/**
*
* @type {string}
* @memberof PropSchemaV1
*/
'propType': string;
}
/**
*
* @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 RequestApprovalChangeSetV1Response
*/
export interface RequestApprovalChangeSetV1Response {
/**
*
* @type {boolean}
* @memberof RequestApprovalChangeSetV1Response
*/
'success': 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 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
*/
'schemaName'?: string | null;
}
/**
*
* @export
* @interface SearchComponentsV1Response
*/
export interface SearchComponentsV1Response {
/**
*
* @type {Array<Array<string>>}
* @memberof SearchComponentsV1Response
*/
'components': Array<Array<string>>;
}
/**
*
* @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;
/**
*
* @type {string}
* @memberof SecretV1
*/
'id': string;
/**
*
* @type {string}
* @memberof SecretV1
*/
'name': string;
}
/**
*
* @export
* @enum {string}
*/
export declare enum SocketDirection {
INPUT = "input",
OUTPUT = "output"
}
/**
*
* @export
* @interface SocketViewV1
*/
export interface SocketViewV1 {
/**
*
* @type {string}
* @memberof SocketViewV1
*/
'arity': string;
/**
*
* @type {SocketDirection}
* @memberof SocketViewV1
*/
'direction': SocketDirection;
/**
*
* @type {string}
* @memberof SocketViewV1
*/
'id': string;
/**
*
* @type {string}
* @memberof SocketViewV1
*/
'name': string;
/**
*
* @type {object}
* @memberof SocketViewV1
*/
'value': object;
}
/**
*
* @export
* @interface SourceViewV1
*/
export interface SourceViewV1 {
/**
*
* @type {string}
* @memberof SourceViewV1
*/
'component': string;
/**
*
* @type {string}
* @memberof SourceViewV1
*/
'propPath': string;
}
/**
*
* @export
* @interface Subscription
*/
export interface Subscription {
/**
*
* @type {string}
* @memberof Subscription
*/
'component': string;
/**
*
* @type {string}
* @memberof Subscription
*/
'componentId': string;
/**
*
* @type {string}
* @memberof Subscription
*/
'function'?: string;
/**
*
* @type {boolean}
* @memberof Subscription
*/
'keepExistingSubscriptions'?: boolean | null;
/**
*
* @type {string}
* @memberof Subscription
*/
'propPath': string;
}
/**
*
* @export
* @interface SystemStatusResponse
*/
export interface SystemStatusResponse {
/**
*
* @type {string}
* @memberof SystemStatusResponse
*/
'API Documentation': string;
}
/**
*
* @export
* @interface UpdateComponentV1Request
*/
export interface UpdateComponentV1Request {
/**
*
* @type {{ [key: string]: any; }}
* @memberof UpdateComponentV1Request
*/
'attributes'?: {
[key: string]: any;
};
/**
*
* @type {ConnectionDetails}
* @memberof UpdateComponentV1Request
*/
'connectionChanges'?: ConnectionDetails;
/**
*
* @type {{ [key: string]: any; }}
* @memberof UpdateComponentV1Request
* @deprecated
*/
'domain'?: {
[key: string]: any;
};
/**
*
* @type {string}
* @memberof UpdateComponentV1Request
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof UpdateComponentV1Request
*/
'resourceId'?: string | null;
/**
*
* @type {{ [key: string]: any; }}
* @memberof UpdateComponentV1Request
* @deprecated
*/
'secrets'?: {
[key: string]: any;
};
/**
*
* @type {{ [key: string]: Subscription; }}
* @memberof UpdateComponentV1Request
* @deprecated
*/
'subscriptions'?: {
[key: string]: Subscription;
};
/**
*
* @type {Array<ComponentPropKey>}
* @memberof UpdateComponentV1Request
*/
'unset'?: Array<ComponentPropKey>;
}
/**
*
* @export
* @interface UpdateComponentV1Response
*/
export interface UpdateComponentV1Response {
/**
*
* @type {ComponentViewV1}
* @memberof UpdateComponentV1Response
*/
'component': ComponentViewV1;
}
/**
*
* @export
* @interface UpdateSecretV1Request
*/
export interface UpdateSecretV1Request {
/**
*
* @type {string}
* @memberof UpdateSecretV1Request
*/
'description': string;
/**
*
* @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 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;
}
/**
* 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 {RequiredE