UNPKG

@gigya/destination

Version:

Gigya API Client with SAP Cloud SDK Destination Support

1,574 lines 99.7 kB
declare const setAccountInfoRequestSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; declare const getAccountInfoResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/account_response"; }, { readonly $ref: "#/components/schemas/account"; }]; }; declare const profileSchema: { readonly type: "object"; readonly properties: { readonly photoURL: { readonly type: readonly ["string", "null"]; }; readonly 'certifications.number': { readonly type: readonly ["string", "null"]; }; readonly religion: { readonly type: readonly ["string", "null"]; }; readonly 'likes.timestamp': { readonly type: readonly ["number", "null"]; }; readonly birthYear: { readonly type: readonly ["number", "null"]; }; readonly languages: { readonly type: readonly ["string", "null"]; }; readonly 'work.startDate': { readonly type: readonly ["string", "null"]; }; readonly industry: { readonly type: readonly ["string", "null"]; }; readonly firstName: { readonly type: readonly ["string", "null"]; }; readonly city: { readonly type: readonly ["string", "null"]; }; readonly gender: { readonly format: "regex"; readonly pattern: "('^[fmu]{1}$')"; readonly type: readonly ["string", "null"]; }; readonly hometown: { readonly type: readonly ["string", "null"]; }; readonly zip: { readonly type: readonly ["string", "null"]; }; }; }; declare const dataSchema: { readonly type: "object"; readonly additionalProperties: true; }; declare const subscriptionsSchema: { readonly properties: { readonly email: { readonly additionalProperties: { readonly type: "object"; readonly properties: { readonly isSubscribed: { readonly type: "boolean"; }; }; }; }; }; }; declare const preferencesSchema: { readonly additionalProperties: { readonly properties: { readonly isConsentGranted: { readonly type: "boolean"; }; }; }; }; declare const communicationSchema: { readonly type: "object"; readonly $id: "CommunicationModel"; readonly 'x-tags': readonly ["communication"]; readonly propertyNames: { readonly pattern: "(\\S+)(_)(sms+|email+)"; }; readonly additionalProperties: { readonly type: "object"; readonly properties: { readonly uid: { readonly description: "Represents the user who subscribed to thos topic"; readonly type: "string"; }; readonly channel: { readonly type: "string"; readonly examples: readonly ["sms", "email"]; }; readonly timestamp: { readonly type: "integer"; readonly description: "timestamp of the action"; readonly readOnly: true; }; readonly topic: { readonly description: "Represents a unique id of a communication list"; readonly type: "string"; readonly examples: readonly ["newslatter", "special-offers"]; }; readonly status: { readonly enum: readonly ["opt-in", "opt-out", "notice"]; readonly examples: readonly ["opt-in", "opt-out", "notice"]; }; }; }; readonly example: { readonly news_sms: { readonly topic: "news"; readonly channel: "sms"; readonly status: "opt-in"; readonly timestamp: 567003434; }; readonly news_email: { readonly topic: "news"; readonly channel: "email"; readonly status: "opt-out"; readonly timestamp: 567003434; }; readonly deals_email: { readonly topic: "deals"; readonly channel: "email"; readonly status: "noticed"; readonly timestamp: 567003434; }; }; }; declare const accountSchema: { readonly $id: "account"; readonly title: "Account Object"; readonly description: "The Account Object"; readonly type: "object"; readonly properties: { readonly profile: { readonly $ref: "#/components/schemas/profile"; }; readonly data: { readonly $ref: "#/components/schemas/data"; }; readonly subscriptions: { readonly $ref: "#/components/schemas/subscriptions"; }; readonly preferences: { readonly $ref: "#/components/schemas/preferences"; }; readonly communication: { readonly $ref: "#/components/schemas/communication"; }; }; }; declare const basic_responseSchema: { readonly 'x-tags': readonly ["basic_response"]; readonly type: "object"; readonly required: readonly ["callId", "errorCode", "time"]; readonly properties: { readonly errorCode: { readonly type: "integer"; readonly readOnly: true; }; readonly callId: { readonly type: "string"; readonly readOnly: true; }; readonly time: { readonly type: "string"; readonly format: "date-time"; }; readonly statusCode: { readonly type: "integer"; readonly minimum: 200; readonly maximum: 599; }; readonly apiVersion: { readonly type: "integer"; readonly const: 2; }; }; readonly additionalProperties: true; }; declare const ok_responseSchema: { readonly 'x-tags': readonly ["ok_response"]; readonly type: "object"; readonly required: readonly ["callId", "errorCode", "time"]; readonly allOf: readonly [{ readonly $ref: "#/components/schemas/basic_response"; }]; readonly properties: { readonly errorCode: { readonly type: "integer"; readonly minimum: 200; readonly maximum: 299; }; readonly statusCode: { readonly type: "integer"; readonly minimum: 200; readonly maximum: 399; }; }; }; declare const account_responseSchema: { readonly 'x-tags': readonly ["account_response"]; readonly type: "object"; readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ok_response"; }, { readonly properties: { readonly UID: { readonly type: "string"; readonly description: "User external Id"; }; }; }]; }; declare const error_responseSchema: { readonly 'x-tags': readonly ["error_response"]; readonly type: "object"; readonly required: readonly ["errorCode", "errorMessage", "errorDetails"]; readonly allOf: readonly [{ readonly $ref: "#/components/schemas/basic_response"; }]; readonly properties: { readonly errorMessage: { readonly type: "string"; }; readonly errorCode: { readonly type: "integer"; readonly minimum: 400000; readonly maximum: 599999; }; readonly errorDetails: { readonly type: "string"; }; readonly statusCode: { readonly type: "integer"; readonly minimum: 400; readonly maximum: 599; }; }; }; declare const DqmCredentialsResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ok_response"; }, { readonly $ref: "#/components/schemas/DqmCredentials"; }]; }; declare const DqmCredentialsSchema: { readonly type: "object"; readonly properties: { readonly clientId: { readonly type: "string"; }; readonly clientSecret: { readonly type: "string"; }; readonly tokenUrl: { readonly type: "string"; }; readonly applicationUrl: { readonly type: "string"; }; }; }; declare const B2BSearchResponseSchema: { readonly description: "Search Organization Response"; readonly allOf: readonly [{ readonly $ref: "#/components/schemas/B2BOrganization"; }, { readonly $ref: "#/components/schemas/ok_response"; }]; }; declare const B2BOrganizationSchema: { readonly properties: { readonly lastUpdated: { readonly type: "string"; readonly example: "2022-12-08T14:05:09.221Z"; }; readonly lastUpdatedTimestamp: { readonly type: "number"; readonly example: 1670508309221; }; readonly orgId: { readonly type: "string"; readonly example: "70e2a7f5-32c7-4382-a2c7-ab697eab3eba"; readonly description: "The organization's orgId"; }; readonly orgName: { readonly type: "string"; readonly example: "file-org1"; readonly description: "The organization name"; }; readonly bpid: { readonly type: "string"; readonly example: "ifle-org1"; readonly description: "The organization's Business Partner ID"; }; readonly description: { readonly type: "string"; readonly example: "my organization"; readonly description: "The organization's description"; }; readonly source: { readonly type: "string"; readonly description: "The origin of the organization details"; readonly enum: readonly ["SELF_REGISTRATION", "BACK_OFFICE", "IT_ADMIN", "IMPORT"]; readonly example: "IT_ADMIN"; }; readonly type: { readonly type: "string"; readonly description: "The organization type"; readonly example: "DISTRIBUTOR"; }; readonly status: { readonly type: "string"; readonly description: "The organization status"; readonly example: "APPROVED"; }; readonly info: { readonly type: "object"; readonly properties: { readonly city: { readonly type: "array"; readonly items: { readonly type: "string"; readonly example: "P-T"; }; readonly description: "The organization city"; }; readonly state: { readonly type: "array"; readonly items: { readonly type: "string"; readonly example: "center"; readonly description: "The organization state"; }; }; readonly country: { readonly type: "array"; readonly items: { readonly type: "string"; readonly example: "germany"; readonly description: "The organization country"; }; }; readonly zip_code: { readonly type: "array"; readonly items: { readonly type: "string"; readonly example: 4925964; readonly description: "The organization zip code"; }; }; readonly street_address: { readonly type: "array"; readonly items: { readonly type: "string"; readonly example: "strusburg 143"; readonly description: "The organization address line"; }; }; }; }; readonly memberLimit: { readonly type: "number"; readonly description: "The max number of organization members"; readonly example: 100; }; }; }; declare const B2BSearchRequestSchema: { readonly description: "Search Organization Request"; readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/B2BSearchQuery"; }, { readonly $ref: "#/components/schemas/B2BSearchNextCursor"; }]; }; declare const B2BSearchQuerySchema: { readonly required: readonly ["query"]; readonly properties: { readonly query: { readonly type: "string"; readonly examples: readonly ["select * from organizations where status = 'APROVED'", "select * from organizations where status = 'APROVED' and type = 'DISTRIBUTOR'", "select status, type from organizations where status = 'Denied'", "SELECT * FROM organizations", "SELECT * FROM organization_requests WHERE created > \"YYYY-MM-DDThh.mm.ss.msmsmsZ\"", "SELECT * FROM organization_requests WHERE created > \"2023-03-26T13:12:02.752Z\""]; readonly pattern: "SELECT\\s+\\*\\s+FROM\\s+(organizations|organization_requests)\\s+WHERE\\s+(\\w+\\s*(=|>|<|>=|<=|!=|IN)\\s*('[^']*'|\\d+|\\w+|\\(\\s*\\d+\\s*,\\s*\\d+\\s*\\)|\\(\\s*'[^']*'\\s*,\\s*'[^']*'\\s*\\))\\s*(AND\\s+\\w+\\s*(=|>|<|>=|<=|!=|IN)\\s*('[^']*'|\\d+|\\w+|\\(\\s*\\d+\\s*,\\s*\\d+\\s*\\)|\\(\\s*'[^']*'\\s*,\\s*'[^']*'\\s*\\))\\s*)*)?(\\s+ORDER\\s+BY\\s+\\w+\\s+(ASC|DESC))?\\s*(\\s+LIMIT\\s+\\d+)?\\s*;?"; readonly description: "An SQL-like query specifying the data to retrieve.\nPlease refer to the Query language specification section above.\nWhen using cursors, this parameter should only be sent with the initial request\nand omitted from subsequent requests\n"; }; readonly openCursor: { readonly type: "boolean"; readonly example: true; readonly description: "When set to true, the search response will include,\nin addition to the first page, another field named __nextCursorId__,\nwhich is used to fetch the next batch of results.\nThis parameter should only be used on the first request and later should be\nremoved from the request.\nWhen openCursor is active, the Limit clause sets the number of results returned in the batch.\n* You cannot pass both cursorId and query on the same request - cursorId brings\nthe next page for the search for which it was opened.\nAlso, the time between search requests using a cursorId must not exceed 5 minutes.\n* Each request should contain a different cursorId obtained\nfrom the response of the previous request (not the first) using\nthe nextCursorId field. The exception to this rule is when a request fails or\nwhen a particular result set needs to be resent; in this case,\nresend the same cursorID (as long as it has not expired) to receive its associated result set.\n"; }; readonly timeout: { readonly type: "number"; readonly example: 1000; readonly description: "The timeout for the request (in milliseconds). Default value is 20000 (20 seconds).\nMaximum allowed value is 60000 (60 seconds).\n"; }; }; }; declare const B2BSearchNextCursorSchema: { readonly properties: { readonly cursorId: { readonly type: "string"; readonly example: "abcf14gfte"; readonly description: "The cursor ID that contains the __nextCursorId__ value received in the first search call\n"; }; }; }; declare const setup_bootstrap_responseSchema: { readonly 'x-tags': readonly ["setup.bootstrap_response"]; readonly type: "object"; readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ok_response"; }, { readonly properties: { readonly authWorkspaces: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly authWsId: { readonly type: "string"; readonly description: "Authentication work space Id"; readonly example: "efdf85b9-b4ff-4e2a-9006-566743fb8bc9"; }; readonly clientId: { readonly type: "string"; readonly description: "Client Id"; readonly example: "PPZ8CFWO7ENB5H9EQGMF"; }; }; }; }; }; }]; }; declare const DSGetResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ok_response"; }, { readonly properties: { readonly object: { readonly $ref: "#/components/schemas/DSObject"; }; }; }]; }; declare const DSObjectSchema: { readonly type: "object"; readonly properties: { readonly oid: { readonly type: "string"; }; readonly lastUpdated: { readonly type: "integer"; readonly format: "int64"; }; readonly lastUpdatedTime: { readonly type: "string"; }; readonly created: { readonly type: "integer"; readonly format: "int64"; }; readonly createdTime: { readonly type: "string"; }; readonly data: { readonly type: "object"; }; }; }; declare const DSStoreParamsSchema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; }; readonly type: { readonly type: "string"; }; readonly oid: { readonly type: "string"; }; readonly UID: { readonly type: "string"; }; readonly updateBehavior: { readonly type: "string"; readonly enum: readonly ["arrayPush", "arraySet", "replace"]; }; }; }; declare const DSStoreResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ok_response"; }, { readonly properties: { readonly oid: { readonly type: "string"; }; }; }]; }; declare const DSSearchResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ok_response"; }, { readonly type: "object"; readonly properties: { readonly objectsCount: { readonly type: "integer"; readonly format: "int32"; }; readonly totalCount: { readonly type: "integer"; readonly format: "int32"; }; readonly results: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/DSObject"; }; }; readonly nextCursorId: { readonly type: "string"; }; }; }]; }; declare const DSSearchParamsSchema: { readonly type: "object"; readonly properties: { readonly query: { readonly type: "string"; }; readonly openCursor: { readonly type: "boolean"; }; readonly cursorId: { readonly type: "boolean"; }; readonly timeout: { readonly type: "integer"; readonly format: "int32"; }; }; }; declare const SetDSSchemaRequestSchema: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; }; readonly dataSchema: { readonly $ref: "#/components/schemas/DataSchema"; }; }; }; declare const SetDSSchemaResponseSchema: { readonly type: "object"; readonly $ref: "#/components/schemas/ok_response"; }; declare const GetDSSchemaRequestSchema: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; }; readonly filter: { readonly type: "string"; readonly enum: readonly ["full", "clientOnly", "explicitOnly"]; }; }; }; declare const GetDSSchemaResponseSchema: { readonly properties: { readonly schema: { readonly $ref: "#/components/schemas/Schema"; }; }; }; declare const DataSchemaSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/Schema"; }, { readonly properties: { readonly dynamicSchema: { readonly type: "boolean"; }; }; }]; }; declare const SchemaSchema: { readonly example: { readonly rel2: { readonly type: "string"; readonly writeAccess: "serverOnly"; readonly required: false; }; readonly email_rel: { readonly type: "string"; readonly writeAccess: "serverOnly"; readonly required: false; readonly format: "([a-zA-Z0-9\\_\\-\\.]+)@([a-zA-Z]+).(.+)"; }; }; readonly type: "object"; readonly additionalProperties: { readonly $ref: "#/components/schemas/SchemaField"; }; }; declare const SchemaFieldSchema: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; readonly enum: readonly ["integer", "float", "boolean", "string", "date", "long", "text", "binary"]; }; readonly writeAccess: { readonly type: "string"; readonly enum: readonly ["serverOnly", "clientModify", "clientCreate"]; }; readonly required: { readonly type: "boolean"; }; readonly format: { readonly type: "string"; }; readonly encrypt: { readonly type: "string"; readonly enum: readonly ["aes"]; }; }; }; declare const ApiResponseSchema: { readonly type: "object"; readonly properties: { readonly callId: { readonly type: "string"; }; readonly errorCode: { readonly type: "integer"; }; readonly apiVersion: { readonly type: "integer"; }; readonly statusCode: { readonly type: "integer"; }; readonly statusReason: { readonly type: "string"; }; }; }; declare const RemoveMemberResponseSchema: { readonly $ref: "#/components/schemas/ApiResponse"; }; declare const GetGroupInfoResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly memberSince: { readonly type: "string"; readonly format: "date-time"; }; readonly lastUpdated: { readonly type: "string"; readonly format: "date-time"; }; readonly permissions: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }; }]; }; declare const GetGroupMemberInfoResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly result: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/MemberInfo"; }, { readonly $ref: "#/components/schemas/GroupId"; }]; }; }; }]; }; declare const GetAllMemberGroupsResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly allOf: readonly [{ readonly $ref: "#/components/schemas/GroupInfo"; }, { readonly $ref: "#/components/schemas/MemberInfo"; }]; }]; }; declare const CreateModelResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly modelId: { readonly type: "string"; }; }; }]; }; declare const DeleteModelResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; }; }; }]; }; declare const AllModelsResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly models: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly model: { readonly type: "string"; }; readonly selfProvisioning: { readonly type: "boolean"; }; }; }; }; }; }]; }; declare const DeleteSchemaFieldResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; }; }; }]; }; declare const GetGroupSchemaResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly model: { readonly type: "string"; }; readonly groupDataSchema: { readonly type: "object"; readonly $ref: "#/components/schemas/GroupSchema"; }; readonly relationshipDataSchema: { readonly type: "object"; readonly $ref: "#/components/schemas/GroupSchema"; }; }; }]; }; declare const SetGroupSchemaResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; }]; }; declare const DeleteGroupResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly deleted: { readonly type: "boolean"; }; }; }]; }; declare const AllMemberGroupsResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly groups: { readonly type: "array"; readonly items: { readonly type: "object"; }; }; }; }]; }; declare const GroupInfoResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly groupInfo: { readonly type: "object"; }; }; }]; }; declare const RegisterGroupResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly groupId: { readonly type: "string"; }; }; }]; }; declare const SetGroupInfoResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly updated: { readonly type: "boolean"; }; }; }]; }; declare const GetGroupSchemaRequestSchema: { readonly type: "object"; readonly properties: { readonly model: { readonly type: "string"; readonly description: "The group's type model. The model must be registered in the system.\n"; }; }; }; declare const CreateModelRequestSchema: { readonly type: "object"; readonly properties: { readonly model: { readonly type: "string"; readonly description: "The name of the model.\n"; }; readonly selfProvisioning: { readonly type: "boolean"; readonly description: "If true, the client will be able to create a group using the createGroup call,\n"; }; }; }; declare const SetGroupMemberInfoResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; }]; }; declare const CreateInvitationResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly invitationLink: { readonly type: "string"; readonly format: "uri"; }; }; }]; }; declare const FinalizeInvitationResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; }]; }; declare const SetSiteConfigResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; }]; }; declare const GetGroupInfoRequestSchema: { readonly type: "object"; readonly properties: { readonly results: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/MemberInfo"; }; }; }; }; declare const GetGroupMemberInfoRequestSchema: { readonly type: "object"; readonly properties: { readonly groupId: { readonly type: "string"; }; readonly model: { readonly type: "string"; }; readonly include: { readonly type: "string"; readonly description: "Only accepts the profile parameter.\n"; readonly enum: readonly ["profile"]; }; }; }; declare const GetAllMemberGroupsRequestSchema: { readonly type: "object"; }; declare const DeleteModelRequestSchema: { readonly type: "object"; readonly properties: { readonly modelId: { readonly type: "string"; }; }; }; declare const RegisterGroupRequestSchema: { readonly type: "object"; readonly properties: { readonly groupName: { readonly type: "string"; }; readonly groupDescription: { readonly type: "string"; }; }; }; declare const SetGroupInfoRequestSchema: { readonly type: "object"; readonly properties: { readonly model: { readonly type: "string"; readonly description: "The group's type model. The model must be registered in the system.\n"; }; readonly groupId: { readonly type: "string"; }; readonly groupData: { readonly $ref: "#/components/schemas/GroupData"; }; }; }; declare const AssignGroupMemberRequestSchema: { readonly type: "object"; readonly properties: { readonly groupId: { readonly type: "string"; }; readonly UID: { readonly type: "string"; }; }; }; declare const AssignGroupMemberResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; }]; }; declare const DeleteSchemaFieldRequestSchema: { readonly type: "object"; readonly properties: { readonly model: { readonly type: "string"; readonly description: "The group's type model. The model must be registered in the system.\n"; }; readonly groupDataSchemaFieldName: { readonly type: "string"; readonly description: "This is the field name of the data schema for the group.\nSetGroupMemberInfoRequest\n"; }; readonly relationshipDataSchemaFieldName: { readonly type: "string"; readonly description: "This is the field name of the data schema for the relationship data.\nSetGroupMemberInfoRequest\n"; }; }; }; declare const SetGroupMemberInfoRequestSchema: { readonly type: "object"; readonly allOf: readonly [{ readonly $ref: "#/components/schemas/MemberInfo"; }, { readonly $ref: "#/components/schemas/GroupId"; }]; }; declare const RemoveMemberRequestSchema: { readonly $ref: "#/components/schemas/GroupId"; }; declare const CreateInvitationRequestSchema: { readonly type: "object"; readonly properties: { readonly model: { readonly type: "string"; }; readonly groupId: { readonly type: "string"; }; }; }; declare const InvitationConfirmRequestSchema: { readonly type: "object"; readonly properties: { readonly invitationId: { readonly type: "string"; }; readonly confirmationCode: { readonly type: "string"; }; }; }; declare const InvitationConfirmResponseSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/ApiResponse"; }, { readonly type: "object"; readonly properties: { readonly confirmed: { readonly type: "boolean"; }; }; }]; }; declare const FinalizeInvitationRequestSchema: { readonly type: "object"; readonly properties: { readonly invitationId: { readonly type: "string"; }; readonly finalCode: { readonly type: "string"; }; }; }; declare const SetSiteConfigRequestSchema: { readonly type: "object"; readonly properties: { readonly configKey: { readonly type: "string"; }; readonly configValue: { readonly type: "string"; }; }; }; declare const SetGroupSchemaRequestSchema: { readonly type: "object"; readonly properties: { readonly model: { readonly type: "string"; readonly description: "The group's type model. The model must be registered in the system.\n"; }; readonly groupDataSchema: { readonly $ref: "#/components/schemas/GroupSchema"; }; readonly relationshipDataSchema: { readonly $ref: "#/components/schemas/GroupSchema"; }; }; }; declare const GroupIdSchema: { readonly properties: { readonly groupId: { readonly type: "string"; readonly description: "The group's unique identifier.\n"; }; readonly model: { readonly description: "The group's type model.\n"; }; }; }; declare const GroupInfoSchema: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/GroupId"; }, { readonly properties: { readonly groupData: { readonly $ref: "#/components/schemas/GroupData"; }; }; }]; }; declare const GroupDataSchema: { readonly type: "object"; readonly description: "The group's data based on the group data schema for the defined group.\n"; readonly example: { readonly BPID: "poc_bpid1"; readonly source: "IMPORT"; readonly country: "Israel"; }; }; declare const MemberInfoSchema: { readonly type: "object"; readonly properties: { readonly UID: { readonly type: "string"; }; readonly memberSince: { readonly type: "string"; readonly format: "date-time"; readonly readOnly: true; }; readonly lastUpdated: { readonly type: "string"; readonly format: "date-time"; readonly readOnly: true; }; readonly memberSinceTimestamp: { readonly type: "integer"; readonly format: "int64"; readonly readOnly: true; }; readonly lastUpdatedTimestamp: { readonly type: "integer"; readonly format: "int64"; readonly readOnly: true; }; readonly permissions: { readonly $ref: "#/components/schemas/Permissions"; }; readonly relationshipData: { readonly $ref: "#/components/schemas/RelationshipData"; }; }; }; declare const PermissionsSchema: { readonly description: "This parameter supports a comma-separated list of group permissions for members. Permission Values include: groupRead, groupWrite, groupDelete, relationshipRead, relationshipWrite, membersInvite, membersRemove, setPermissions) In case the setPermissions is provided - by default the relationshipRead and relationshipWrite permissions will be added if they are not provided.\n"; readonly type: "string"; readonly pattern: "^(groupRead|groupWrite|groupDelete|relationshipRead|relationshipWrite|membersInvite|membersRemove|setPermissions)(,(groupRead|groupWrite|groupDelete|relationshipRead|relationshipWrite|membersInvite|membersRemove|setPermissions))*$"; readonly example: "groupRead,groupWrite,groupDelete,relationshipRead,relationshipWrite,membersInvite"; }; declare const RelationshipDataSchema: { readonly type: "object"; readonly description: "The user's relationship data based on the relationship data schema for the defined group.\n"; readonly example: { readonly field1: "value1"; readonly field2: "value2"; }; }; declare const GroupSchemaSchema: { readonly example: { readonly rel2: { readonly type: "string"; readonly writeAccess: "serverOnly"; readonly required: false; }; readonly email_rel: { readonly type: "string"; readonly writeAccess: "serverOnly"; readonly required: false; readonly format: "([a-zA-Z0-9\\_\\-\\.]+)@([a-zA-Z]+).(.+)"; }; }; readonly type: "object"; readonly additionalProperties: { readonly $ref: "#/components/schemas/DataSchemaField"; }; }; declare const DataSchemaFieldSchema: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; readonly enum: readonly ["string", "integer", "number", "boolean", "array", "object"]; }; readonly writeAccess: { readonly type: "string"; readonly enum: readonly ["serverOnly", "clientModify"]; }; readonly required: { readonly type: "boolean"; }; readonly format: { readonly type: "string"; }; }; }; declare const ActivityBlueprintModelSchema: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; readonly displayName: { readonly type: "string"; }; readonly description: { readonly type: "string"; }; readonly type: { readonly type: "string"; }; readonly parentId: { readonly type: "string"; }; readonly persistWorkflow: { readonly type: "boolean"; }; readonly loadWorkflowContext: { readonly type: "boolean"; }; readonly saveWorkflowContext: { readonly type: "boolean"; }; readonly inputProperties: { readonly $ref: "#/components/schemas/Variables"; }; readonly outputProperties: { readonly $ref: "#/components/schemas/Variables"; }; }; readonly additionalProperties: false; }; declare const ActivityDefinitionSchema: { readonly type: "object"; readonly properties: { readonly activityId: { readonly type: "string"; }; readonly type: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; readonly displayName: { readonly type: "string"; }; readonly description: { readonly type: "string"; }; readonly persistWorkflow: { readonly type: "boolean"; }; readonly loadWorkflowContext: { readonly type: "boolean"; }; readonly saveWorkflowContext: { readonly type: "boolean"; }; readonly properties: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/ActivityDefinitionProperty"; }; }; readonly propertyStorageProviders: { readonly type: "object"; readonly additionalProperties: { readonly type: "string"; }; readonly readOnly: true; }; }; readonly additionalProperties: false; }; declare const ActivityDefinitionPropertySchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; }; readonly syntax: { readonly type: "string"; }; readonly expressions: { readonly type: "object"; readonly additionalProperties: { readonly type: "string"; }; }; }; readonly additionalProperties: false; }; declare const ActivityDescriptorSchema: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; }; readonly displayName: { readonly type: "string"; }; readonly description: { readonly type: "string"; }; readonly category: { readonly type: "string"; }; readonly traits: { readonly $ref: "#/components/schemas/ActivityTraits"; }; readonly outcomes: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly properties: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/ActivityInputDescriptor"; }; readonly deprecated: true; }; readonly inputProperties: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/ActivityInputDescriptor"; }; }; readonly outputProperties: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/ActivityOutputDescriptor"; }; }; }; readonly additionalProperties: false; }; declare const ActivityInputDescriptorSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly example: "System.String, mscorlib"; }; readonly uiHint: { readonly type: "string"; }; readonly label: { readonly type: "string"; }; readonly hint: { readonly type: "string"; }; readonly options: { readonly type: "object"; readonly additionalProperties: {}; }; readonly category: { readonly type: "string"; }; readonly order: { readonly type: "number"; readonly format: "float"; }; readonly defaultValue: { readonly $ref: "#/components/schemas/Input"; }; readonly defaultSyntax: { readonly type: "string"; }; readonly supportedSyntaxes: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly isReadOnly: { readonly type: "boolean"; }; readonly isBrowsable: { readonly type: "boolean"; }; readonly isDesignerCritical: { readonly type: "boolean"; }; readonly defaultWorkflowStorageProvider: { readonly type: "string"; }; readonly disableWorkflowProviderSelection: { readonly type: "boolean"; }; }; readonly additionalProperties: false; }; declare const ActivityOutputDescriptorSchema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly example: "System.String, mscorlib"; }; readonly hint: { readonly type: "string"; }; readonly defaultWorkflowStorageProvider: { readonly type: "string"; }; readonly disableWorkflowProviderSelection: { readonly type: "boolean"; }; }; readonly additionalProperties: false; }; declare const ActivityScopeSchema: { readonly type: "object"; readonly properties: { readonly activityId: { readonly type: "string"; }; readonly variables: { readonly $ref: "#/components/schemas/Variables"; }; }; readonly additionalProperties: false; }; declare const ActivityTraitsSchema: { readonly enum: readonly [1, 2, 4]; readonly type: "integer"; readonly format: "int32"; }; declare const BlockingActivitySchema: { readonly type: "object"; readonly properties: { readonly activityId: { readonly type: "string"; }; readonly activityType: { readonly type: "string"; }; readonly tag: { readonly type: "string"; }; }; readonly additionalProperties: false; }; declare const BulkCancelWorkflowsRequestSchema: { readonly type: "object"; readonly properties: { readonly workflowInstanceIds: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }; readonly additionalProperties: false; }; declare const BulkDeleteWorkflowsRequestSchema: { readonly type: "object"; readonly properties: { readonly workflowInstanceIds: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }; readonly additionalProperties: false; }; declare const BulkRetryWorkflowsRequestSchema: { readonly type: "object"; readonly properties: { readonly workflowInstanceIds: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }; readonly additionalProperties: false; }; declare const ConnectionDefinitionSchema: { readonly type: "object"; readonly properties: { readonly sourceActivityId: { readonly type: "string"; }; readonly targetActivityId: { readonly type: "string"; }; readonly outcome: { readonly type: "string"; }; }; readonly additionalProperties: false; }; declare const ConnectionModelSchema: { readonly type: "object"; readonly properties: { readonly sourceActivityId: { readonly type: "string"; }; readonly targetActivityId: { readonly type: "string"; }; readonly outcome: { readonly type: "string"; }; }; readonly additionalProperties: false; }; declare const InstantSchema: { readonly type: "object"; readonly additionalProperties: false; }; declare const IOutputFormatterSchema: { readonly type: "object"; readonly additionalProperties: false; }; declare const JTokenSchema: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/JToken"; }; }; declare const OkObjectResultSchema: { readonly type: "object"; readonly properties: { readonly value: { readonly $ref: "#/components/schemas/Input"; }; readonly formatters: { readonly type: "array"; readonly items: { readonly $ref: "#/c