system-initiative-api-client
Version:
TypeScript/JavaScript SDK for the System Initiative Public API
2,576 lines • 317 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 {Array<FunctionRelationshipV1>}
* @memberof ComponentDetailsV1
*/
'actionFunctions'?: Array<FunctionRelationshipV1>;
/**
*
* @type {any}
* @memberof ComponentDetailsV1
*/
'codegen'?: any;
/**
*
* @type {string}
* @memberof ComponentDetailsV1
*/
'componentId': string;
/**
*
* @type {string}
* @memberof ComponentDetailsV1
*/
'diffStatus'?: string | null;
/**
*
* @type {boolean}
* @memberof ComponentDetailsV1
*/
'hasDiff'?: boolean | null;
/**
*
* @type {boolean}
* @memberof ComponentDetailsV1
*/
'hasResource'?: boolean | null;
/**
*
* @type {Array<FunctionRelationshipV1>}
* @memberof ComponentDetailsV1
*/
'managementFunctions'?: Array<FunctionRelationshipV1>;
/**
*
* @type {Array<ManagementRelationshipV1>}
* @memberof ComponentDetailsV1
*/
'manages'?: Array<ManagementRelationshipV1>;
/**
*
* @type {string}
* @memberof ComponentDetailsV1
*/
'name': string;
/**
*
* @type {Array<FunctionRelationshipV1>}
* @memberof ComponentDetailsV1
*/
'qualificationFunctions'?: Array<FunctionRelationshipV1>;
/**
*
* @type {string}
* @memberof ComponentDetailsV1
*/
'resourceId'?: string | null;
/**
*
* @type {string}
* @memberof ComponentDetailsV1
*/
'resourceStatus'?: string | null;
/**
*
* @type {string}
* @memberof ComponentDetailsV1
*/
'schemaName': string;
/**
*
* @type {Array<SubscriptionRelationshipV1>}
* @memberof ComponentDetailsV1
*/
'subscriptions'?: Array<SubscriptionRelationshipV1>;
}
/**
* @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 {boolean}
* @memberof CreateWorkspaceRequest
*/
'createSetupToken'?: boolean | null;
/**
*
* @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 ExecutionHistoryEntry
*/
export interface ExecutionHistoryEntry {
/**
*
* @type {string}
* @memberof ExecutionHistoryEntry
*/
'funcRunId': string;
/**
*
* @type {string}
* @memberof ExecutionHistoryEntry
*/
'startedAt': string;
/**
*
* @type {string}
* @memberof ExecutionHistoryEntry
*/
'state': 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 FunctionExecutionStatusV1
*/
export interface FunctionExecutionStatusV1 {
/**
*
* @type {string}
* @memberof FunctionExecutionStatusV1
*/
'actionId'?: string | null;
/**
*
* @type {string}
* @memberof FunctionExecutionStatusV1
*/
'funcRunId'?: string | null;
/**
*
* @type {boolean}
* @memberof FunctionExecutionStatusV1
*/
'hasActiveRun': boolean;
/**
*
* @type {string}
* @memberof FunctionExecutionStatusV1
*/
'state': string;
}
/**
*
* @export
* @interface FunctionRelationshipV1
*/
export interface FunctionRelationshipV1 {
/**
*
* @type {Array<string>}
* @memberof FunctionRelationshipV1
*/
'dependsOn'?: Array<string>;
/**
*
* @type {Array<ExecutionHistoryEntry>}
* @memberof FunctionRelationshipV1
*/
'executionHistory'?: Array<ExecutionHistoryEntry>;
/**
*
* @type {FunctionExecutionStatusV1}
* @memberof FunctionRelationshipV1
*/
'executionStatus'?: FunctionExecutionStatusV1 | null;
/**
*
* @type {string}
* @memberof FunctionRelationshipV1
*/
'functionName': 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 ManagementRelationshipV1
*/
export interface ManagementRelationshipV1 {
/**
*
* @type {string}
* @memberof ManagementRelationshipV1
*/
'toComponentId': string;
/**
*
* @type {string}
* @memberof ManagementRelationshipV1
*/
'toComponentName': 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 OutputLineVie