@gigya/destination
Version:
Gigya API Client with SAP Cloud SDK Destination Support
1,738 lines (1,737 loc) • 68.7 kB
TypeScript
type ClientOptions = {
baseUrl: `${string}://${string}` | 'https://accounts.{gigya-domain}' | 'https://accounts.{gigya-domain}' | 'https://admin.{gigya-domain}' | 'https://admin.{gigya-domain}' | 'https://accounts.{gigya-domain}' | 'https://accounts.{gigya-domain}' | 'https://accounts.{gigya-domain}' | 'https://accounts.{gigya-domain}' | 'https://accounts.{gigya-domain}' | 'https://accounts.{gigya-domain}' | 'https://accounts.{gigya-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | 'https://accounts.{site-domain}' | (string & {});
};
type SetAccountInfoRequest = Account;
type GetAccountInfoResponse = AccountResponse & Account;
type Profile = {
photoURL?: string | null;
'certifications.number'?: string | null;
religion?: string | null;
'likes.timestamp'?: number | null;
birthYear?: number | null;
languages?: string | null;
'work.startDate'?: string | null;
industry?: string | null;
firstName?: string | null;
city?: string | null;
gender?: string | null;
hometown?: string | null;
zip?: string | null;
};
type Data = {
[key: string]: unknown;
};
type Subscriptions = {
email?: unknown;
};
type Preferences = unknown;
type Communication = {
[key: string]: {
uid?: string;
channel?: string;
readonly timestamp?: number;
topic?: string;
status?: 'opt-in' | 'opt-out' | 'notice';
};
};
type Account = {
profile?: Profile;
data?: Data;
subscriptions?: Subscriptions;
preferences?: Preferences;
communication?: Communication;
};
type BasicResponse = {
readonly errorCode: number;
readonly callId: string;
time: Date;
statusCode?: number;
apiVersion?: 2;
[key: string]: unknown | number | string | number | 2 | undefined;
};
type OkResponse = BasicResponse & {
errorCode: number;
statusCode?: number;
readonly callId: string;
time: Date;
};
type AccountResponse = OkResponse & {
UID?: string;
};
type ErrorResponse = BasicResponse & {
errorMessage: string;
errorCode: number;
errorDetails: string;
statusCode?: number;
};
type DqmCredentialsResponse = OkResponse & DqmCredentials;
type DqmCredentials = {
clientId?: string;
clientSecret?: string;
tokenUrl?: string;
applicationUrl?: string;
};
type B2bSearchResponse = B2bOrganization & OkResponse;
type B2bOrganization = {
lastUpdated?: string;
lastUpdatedTimestamp?: number;
orgId?: string;
orgName?: string;
bpid?: string;
description?: string;
source?: 'SELF_REGISTRATION' | 'BACK_OFFICE' | 'IT_ADMIN' | 'IMPORT';
type?: string;
status?: string;
info?: {
city?: Array<string>;
state?: Array<string>;
country?: Array<string>;
zip_code?: Array<string>;
street_address?: Array<string>;
};
memberLimit?: number;
};
type B2bSearchRequest = B2bSearchQuery | B2bSearchNextCursor;
type B2bSearchQuery = {
query: string;
openCursor?: boolean;
timeout?: number;
};
type B2bSearchNextCursor = {
cursorId?: string;
};
type SetupBootstrapResponse = OkResponse & {
authWorkspaces?: Array<{
authWsId?: string;
clientId?: string;
}>;
};
type DsGetResponse = OkResponse & {
object?: DsObject;
};
type DsObject = {
oid?: string;
lastUpdated?: bigint;
lastUpdatedTime?: string;
created?: bigint;
createdTime?: string;
data?: {
[key: string]: unknown;
};
};
type DsStoreParams = {
data?: {
[key: string]: unknown;
};
type?: string;
oid?: string;
UID?: string;
updateBehavior?: 'arrayPush' | 'arraySet' | 'replace';
};
type DsStoreResponse = OkResponse & {
oid?: string;
};
type DsSearchResponse = OkResponse & {
objectsCount?: number;
totalCount?: number;
results?: Array<DsObject>;
nextCursorId?: string;
};
type DsSearchParams = {
query?: string;
openCursor?: boolean;
cursorId?: boolean;
timeout?: number;
};
type SetDsSchemaRequest = {
type?: string;
dataSchema?: DataSchema;
};
type SetDsSchemaResponse = OkResponse;
type GetDsSchemaRequest = {
type?: string;
filter?: 'full' | 'clientOnly' | 'explicitOnly';
};
type GetDsSchemaResponse = {
schema?: Schema;
};
type DataSchema = Schema & {
dynamicSchema?: boolean;
};
type Schema = {
[key: string]: SchemaField;
};
type SchemaField = {
type?: 'integer' | 'float' | 'boolean' | 'string' | 'date' | 'long' | 'text' | 'binary';
writeAccess?: 'serverOnly' | 'clientModify' | 'clientCreate';
required?: boolean;
format?: string;
encrypt?: 'aes';
};
type ApiResponse = {
callId?: string;
errorCode?: number;
apiVersion?: number;
statusCode?: number;
statusReason?: string;
};
type RemoveMemberResponse = ApiResponse;
type GetGroupInfoResponse = ApiResponse & {
memberSince?: Date;
lastUpdated?: Date;
permissions?: Array<string>;
};
type GetGroupMemberInfoResponse = ApiResponse & {
result?: MemberInfo & GroupId;
};
type GetAllMemberGroupsResponse = ApiResponse & GroupInfo & MemberInfo;
type CreateModelResponse = ApiResponse & {
modelId?: string;
};
type DeleteModelResponse = ApiResponse & {
deleted?: boolean;
};
type AllModelsResponse = ApiResponse & {
models?: Array<{
model?: string;
selfProvisioning?: boolean;
}>;
};
type DeleteSchemaFieldResponse = ApiResponse & {
deleted?: boolean;
};
type GetGroupSchemaResponse = ApiResponse & {
model?: string;
groupDataSchema?: GroupSchema;
relationshipDataSchema?: GroupSchema;
};
type SetGroupSchemaResponse = ApiResponse & {
[key: string]: unknown;
};
type DeleteGroupResponse = ApiResponse & {
deleted?: boolean;
};
type AllMemberGroupsResponse = ApiResponse & {
groups?: Array<{
[key: string]: unknown;
}>;
};
type GroupInfoResponse = ApiResponse & {
groupInfo?: {
[key: string]: unknown;
};
};
type RegisterGroupResponse = ApiResponse & {
groupId?: string;
};
type SetGroupInfoResponse = ApiResponse & {
updated?: boolean;
};
type GetGroupSchemaRequest = {
model?: string;
};
type CreateModelRequest = {
model?: string;
selfProvisioning?: boolean;
};
type SetGroupMemberInfoResponse = ApiResponse & {
[key: string]: unknown;
};
type CreateInvitationResponse = ApiResponse & {
invitationLink?: string;
};
type FinalizeInvitationResponse = ApiResponse & {
[key: string]: unknown;
};
type SetSiteConfigResponse = ApiResponse & {
[key: string]: unknown;
};
type GetGroupInfoRequest = {
results?: Array<MemberInfo>;
};
type GetGroupMemberInfoRequest = {
groupId?: string;
model?: string;
include?: 'profile';
};
type GetAllMemberGroupsRequest = {
[key: string]: unknown;
};
type DeleteModelRequest = {
modelId?: string;
};
type RegisterGroupRequest = {
groupName?: string;
groupDescription?: string;
};
type SetGroupInfoRequest = {
model?: string;
groupId?: string;
groupData?: GroupData;
};
type AssignGroupMemberRequest = {
groupId?: string;
UID?: string;
};
type AssignGroupMemberResponse = ApiResponse & {
[key: string]: unknown;
};
type DeleteSchemaFieldRequest = {
model?: string;
groupDataSchemaFieldName?: string;
relationshipDataSchemaFieldName?: string;
};
type SetGroupMemberInfoRequest = MemberInfo & GroupId;
type RemoveMemberRequest = GroupId;
type CreateInvitationRequest = {
model?: string;
groupId?: string;
};
type InvitationConfirmRequest = {
invitationId?: string;
confirmationCode?: string;
};
type InvitationConfirmResponse = ApiResponse & {
confirmed?: boolean;
};
type FinalizeInvitationRequest = {
invitationId?: string;
finalCode?: string;
};
type SetSiteConfigRequest = {
configKey?: string;
configValue?: string;
};
type SetGroupSchemaRequest = {
model?: string;
groupDataSchema?: GroupSchema;
relationshipDataSchema?: GroupSchema;
};
type GroupId = {
groupId?: string;
model?: unknown;
};
type GroupInfo = GroupId & {
groupData?: GroupData;
};
type GroupData = {
[key: string]: unknown;
};
type MemberInfo = {
UID?: string;
readonly memberSince?: Date;
readonly lastUpdated?: Date;
readonly memberSinceTimestamp?: bigint;
readonly lastUpdatedTimestamp?: bigint;
permissions?: Permissions;
relationshipData?: RelationshipData;
};
type Permissions = string;
type RelationshipData = {
[key: string]: unknown;
};
type GroupSchema = {
[key: string]: DataSchemaField;
};
type DataSchemaField = {
type?: 'string' | 'integer' | 'number' | 'boolean' | 'array' | 'object';
writeAccess?: 'serverOnly' | 'clientModify';
required?: boolean;
format?: string;
};
type ActivityBlueprintModel = {
id?: string;
name?: string;
displayName?: string;
description?: string;
type?: string;
parentId?: string;
persistWorkflow?: boolean;
loadWorkflowContext?: boolean;
saveWorkflowContext?: boolean;
inputProperties?: Variables;
outputProperties?: Variables;
};
type ActivityDefinition = {
activityId?: string;
type?: string;
name?: string;
displayName?: string;
description?: string;
persistWorkflow?: boolean;
loadWorkflowContext?: boolean;
saveWorkflowContext?: boolean;
properties?: Array<ActivityDefinitionProperty>;
readonly propertyStorageProviders?: {
[key: string]: string;
};
};
type ActivityDefinitionProperty = {
name?: string;
syntax?: string;
expressions?: {
[key: string]: string;
};
};
type ActivityDescriptor = {
type?: string;
displayName?: string;
description?: string;
category?: string;
traits?: ActivityTraits;
outcomes?: Array<string>;
properties?: Array<ActivityInputDescriptor>;
inputProperties?: Array<ActivityInputDescriptor>;
outputProperties?: Array<ActivityOutputDescriptor>;
};
type ActivityInputDescriptor = {
name?: string;
type?: string;
uiHint?: string;
label?: string;
hint?: string;
options?: {
[key: string]: unknown;
};
category?: string;
order?: number;
defaultValue?: Input;
defaultSyntax?: string;
supportedSyntaxes?: Array<string>;
isReadOnly?: boolean;
isBrowsable?: boolean;
isDesignerCritical?: boolean;
defaultWorkflowStorageProvider?: string;
disableWorkflowProviderSelection?: boolean;
};
type ActivityOutputDescriptor = {
name?: string;
type?: string;
hint?: string;
defaultWorkflowStorageProvider?: string;
disableWorkflowProviderSelection?: boolean;
};
type ActivityScope = {
activityId?: string;
variables?: Variables;
};
declare const ActivityTraits: {
readonly 1: 1;
readonly 2: 2;
readonly 4: 4;
};
type ActivityTraits = typeof ActivityTraits[keyof typeof ActivityTraits];
type BlockingActivity = {
activityId?: string;
activityType?: string;
tag?: string;
};
type BulkCancelWorkflowsRequest = {
workflowInstanceIds?: Array<string>;
};
type BulkDeleteWorkflowsRequest = {
workflowInstanceIds?: Array<string>;
};
type BulkRetryWorkflowsRequest = {
workflowInstanceIds?: Array<string>;
};
type ConnectionDefinition = {
sourceActivityId?: string;
targetActivityId?: string;
outcome?: string;
};
type ConnectionModel = {
sourceActivityId?: string;
targetActivityId?: string;
outcome?: string;
};
type Instant = {
[key: string]: never;
};
type IOutputFormatter = {
[key: string]: never;
};
type JToken = Array<JToken>;
type OkObjectResult = {
value?: Input;
formatters?: Array<IOutputFormatter>;
contentTypes?: Array<string>;
declaredType?: string;
statusCode?: number;
};
declare const OrderBy: {
readonly 0: 0;
readonly 1: 1;
readonly 2: 2;
};
type OrderBy = typeof OrderBy[keyof typeof OrderBy];
type ProblemDetails = {
type?: string;
title?: string;
status?: number;
detail?: string;
instance?: string;
[key: string]: unknown | string | number | undefined;
};
type RetryWorkflowRequest = {
runImmediately?: boolean;
};
type RuntimeSelectListItemsContextHolder = {
providerTypeName?: string;
context?: {
[key: string]: unknown;
};
};
type SaveWorkflowDefinitionRequest = {
workflowDefinitionId?: string;
name?: string;
displayName?: string;
description?: string;
tag?: string;
channel?: string;
variables?: Variables;
contextOptions?: WorkflowContextOptions;
isSingleton?: boolean;
persistenceBehavior?: WorkflowPersistenceBehavior;
deleteCompletedInstances?: boolean;
publish?: boolean;
activities?: Array<ActivityDefinition>;
connections?: Array<ConnectionDefinition>;
};
type ScheduledActivity = {
activityId?: string;
input?: Input;
};
type SimpleException = {
type?: string;
message?: string;
stackTrace?: string;
innerException?: SimpleException;
data?: {
[key: string]: unknown;
};
};
type Variables = {
readonly data?: {
[key: string]: unknown;
};
};
type VersionOptions = {
readonly isLatest?: boolean;
readonly isLatestOrPublished?: boolean;
readonly isPublished?: boolean;
readonly isDraft?: boolean;
readonly allVersions?: boolean;
readonly version?: number;
};
type WorkflowBlueprintModel = {
id?: string;
name?: string;
displayName?: string;
description?: string;
type?: string;
parentId?: string;
persistWorkflow?: boolean;
loadWorkflowContext?: boolean;
saveWorkflowContext?: boolean;
inputProperties?: Variables;
outputProperties?: Variables;
activities?: Array<ActivityBlueprintModel>;
connections?: Array<ConnectionModel>;
version?: number;
tenantId?: string;
isSingleton?: boolean;
isEnabled?: boolean;
isPublished?: boolean;
isLatest?: boolean;
isDisabled?: boolean;
variables?: Variables;
contextOptions?: WorkflowContextOptions;
persistenceBehavior?: WorkflowPersistenceBehavior;
deleteCompletedInstances?: boolean;
customAttributes?: Variables;
};
type WorkflowBlueprintModelPagedList = {
items?: Array<WorkflowBlueprintModel>;
readonly page?: number;
readonly pageSize?: number;
readonly totalCount?: number;
};
type WorkflowBlueprintSummaryModel = {
id?: string;
name?: string;
displayName?: string;
description?: string;
version?: number;
tenantId?: string;
isSingleton?: boolean;
isPublished?: boolean;
isLatest?: boolean;
isDisabled?: boolean;
};
type WorkflowBlueprintSummaryModelPagedList = {
items?: Array<WorkflowBlueprintSummaryModel>;
readonly page?: number;
readonly pageSize?: number;
readonly totalCount?: number;
};
declare const WorkflowContextFidelity: {
readonly 0: 0;
readonly 1: 1;
};
type WorkflowContextFidelity = typeof WorkflowContextFidelity[keyof typeof WorkflowContextFidelity];
type WorkflowContextOptions = {
contextType?: string;
contextFidelity?: WorkflowContextFidelity;
};
type WorkflowDefinition = {
id?: string;
definitionId?: string;
readonly versionId?: string;
tenantId?: string;
name?: string;
displayName?: string;
description?: string;
channel?: string;
version?: number;
variables?: Variables;
customAttributes?: Variables;
contextOptions?: WorkflowContextOptions;
isSingleton?: boolean;
persistenceBehavior?: WorkflowPersistenceBehavior;
deleteCompletedInstances?: boolean;
isPublished?: boolean;
isLatest?: boolean;
tag?: string;
activities?: Array<ActivityDefinition>;
connections?: Array<ConnectionDefinition>;
};
type WorkflowDefinitionSummaryModel = {
id?: string;
definitionId?: string;
name?: string;
displayName?: string;
description?: string;
version?: number;
isSingleton?: boolean;
persistenceBehavior?: WorkflowPersistenceBehavior;
isPublished?: boolean;
isLatest?: boolean;
};
type WorkflowDefinitionSummaryModelPagedList = {
items?: Array<WorkflowDefinitionSummaryModel>;
readonly page?: number;
readonly pageSize?: number;
readonly totalCount?: number;
};
type WorkflowExecutionLogRecord = {
id?: string;
readonly tenantId?: string;
workflowInstanceId?: string;
activityId?: string;
activityType?: string;
timestamp?: Instant;
eventName?: string;
message?: string;
source?: string;
data?: {
[key: string]: JToken;
};
};
type WorkflowExecutionLogRecordPagedList = {
items?: Array<WorkflowExecutionLogRecord>;
readonly page?: number;
readonly pageSize?: number;
readonly totalCount?: number;
};
type WorkflowFault = {
exception?: SimpleException;
message?: string;
faultedActivityId?: string;
activityInput?: Input;
resuming?: boolean;
};
type Input = {
[key: string]: unknown;
} | string | number;
type WorkflowInputReference = {
providerName?: string;
};
type WorkflowInstance = {
id?: string;
definitionId?: string;
tenantId?: string;
version?: number;
workflowStatus?: WorkflowStatus;
correlationId?: string;
contextType?: string;
contextId?: string;
name?: string;
createdAt?: Instant;
lastExecutedAt?: Instant;
finishedAt?: Instant;
cancelledAt?: Instant;
faultedAt?: Instant;
variables?: Variables;
input?: WorkflowInputReference;
output?: WorkflowOutputReference;
activityData?: {
[key: string]: {
[key: string]: unknown;
};
};
blockingActivities?: Array<BlockingActivity>;
fault?: WorkflowFault;
scheduledActivities?: Array<ScheduledActivity>;
scopes?: Array<ActivityScope>;
currentActivity?: ScheduledActivity;
lastExecutedActivityId?: string;
};
type WorkflowInstanceSummaryModel = {
id?: string;
definitionId?: string;
tenantId?: string;
version?: number;
workflowStatus?: WorkflowStatus;
correlationId?: string;
contextType?: string;
contextId?: string;
name?: string;
createdAt?: Instant;
lastExecutedAt?: Instant;
finishedAt?: Instant;
cancelledAt?: Instant;
faultedAt?: Instant;
};
type WorkflowInstanceSummaryModelPagedList = {
items?: Array<WorkflowInstanceSummaryModel>;
readonly page?: number;
readonly pageSize?: number;
readonly totalCount?: number;
};
type WorkflowOutputReference = {
providerName?: string;
activityId?: string;
};
declare const WorkflowPersistenceBehavior: {
readonly 0: 0;
readonly 1: 1;
readonly 2: 2;
};
type WorkflowPersistenceBehavior = typeof WorkflowPersistenceBehavior[keyof typeof WorkflowPersistenceBehavior];
declare const WorkflowStatus: {
readonly 0: 0;
readonly 1: 1;
readonly 2: 2;
readonly 3: 3;
readonly 4: 4;
readonly 5: 5;
};
type WorkflowStatus = typeof WorkflowStatus[keyof typeof WorkflowStatus];
type CertificatesResponse = {
certificates?: Array<CertificateInfoResponse>;
};
type CertificateInfoResponse = {
readonly issuer?: string;
readonly subject?: string;
readonly validFrom?: string;
readonly validTo?: string;
readonly algorithm?: string;
readonly id?: string;
label?: string;
readonly publicPem?: string;
};
type BasicResponseExtension = BasicResponse;
type OkResponseExtension = OkResponse;
type AddressSuggestionsRequest = {
address: string;
country?: string;
suggestionReply?: string;
longitude?: string;
latitude?: string;
};
type AddressSuggestionsResponse = OkResponse & AddressSuggestions;
type AddressSuggestions = {
suggestions?: Array<AddressSuggestion>;
};
type AddressSuggestion = {
address?: string;
};
type AddressSuggestionsSelectRequest = {
address: string;
id: string;
};
type PhoneNumberValidationRequest = {
phoneNumber: string;
};
type PhoneNumberValidationResponse = OkResponse & PhoneNumberValidation;
type PhoneNumberValidation = {
isValid?: boolean;
};
type CommunicationWritable = {
[key: string]: {
uid?: string;
channel?: string;
topic?: string;
status?: 'opt-in' | 'opt-out' | 'notice';
};
};
type BasicResponseWritable = {
time: Date;
statusCode?: number;
apiVersion?: 2;
[key: string]: unknown | Date | number | 2 | undefined;
};
type MemberInfoWritable = {
UID?: string;
permissions?: Permissions;
relationshipData?: RelationshipData;
};
type ActivityBlueprintModelWritable = {
id?: string;
name?: string;
displayName?: string;
description?: string;
type?: string;
parentId?: string;
persistWorkflow?: boolean;
loadWorkflowContext?: boolean;
saveWorkflowContext?: boolean;
};
type ActivityDefinitionWritable = {
activityId?: string;
type?: string;
name?: string;
displayName?: string;
description?: string;
persistWorkflow?: boolean;
loadWorkflowContext?: boolean;
saveWorkflowContext?: boolean;
properties?: Array<ActivityDefinitionProperty>;
};
type ActivityScopeWritable = {
activityId?: string;
};
type SaveWorkflowDefinitionRequestWritable = {
workflowDefinitionId?: string;
name?: string;
displayName?: string;
description?: string;
tag?: string;
channel?: string;
contextOptions?: WorkflowContextOptions;
isSingleton?: boolean;
persistenceBehavior?: WorkflowPersistenceBehavior;
deleteCompletedInstances?: boolean;
publish?: boolean;
activities?: Array<ActivityDefinitionWritable>;
connections?: Array<ConnectionDefinition>;
};
type WorkflowBlueprintModelWritable = {
id?: string;
name?: string;
displayName?: string;
description?: string;
type?: string;
parentId?: string;
persistWorkflow?: boolean;
loadWorkflowContext?: boolean;
saveWorkflowContext?: boolean;
activities?: Array<ActivityBlueprintModelWritable>;
connections?: Array<ConnectionModel>;
version?: number;
tenantId?: string;
isSingleton?: boolean;
isEnabled?: boolean;
isPublished?: boolean;
isLatest?: boolean;
isDisabled?: boolean;
contextOptions?: WorkflowContextOptions;
persistenceBehavior?: WorkflowPersistenceBehavior;
deleteCompletedInstances?: boolean;
};
type WorkflowBlueprintModelPagedListWritable = {
items?: Array<WorkflowBlueprintModelWritable>;
};
type WorkflowBlueprintSummaryModelPagedListWritable = {
items?: Array<WorkflowBlueprintSummaryModel>;
};
type WorkflowDefinitionWritable = {
id?: string;
definitionId?: string;
tenantId?: string;
name?: string;
displayName?: string;
description?: string;
channel?: string;
version?: number;
contextOptions?: WorkflowContextOptions;
isSingleton?: boolean;
persistenceBehavior?: WorkflowPersistenceBehavior;
deleteCompletedInstances?: boolean;
isPublished?: boolean;
isLatest?: boolean;
tag?: string;
activities?: Array<ActivityDefinitionWritable>;
connections?: Array<ConnectionDefinition>;
};
type WorkflowDefinitionSummaryModelPagedListWritable = {
items?: Array<WorkflowDefinitionSummaryModel>;
};
type WorkflowExecutionLogRecordWritable = {
id?: string;
workflowInstanceId?: string;
activityId?: string;
activityType?: string;
timestamp?: Instant;
eventName?: string;
message?: string;
source?: string;
data?: {
[key: string]: JToken;
};
};
type WorkflowExecutionLogRecordPagedListWritable = {
items?: Array<WorkflowExecutionLogRecordWritable>;
};
type WorkflowInstanceWritable = {
id?: string;
definitionId?: string;
tenantId?: string;
version?: number;
workflowStatus?: WorkflowStatus;
correlationId?: string;
contextType?: string;
contextId?: string;
name?: string;
createdAt?: Instant;
lastExecutedAt?: Instant;
finishedAt?: Instant;
cancelledAt?: Instant;
faultedAt?: Instant;
input?: WorkflowInputReference;
output?: WorkflowOutputReference;
activityData?: {
[key: string]: {
[key: string]: unknown;
};
};
blockingActivities?: Array<BlockingActivity>;
fault?: WorkflowFault;
scheduledActivities?: Array<ScheduledActivity>;
scopes?: Array<ActivityScopeWritable>;
currentActivity?: ScheduledActivity;
lastExecutedActivityId?: string;
};
type WorkflowInstanceSummaryModelPagedListWritable = {
items?: Array<WorkflowInstanceSummaryModel>;
};
type CertificateInfoResponseWritable = {
label?: string;
};
type SetAccountInfoData = {
body?: SetAccountInfoRequest;
path?: never;
query?: never;
url: '/accounts.setAccountInfo';
};
type SetAccountInfoResponses = {
200: AccountResponse;
};
type SetAccountInfoResponse = SetAccountInfoResponses[keyof SetAccountInfoResponses];
type GetAccountInfoData = {
body?: never;
path?: never;
query: {
include?: string;
communication_selector: string;
};
url: '/accounts.getAccountInfo';
};
type GetAccountInfoErrors = {
400: ErrorResponse & {
errorMessage?: 'Invalid parameter value.';
errorCode?: 400006;
statusCode?: 400;
};
401: ErrorResponse & {
errorMessage?: 'Unauthorized user.';
errorCode?: 403005;
statusCode?: 403;
};
403: ErrorResponse & {
errorMessage?: 'You do not have permission to invoke the method.';
errorCode?: 403000;
statusCode?: 403;
};
503: ErrorResponse & {
errorCode?: 503;
};
};
type GetAccountInfoError = GetAccountInfoErrors[keyof GetAccountInfoErrors];
type GetAccountInfoResponses = {
200: GetAccountInfoResponse;
};
type GetAccountInfoResponse2 = GetAccountInfoResponses[keyof GetAccountInfoResponses];
type DqmCredentialsGetData = {
body?: DqmCredentials;
path?: never;
query?: never;
url: '/admin.dqm.credentials.get';
};
type DqmCredentialsGetErrors = {
400: ErrorResponse & {
errorMessage?: 'Invalid parameter value.';
errorCode?: 400006;
statusCode?: 400;
};
401: ErrorResponse & {
errorMessage?: 'Unauthorized user.';
errorCode?: 403005;
statusCode?: 403;
};
403: ErrorResponse & {
errorMessage?: 'You do not have permission to invoke the method.';
errorCode?: 403000;
statusCode?: 403;
};
404: ErrorResponse & {
errorCode?: unknown;
statusCode?: 404;
};
503: ErrorResponse & {
errorCode?: 503;
};
};
type DqmCredentialsGetError = DqmCredentialsGetErrors[keyof DqmCredentialsGetErrors];
type DqmCredentialsGetResponses = {
200: OkResponse & DqmCredentials;
};
type DqmCredentialsGetResponse = DqmCredentialsGetResponses[keyof DqmCredentialsGetResponses];
type DqmCredentialsSetData = {
body?: DqmCredentials;
path?: never;
query?: never;
url: '/admin.dqm.credentials.set';
};
type DqmCredentialsSetErrors = {
400: ErrorResponse & {
errorMessage?: 'Invalid parameter value.';
errorCode?: 400006;
statusCode?: 400;
};
401: ErrorResponse & {
errorMessage?: 'Unauthorized user.';
errorCode?: 403005;
statusCode?: 403;
};
403: ErrorResponse & {
errorMessage?: 'You do not have permission to invoke the method.';
errorCode?: 403000;
statusCode?: 403;
};
404: ErrorResponse & {
errorCode?: unknown;
statusCode?: 404;
};
503: ErrorResponse & {
errorCode?: 503;
};
};
type DqmCredentialsSetError = DqmCredentialsSetErrors[keyof DqmCredentialsSetErrors];
type DqmCredentialsSetResponses = {
200: OkResponse;
};
type DqmCredentialsSetResponse = DqmCredentialsSetResponses[keyof DqmCredentialsSetResponses];
type AccountsB2bSetupBootstrapData = {
body?: never;
path?: never;
query?: {
integration?: string;
};
url: '/accounts.b2b.setup.bootstrap';
};
type AccountsB2bSetupBootstrapResponses = {
200: SetupBootstrapResponse;
};
type AccountsB2bSetupBootstrapResponse = AccountsB2bSetupBootstrapResponses[keyof AccountsB2bSetupBootstrapResponses];
type AccountsB2bSearchData = {
body?: B2bSearchRequest;
path?: never;
query?: never;
url: '/accounts.b2b.search';
};
type AccountsB2bSearchErrors = {
400: ErrorResponse & {
errorMessage?: 'Invalid parameter value.';
errorCode?: 400006;
statusCode?: 400;
};
401: ErrorResponse & {
errorMessage?: 'Unauthorized user.';
errorCode?: 403005;
statusCode?: 403;
};
403: ErrorResponse & {
errorMessage?: 'You do not have permission to invoke the method.';
errorCode?: 403000;
statusCode?: 403;
};
503: ErrorResponse & {
errorCode?: 503;
};
};
type AccountsB2bSearchError = AccountsB2bSearchErrors[keyof AccountsB2bSearchErrors];
type AccountsB2bSearchResponses = {
200: B2bSearchResponse;
};
type AccountsB2bSearchResponse = AccountsB2bSearchResponses[keyof AccountsB2bSearchResponses];
type CommunicationUpdateData = {
body?: CommunicationWritable;
path?: never;
query?: never;
url: '/accounts.communication.set';
};
type CommunicationUpdateResponses = {
200: OkResponse;
};
type CommunicationUpdateResponse = CommunicationUpdateResponses[keyof CommunicationUpdateResponses];
type CommunicationGetData = {
body?: never;
path?: never;
query: {
selector: string;
};
url: '/accounts.communication.get';
};
type CommunicationGetErrors = {
400: ErrorResponse & {
errorMessage?: 'Invalid parameter value.';
errorCode?: 400006;
statusCode?: 400;
};
401: ErrorResponse & {
errorMessage?: 'Unauthorized user.';
errorCode?: 403005;
statusCode?: 403;
};
403: ErrorResponse & {
errorMessage?: 'You do not have permission to invoke the method.';
errorCode?: 403000;
statusCode?: 403;
};
503: ErrorResponse & {
errorCode?: 503;
};
};
type CommunicationGetError = CommunicationGetErrors[keyof CommunicationGetErrors];
type CommunicationGetResponses = {
200: AccountResponse & {
communication?: Communication;
};
};
type CommunicationGetResponse = CommunicationGetResponses[keyof CommunicationGetResponses];
type DsSetSchemaData = {
body: SetDsSchemaRequest;
path?: never;
query?: never;
url: '/ds.setSchema';
};
type DsSetSchemaErrors = {
400: unknown;
401: unknown;
'4XX': unknown;
};
type DsSetSchemaResponses = {
200: OkResponse;
};
type DsSetSchemaResponse = DsSetSchemaResponses[keyof DsSetSchemaResponses];
type DsGetSchemaData = {
body: GetDsSchemaRequest;
path?: never;
query?: never;
url: '/ds.getSchema';
};
type DsGetSchemaErrors = {
400: ErrorResponse & {
errorMessage?: 'Invalid parameter value.';
errorCode?: 400006;
statusCode?: 400;
};
401: ErrorResponse & {
errorMessage?: 'Unauthorized user.';
errorCode?: 403005;
statusCode?: 403;
};
403: ErrorResponse & {
errorMessage?: 'You do not have permission to invoke the method.';
errorCode?: 403000;
statusCode?: 403;
};
404: ErrorResponse & {
errorCode?: unknown;
statusCode?: 404;
};
503: ErrorResponse & {
errorCode?: 503;
};
};
type DsGetSchemaError = DsGetSchemaErrors[keyof DsGetSchemaErrors];
type DsGetSchemaResponses = {
200: OkResponse & GetDsSchemaResponse;
};
type DsGetSchemaResponse = DsGetSchemaResponses[keyof DsGetSchemaResponses];
type DsGetData = {
body: {
oid?: string;
type?: string;
fields?: string;
UID?: string;
};
path?: never;
query?: never;
url: '/ds.get';
};
type DsGetErrors = {
400: ErrorResponse & {
errorMessage?: 'Invalid parameter value.';
errorCode?: 400006;
statusCode?: 400;
};
401: ErrorResponse & {
errorMessage?: 'Unauthorized user.';
errorCode?: 403005;
statusCode?: 403;
};
403: ErrorResponse & {
errorMessage?: 'You do not have permission to invoke the method.';
errorCode?: 403000;
statusCode?: 403;
};
404: ErrorResponse & {
errorMessage?: 'UID not found';
errorCode?: 404003;
statusCode?: 404;
};
503: ErrorResponse & {
errorCode?: 503;
};
};
type DsGetError = DsGetErrors[keyof DsGetErrors];
type DsGetResponses = {
200: DsGetResponse;
};
type DsGetResponse2 = DsGetResponses[keyof DsGetResponses];
type DsStoreData = {
body: DsStoreParams;
path?: never;
query?: never;
url: '/ds.store';
};
type DsStoreErrors = {
400: ErrorResponse & {
errorMessage?: 'Invalid parameter value.';
errorCode?: 400006;
statusCode?: 400;
};
401: ErrorResponse & {
errorMessage?: 'Unauthorized user.';
errorCode?: 403005;
statusCode?: 403;
};
403: ErrorResponse & {
errorMessage?: 'You do not have permission to invoke the method.';
errorCode?: 403000;
statusCode?: 403;
};
404: ErrorResponse & {
errorMessage?: 'UID not found';
errorCode?: 404003;
statusCode?: 404;
};
503: ErrorResponse & {
errorCode?: 503;
};
};
type DsStoreError = DsStoreErrors[keyof DsStoreErrors];
type DsStoreResponses = {
200: DsStoreResponse;
};
type DsStoreResponse2 = DsStoreResponses[keyof DsStoreResponses];
type DsSearchData = {
body: DsSearchParams;
path?: never;
query?: never;
url: '/ds.search';
};
type DsSearchErrors = {
400: unknown;
401: unknown;
500: unknown;
};
type DsSearchResponses = {
200: DsSearchResponse;
};
type DsSearchResponse2 = DsSearchResponses[keyof DsSearchResponses];
type AccountsGroupsCreateModelData = {
body: CreateModelRequest;
path?: never;
query?: never;
url: '/accounts.groups.createModel';
};
type AccountsGroupsCreateModelResponses = {
200: CreateModelResponse;
};
type AccountsGroupsCreateModelResponse = AccountsGroupsCreateModelResponses[keyof AccountsGroupsCreateModelResponses];
type AccountsGroupsDeleteModelData = {
body: DeleteModelRequest;
path?: never;
query?: never;
url: '/accounts.groups.deleteModel';
};
type AccountsGroupsDeleteModelResponses = {
200: DeleteModelResponse;
};
type AccountsGroupsDeleteModelResponse = AccountsGroupsDeleteModelResponses[keyof AccountsGroupsDeleteModelResponses];
type AccountsGroupsGetAllModelsData = {
body?: never;
path?: never;
query?: never;
url: '/accounts.groups.getAllModels';
};
type AccountsGroupsGetAllModelsResponses = {
default: AllModelsResponse;
};
type AccountsGroupsGetAllModelsResponse = AccountsGroupsGetAllModelsResponses[keyof AccountsGroupsGetAllModelsResponses];
type AccountsGroupsRegisterGroupData = {
body: RegisterGroupRequest;
path?: never;
query?: never;
url: '/accounts.groups.registerGroup';
};
type AccountsGroupsRegisterGroupResponses = {
200: RegisterGroupResponse;
};
type AccountsGroupsRegisterGroupResponse = AccountsGroupsRegisterGroupResponses[keyof AccountsGroupsRegisterGroupResponses];
type AccountsGroupsSetGroupInfoData = {
body: SetGroupInfoRequest;
path?: never;
query?: never;
url: '/accounts.groups.setGroupInfo';
};
type AccountsGroupsSetGroupInfoResponses = {
200: SetGroupInfoResponse;
};
type AccountsGroupsSetGroupInfoResponse = AccountsGroupsSetGroupInfoResponses[keyof AccountsGroupsSetGroupInfoResponses];
type AccountsGroupsAssignGroupMemberData = {
body: AssignGroupMemberRequest;
path?: never;
query?: never;
url: '/accounts.groups.assignGroupMember';
};
type AccountsGroupsAssignGroupMemberResponses = {
200: AssignGroupMemberResponse;
};
type AccountsGroupsAssignGroupMemberResponse = AccountsGroupsAssignGroupMemberResponses[keyof AccountsGroupsAssignGroupMemberResponses];
type AccountsGroupsSetGroupMemberInfoData = {
body: SetGroupMemberInfoRequest;
path?: never;
query?: never;
url: '/accounts.groups.setGroupMemberInfo';
};
type AccountsGroupsSetGroupMemberInfoResponses = {
200: SetGroupMemberInfoResponse;
};
type AccountsGroupsSetGroupMemberInfoResponse = AccountsGroupsSetGroupMemberInfoResponses[keyof AccountsGroupsSetGroupMemberInfoResponses];
type AccountsGroupsGetGroupMemberInfoData = {
body?: GetGroupMemberInfoRequest;
path?: never;
query?: never;
url: '/accounts.groups.getGroupMemberInfo';
};
type AccountsGroupsGetGroupMemberInfoResponses = {
default: GetGroupMemberInfoResponse;
};
type AccountsGroupsGetGroupMemberInfoResponse = AccountsGroupsGetGroupMemberInfoResponses[keyof AccountsGroupsGetGroupMemberInfoResponses];
type AccountsGroupsRemoveMemberData = {
body: GroupId;
path?: never;
query?: never;
url: '/accounts.groups.removeMember';
};
type AccountsGroupsRemoveMemberResponses = {
200: ApiResponse;
};
type AccountsGroupsRemoveMemberResponse = AccountsGroupsRemoveMemberResponses[keyof AccountsGroupsRemoveMemberResponses];
type AccountsGroupsCreateInvitationData = {
body: CreateInvitationRequest;
path?: never;
query?: never;
url: '/accounts.groups.createInvitation';
};
type AccountsGroupsCreateInvitationResponses = {
200: CreateInvitationResponse;
};
type AccountsGroupsCreateInvitationResponse = AccountsGroupsCreateInvitationResponses[keyof AccountsGroupsCreateInvitationResponses];
type AccountsGroupsInvitationConfirmData = {
body: InvitationConfirmRequest;
path?: never;
query?: never;
url: '/accounts.groups.invitationConfirm';
};
type AccountsGroupsInvitationConfirmResponses = {
200: InvitationConfirmResponse;
};
type AccountsGroupsInvitationConfirmResponse = AccountsGroupsInvitationConfirmResponses[keyof AccountsGroupsInvitationConfirmResponses];
type AccountsGroupsFinalizeInvitationData = {
body: FinalizeInvitationRequest;
path?: never;
query?: never;
url: '/accounts.groups.finalizeInvitation';
};
type AccountsGroupsFinalizeInvitationResponses = {
200: FinalizeInvitationResponse;
};
type AccountsGroupsFinalizeInvitationResponse = AccountsGroupsFinalizeInvitationResponses[keyof AccountsGroupsFinalizeInvitationResponses];
type AccountsGroupsSetSiteConfigData = {
body: SetSiteConfigRequest;
path?: never;
query?: never;
url: '/accounts.groups.setSiteConfig';
};
type AccountsGroupsSetSiteConfigResponses = {
200: SetSiteConfigResponse;
};
type AccountsGroupsSetSiteConfigResponse = AccountsGroupsSetSiteConfigResponses[keyof AccountsGroupsSetSiteConfigResponses];
type AccountsGroupsGetGroupInfoData = {
body?: GetGroupInfoRequest;
path?: never;
query?: never;
url: '/accounts.groups.getGroupInfo';
};
type AccountsGroupsGetGroupInfoResponses = {
200: GetGroupInfoResponse;
};
type AccountsGroupsGetGroupInfoResponse = AccountsGroupsGetGroupInfoResponses[keyof AccountsGroupsGetGroupInfoResponses];
type AccountsGroupsGetAllMemberGroupsData = {
body?: GetAllMemberGroupsRequest;
path?: never;
query?: never;
url: '/accounts.groups.getAllMemberGroups';
};
type AccountsGroupsGetAllMemberGroupsResponses = {
200: GetAllMemberGroupsResponse;
};
type AccountsGroupsGetAllMemberGroupsResponse = AccountsGroupsGetAllMemberGroupsResponses[keyof AccountsGroupsGetAllMemberGroupsResponses];
type AccountsGroupsSetSchemaData = {
body: SetGroupSchemaRequest;
path?: never;
query?: never;
url: '/accounts.groups.setSchema';
};
type AccountsGroupsSetSchemaResponses = {
200: SetGroupSchemaResponse;
};
type AccountsGroupsSetSchemaResponse = AccountsGroupsSetSchemaResponses[keyof AccountsGroupsSetSchemaResponses];
type AccountsGroupsGetSchemaData = {
body?: GetGroupSchemaRequest;
path?: never;
query?: never;
url: '/accounts.groups.getSchema';
};
type AccountsGroupsGetSchemaResponses = {
200: GetGroupSchemaResponse;
};
type AccountsGroupsGetSchemaResponse = AccountsGroupsGetSchemaResponses[keyof AccountsGroupsGetSchemaResponses];
type AccountsGroupsDeleteSchemaFieldData = {
body?: DeleteSchemaFieldRequest;
path?: never;
query?: never;
url: '/accounts.groups.deleteSchemaField';
};
type AccountsGroupsDeleteSchemaFieldResponses = {
200: DeleteSchemaFieldResponse;
};
type AccountsGroupsDeleteSchemaFieldResponse = AccountsGroupsDeleteSchemaFieldResponses[keyof AccountsGroupsDeleteSchemaFieldResponses];
type WorkflowInstancesBulkCancelData = {
body?: BulkCancelWorkflowsRequest;
path?: never;
query?: never;
url: '/v1/workflow-instances/bulk/cancel';
};
type WorkflowInstancesBulkCancelResponses = {
200: unknown;
};
type WorkflowInstancesBulkDeleteData = {
body?: BulkDeleteWorkflowsRequest;
path?: never;
query?: never;
url: '/v1/workflow-instances/bulk';
};
type WorkflowInstancesBulkDeleteResponses = {
200: unknown;
};
type WorkflowInstancesBulkRetryData = {
body?: BulkRetryWorkflowsRequest;
path?: never;
query?: never;
url: '/v1/workflow-instances/bulk/retry';
};
type WorkflowInstancesBulkRetryResponses = {
200: unknown;
};
type WorkflowInstancesCancelData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/v1/workflow-instances/{id}/cancel';
};
type WorkflowInstancesCancelErrors = {
400: ProblemDetails;
404: ProblemDetails;
};
type WorkflowInstancesCancelError = WorkflowInstancesCancelErrors[keyof WorkflowInstancesCancelErrors];
type WorkflowInstancesCancelResponses = {
200: unknown;
};
type WorkflowInstancesDeleteData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/v1/workflow-instances/{id}';
};
type WorkflowInstancesDeleteErrors = {
404: ProblemDetails;
};
type WorkflowInstancesDeleteError = WorkflowInstancesDeleteErrors[keyof WorkflowInstancesDeleteErrors];
type WorkflowInstancesDeleteResponses = {
204: void;
};
type WorkflowInstancesDeleteResponse = WorkflowInstancesDeleteResponses[keyof WorkflowInstancesDeleteResponses];
type WorkflowInstancesGetData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/v1/workflow-instances/{id}';
};
type WorkflowInstancesGetResponses = {
200: WorkflowInstance;
};
type WorkflowInstancesGetResponse = WorkflowInstancesGetResponses[keyof WorkflowInstancesGetResponses];
type WorkflowDefinitionsDeleteData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/v1/workflow-definitions/{id}';
};
type WorkflowDefinitionsDeleteResponses = {
202: unknown;
};
type WorkflowDefinitionsExportData = {
body?: never;
path: {
workflowDefinitionId: string;
versionOptions: VersionOptions;
};
query?: never;
url: '/v1/workflow-definitions/{workflowDefinitionId}/{versionOptions}/export';
};
type WorkflowDefinitionsExportErrors = {
404: ProblemDetails;
};
type WorkflowDefinitionsExportError = WorkflowDefinitionsExportErrors[keyof WorkflowDefinitionsExportErrors];
type WorkflowDefinitionsExportResponses = {
200: unknown;
};
type WorkflowBlueprintsGetData = {
body?: never;
path: {
id: string;
versionOptions: VersionOptions;
};
query?: never;
url: '/v1/workflow-registry/{id}/{versionOptions}';
};
type WorkflowBlueprintsGetResponses = {
200: WorkflowBlueprintModelPagedList;
};
type WorkflowBlueprintsGetResponse = WorkflowBlueprintsGetResponses[keyof WorkflowBlueprintsGetResponses];
type WorkflowExecutionLogGetData = {
body?: never;
path: {
id: string;
};
query?: {
page?: number;
pageSize?: number;
};
url: '/v1/workflow-instances/{id}/execution-log';
};
type WorkflowExecutionLogGetResponses = {
200: WorkflowExecutionLogRecordPagedList;
};
type WorkflowExecutionLogGetResponse = WorkflowExecutionLogGetResponses[keyof WorkflowExecutionLogGetResponses];
type JavaScriptLanguageServicesGetTypeDefinitionsData = {
body?: never;
path: {
workflowDefinitionId: string;
};
query?: {
context?: string;
version?: VersionOptions;
};
url: '/v1/scripting/javascript/type-definitions/{workflowDefinitionId}';
};
type JavaScriptLanguageServicesGetTypeDefinitionsResponses = {
200: Blob | File;
};
type JavaScriptLanguageServicesGetTypeDefinitionsResponse = JavaScriptLanguageServicesGetTypeDefinitionsResponses[keyof JavaScriptLanguageServicesGetTypeDefinitionsResponses];
type DesignerRuntimeSelectListItemsGetData = {
body?: RuntimeSelectListItemsContextHolder;
path?: never;
query?: never;
url: '/v1/designer/runtime-select-list-items';
};
type DesignerRuntimeSelectListItemsGetResponses = {
200: OkObjectResult;
};
type DesignerRuntimeSelectListItemsGetResponse = DesignerRuntimeSelectListItemsGetResponses[keyof DesignerRuntimeSelectListItemsGetResponses];
type WorkflowDefinitionsGetByDefinitionAndVersionData = {
body?: never;
path: {
workflowDefinitionId: string;
versionOptions: VersionOptions;
};
query?: never;
url: '/v1/workflow-definitions/{workflowDefinitionId}/{versionOptions}';
};
type WorkflowDefinitionsGetByDefinitionAndVersionErrors = {
404: ProblemDetails;
};
type WorkflowDefinitionsGetByDefinitionAndVersionError = WorkflowDefinitionsGetByDefinitionAndVersionErrors[keyof WorkflowDefinitionsGetByDefinitionAndVersionErrors];
type WorkflowDefinitionsGetByDefinitionAndVersionResponses = {
200: WorkflowDefinition;
};
type WorkflowDefinitionsGetByDefinitionAndVersionResponse = WorkflowDefinitionsGetByDefinitionAndVersionResponses[keyof WorkflowDefinitionsGetByDefinitionAndVersionResponses];
type WorkflowDefinitionsGetByVersionIdData = {
body?: never;
path: {
versionId: string;
};
query?: never;
url: '/v1/workflow-definitions/{versionId}';
};
type WorkflowDefinitionsGetByVersionIdErrors = {
404: ProblemDetails;
};
type WorkflowDefinitionsGetByVersionIdError = WorkflowDefinitionsGetByVersionIdErrors[keyof WorkflowDefinitionsGetByVersionIdErrors];
type WorkflowDefinitionsGetByVersionIdResponses = {
200: WorkflowDefinition;
};
type WorkflowDefinitionsGetByVersionIdResponse = WorkflowDefinitionsGetByVersionIdResponses[keyof WorkflowDefinitionsGetByVersionIdResponses];
type WorkflowDefinitionsImportData = {
body?: {
ContentType?: string;
ContentDisposition?: string;
Headers?: {
[key: string]: Array<string>;
};
Length?: bigint;
Name?: string;
FileName?: string;
};
path: {
workflowDefinitionId: string;
};
query?: never;
url: '/v1/workflow-definitions/{workflowDefinitionId}/import';
};
type WorkflowDefinitionsImportResponses = {
200: unknown;
};
type WorkflowBlueprintsListData = {
body?: never;
path?: never;
query?: {
page?: number;
pageSize?: number;
version?: VersionOptions;
};
url: '/v1/workflow-registry';
};
type WorkflowBlueprintsListResponses = {
200: WorkflowBlueprintSummaryModelPagedList;
};
type WorkflowBlueprintsListResponse = WorkflowBlueprintsListResponses[keyof WorkflowBlueprintsListResponses];
type WorkflowInstancesListData = {
body?: never;
path?: never;
query?: {
workflow?: string;
status?: WorkflowStatus;
correlationId?: string;
orderBy?: OrderBy;
searchTerm?: string;
page?: number;
pageSize?: number;
};
url: '/v1/workflow-instances';
};
type WorkflowInstancesListResponses = {
200: WorkflowInstanceSummaryModelPagedList;
};
type WorkflowInstancesListResponse = WorkflowInstancesListResponses[keyof WorkflowInstancesListResponses];
type WorkflowDefinitionsListData = {
body?: never;
path?: never;
query?: {
ids?: string;
page?: number;
pageSize?: number;
version?: VersionOptions;
};
url: '/v1/workflow-definitions';
};
type WorkflowDefinitionsListResponses = {
200: WorkflowDefinitionSummaryModelPagedList;
};
type WorkflowDefinitionsListResponse = WorkflowDefinitionsListResponses[keyof WorkflowDefinitionsListResponses];
type WorkflowDefinitionsPostData = {
body?: SaveWorkflowDefinitionRequestWritable;
path: {
GroupVersion: Date;
MajorVersion: number;
MinorVersion: number;
Status: string;
};
query?: never;
url: '/v1/workflow-definitions';
};
type WorkflowDefinitionsPostResponses = {
201: WorkflowDefinition;
};
type WorkflowDefinitionsPostResponse = WorkflowDefinitionsPostResponses[keyof WorkflowDefinitionsPostResponses];
type ActivitiesListData = {
body?: never;
path?: never;
query?: never;
url: '/v1/activities';
};
type ActivitiesListResponses = {
200: Array<ActivityDescriptor>;
};
type ActivitiesListResponse = ActivitiesListResponses[keyof ActivitiesListResponses];
type WorkflowDefinitionsPublishData = {
body?: never;
path: {
workflowDefinitionId: string;
};
query?: never;