@salesforce/lds-adapters-industries-identityverification 0.1.0-dev1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +82 -0
- package/dist/es/es2018/industries-identityverification.js +2882 -0
- package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
- package/dist/es/es2018/types/src/generated/adapters/buildVerificationContext.d.ts +17 -0
- package/dist/es/es2018/types/src/generated/adapters/createFormVerification.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/identityVerification.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/adapters/searchRecords.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +4 -0
- package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +5 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectIndustriesVideoCallParticipant.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectTimelineMetadataConfigurations.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getConnectTimelineTimelineDefinitionsEventsByTimelineConfigFullNameAndTimelineObjRecordId.d.ts +23 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectIdentityVerificationBuildContextByProcessDefinitionName.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectIdentityVerificationInputVerification.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectIdentityVerificationSearch.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postConnectIdentityVerificationVerification.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/putConnectIndustriesVideoCall.d.ts +10 -0
- package/dist/es/es2018/types/src/generated/resources/putConnectIndustriesVideoCallLeaveCall.d.ts +10 -0
- package/dist/es/es2018/types/src/generated/resources/putConnectIndustriesVideoCallParticipant.d.ts +10 -0
- package/dist/es/es2018/types/src/generated/types/BuildVerificationContextInputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/BuildVerificationContextWrapperInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ChimeAttendeeResultRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/ChimeMediaPlacementResultRepresentation.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/ChimeMeetingResultRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/DocumentManagementInputRepresentation.d.ts +41 -0
- package/dist/es/es2018/types/src/generated/types/DocumentManagementResultRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/ErrorResponseRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/EvaluateVideoCallParticipantInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/EvaluateVideoCallParticipantResultRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/FieldValueInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/FieldValueListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/FieldValueOutputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/FormVerificationDisplayRecordDetailsOutput.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/FormVerificationFieldInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/FormVerificationFieldListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/FormVerificationFieldListRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/FormVerificationFieldRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/FormVerificationInputRepresentation.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/FormVerificationRepresentation.d.ts +59 -0
- package/dist/es/es2018/types/src/generated/types/FormVerificationWrapperInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/JoinVideoCallInputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/JoinVideoCallResultRepresentation.d.ts +39 -0
- package/dist/es/es2018/types/src/generated/types/LeaveVideoCallInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/LeaveVideoCallResultRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/LinkedObjectFieldsMapInputRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/NotifyAccessResultRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/PageSpecification.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/PageSpecificationListInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/ProcessDefinitionInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ProcessDefinitionOutputRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/ProcessDetailInputRepresentation.d.ts +70 -0
- package/dist/es/es2018/types/src/generated/types/ProcessDetailListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/ProcessDetailOutputRepresentation.d.ts +70 -0
- package/dist/es/es2018/types/src/generated/types/SearchFieldRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/SearchFilterInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/SearchFilterListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/SearchInputRepresentation.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/SearchOutputRepresentation.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/SearchResultHeaderRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/SearchResultRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/SearchWrapperInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/SelectedSearchResultInputRepresentation.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/SelectedSearchResultOutputRepresentation.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/SelectedVerifiedResultInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/SelectedVerifiedResultOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/SetupCallInputRepresentation.d.ts +38 -0
- package/dist/es/es2018/types/src/generated/types/SetupCallResultRepresentation.d.ts +38 -0
- package/dist/es/es2018/types/src/generated/types/TimelineDataGetResultRepresentation.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/TimelineElementRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/TimelineEntityRepresentation.d.ts +43 -0
- package/dist/es/es2018/types/src/generated/types/TimelineErrorRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/TimelineEventFieldRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/TimelineEventRepresentation.d.ts +44 -0
- package/dist/es/es2018/types/src/generated/types/TimelineEventTypeMetadataRepresentation.d.ts +53 -0
- package/dist/es/es2018/types/src/generated/types/TimelineEventTypeRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/TimelineMetadataDefinitionRepresentation.d.ts +42 -0
- package/dist/es/es2018/types/src/generated/types/TimelineMetadataResultRepresentation.d.ts +36 -0
- package/dist/es/es2018/types/src/generated/types/UpdateVideoCallInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/UpdateVideoCallResultRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/ValidateSignatureInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/ValidateSignatureResultRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/VerificationContextInputRepresentation.d.ts +40 -0
- package/dist/es/es2018/types/src/generated/types/VerificationContextOutputRepresentation.d.ts +56 -0
- package/dist/es/es2018/types/src/generated/types/VerificationContextWrapperInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/VerificationProcessFieldInputRepresentation.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/VerificationProcessFieldListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/VerificationProcessFieldListOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/VerificationProcessFieldOutputRepresentation.d.ts +49 -0
- package/dist/es/es2018/types/src/generated/types/VerifiedDetailsInputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/VerifiedDetailsListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/VerifiedDetailsOutputRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/VerifiedResultInputRepresentation.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/types/VerifiedResultOutputRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/VerifierInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/VerifierListInputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/VerifierOutputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/VideoCallParticipantFieldRepresentation.d.ts +37 -0
- package/dist/es/es2018/types/src/generated/types/VideoCallParticipantRepresentation.d.ts +35 -0
- package/dist/es/es2018/types/src/generated/types/VideoCallParticipantResultRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
- package/package.json +70 -0
- package/sfdc/index.d.ts +1 -0
- package/sfdc/index.js +2917 -0
- package/src/raml/api.raml +1481 -0
- package/src/raml/luvio.raml +42 -0
|
@@ -0,0 +1,1481 @@
|
|
|
1
|
+
#%RAML 1.0
|
|
2
|
+
securedBy:
|
|
3
|
+
- OAuth2
|
|
4
|
+
title: Salesforce Connect API
|
|
5
|
+
version: '57.0'
|
|
6
|
+
mediaType: application/json
|
|
7
|
+
protocols:
|
|
8
|
+
- https
|
|
9
|
+
baseUri: /services/data/v66.0
|
|
10
|
+
securitySchemes:
|
|
11
|
+
OAuth2:
|
|
12
|
+
type: OAuth 2.0
|
|
13
|
+
settings:
|
|
14
|
+
authorizationUri: https://example.com/oauth/authorize
|
|
15
|
+
accessTokenUri: ''
|
|
16
|
+
authorizationGrants:
|
|
17
|
+
- implicit
|
|
18
|
+
annotationTypes:
|
|
19
|
+
oas-readOnly:
|
|
20
|
+
type: boolean
|
|
21
|
+
allowedTargets: TypeDeclaration
|
|
22
|
+
oas-collectionFormat:
|
|
23
|
+
type: string
|
|
24
|
+
oas-body-name:
|
|
25
|
+
type: string
|
|
26
|
+
allowedTargets: TypeDeclaration
|
|
27
|
+
types:
|
|
28
|
+
BuildVerificationContextInputRepresentation:
|
|
29
|
+
description: Input representation for building verification context
|
|
30
|
+
type: object
|
|
31
|
+
properties:
|
|
32
|
+
objectName:
|
|
33
|
+
description: Object Name
|
|
34
|
+
type: string
|
|
35
|
+
processDetailName:
|
|
36
|
+
description: Process Detail Name
|
|
37
|
+
type: string
|
|
38
|
+
selectedRecordId:
|
|
39
|
+
description: Selected Record Id
|
|
40
|
+
type: string
|
|
41
|
+
selectedVerifiedResult:
|
|
42
|
+
description: Selected Verified Result
|
|
43
|
+
# TODO hand rolled. W-10727777
|
|
44
|
+
type: SelectedVerifiedResultInputRepresentation
|
|
45
|
+
# TODO hand rolled. W-10727777 added the following wrapper manually
|
|
46
|
+
BuildVerificationContextWrapperInputRepresentation:
|
|
47
|
+
description: wrapper of BuildVerificationContextInputRepresentation
|
|
48
|
+
type: object
|
|
49
|
+
properties:
|
|
50
|
+
BuildContextData:
|
|
51
|
+
description: Input representation for BuildVerificationContextInputRepresentation
|
|
52
|
+
type: BuildVerificationContextInputRepresentation
|
|
53
|
+
ChimeAttendeeResultRepresentation:
|
|
54
|
+
description: Output representation of Chime Attendee
|
|
55
|
+
type: object
|
|
56
|
+
properties:
|
|
57
|
+
attendeeId:
|
|
58
|
+
description: Chime AttendeeId
|
|
59
|
+
type: string
|
|
60
|
+
required: false
|
|
61
|
+
externalAttendeeId:
|
|
62
|
+
description: Chime ExternalAttendeeId
|
|
63
|
+
type: string
|
|
64
|
+
required: false
|
|
65
|
+
joinToken:
|
|
66
|
+
description: Chime Attendee join token
|
|
67
|
+
type: string
|
|
68
|
+
required: false
|
|
69
|
+
ChimeMediaPlacementResultRepresentation:
|
|
70
|
+
description: Output representation of Chime Media Placement Result
|
|
71
|
+
type: object
|
|
72
|
+
properties:
|
|
73
|
+
audioFallbackUrl:
|
|
74
|
+
description: ChimeMediaPlacement AudioFallbackUrl
|
|
75
|
+
type: string
|
|
76
|
+
required: false
|
|
77
|
+
audioHostUrl:
|
|
78
|
+
description: ChimeMediaPlacement AudioHostUrl
|
|
79
|
+
type: string
|
|
80
|
+
required: false
|
|
81
|
+
eventIngestionUrl:
|
|
82
|
+
description: ChimeMediaPlacement EventIngestionUrl
|
|
83
|
+
type: string
|
|
84
|
+
required: false
|
|
85
|
+
screenDataUrl:
|
|
86
|
+
description: ChimeMediaPlacement ScreenDataUrl
|
|
87
|
+
type: string
|
|
88
|
+
required: false
|
|
89
|
+
screenSharingUrl:
|
|
90
|
+
description: ChimeMediaPlacement ScreenSharingUrl
|
|
91
|
+
type: string
|
|
92
|
+
required: false
|
|
93
|
+
screenViewingUrl:
|
|
94
|
+
description: ChimeMediaPlacement ScreenViewingUrl
|
|
95
|
+
type: string
|
|
96
|
+
required: false
|
|
97
|
+
signalingUrl:
|
|
98
|
+
description: ChimeMediaPlacement SignalingUrl
|
|
99
|
+
type: string
|
|
100
|
+
required: false
|
|
101
|
+
turnControlUrl:
|
|
102
|
+
description: ChimeMediaPlacement TurnControlUrl
|
|
103
|
+
type: string
|
|
104
|
+
required: false
|
|
105
|
+
ChimeMeetingResultRepresentation:
|
|
106
|
+
description: Output representation of Chime Meeting
|
|
107
|
+
type: object
|
|
108
|
+
properties:
|
|
109
|
+
mediaPlacement:
|
|
110
|
+
description: MediaPlacementUrls of chime meeting
|
|
111
|
+
type: ChimeMediaPlacementResultRepresentation
|
|
112
|
+
required: false
|
|
113
|
+
meetingId:
|
|
114
|
+
description: Chime MeetingId
|
|
115
|
+
type: string
|
|
116
|
+
required: false
|
|
117
|
+
DocumentManagementInputRepresentation:
|
|
118
|
+
description: Input representation for DocumentManagement
|
|
119
|
+
type: object
|
|
120
|
+
properties:
|
|
121
|
+
isOcrRequested:
|
|
122
|
+
description: Is Ocr Requested
|
|
123
|
+
type: boolean
|
|
124
|
+
linkedObjectFieldsMap:
|
|
125
|
+
description: Set Linked Object Fields Map
|
|
126
|
+
type: object
|
|
127
|
+
properties:
|
|
128
|
+
//:
|
|
129
|
+
type: string
|
|
130
|
+
pageSpecificationList:
|
|
131
|
+
description: Set Page Specification List
|
|
132
|
+
type: array
|
|
133
|
+
items:
|
|
134
|
+
type: object
|
|
135
|
+
targetFileName:
|
|
136
|
+
description: Set Target File Name
|
|
137
|
+
type: string
|
|
138
|
+
DocumentManagementResultRepresentation:
|
|
139
|
+
description: Output representation of Document Management Output Result
|
|
140
|
+
type: object
|
|
141
|
+
properties:
|
|
142
|
+
contentDocumentId:
|
|
143
|
+
description: Content Document Id
|
|
144
|
+
type: string
|
|
145
|
+
error:
|
|
146
|
+
description: Error representation for a Document Management
|
|
147
|
+
type: ErrorResponseRepresentation
|
|
148
|
+
isSuccess:
|
|
149
|
+
description: Document Management success flag
|
|
150
|
+
type: boolean
|
|
151
|
+
ErrorResponseRepresentation:
|
|
152
|
+
description: Error response representation
|
|
153
|
+
type: object
|
|
154
|
+
properties:
|
|
155
|
+
code:
|
|
156
|
+
description: Code for Error
|
|
157
|
+
type: string
|
|
158
|
+
message:
|
|
159
|
+
description: Message stating the reason for error, if any
|
|
160
|
+
type: string
|
|
161
|
+
EvaluateVideoCallParticipantInputRepresentation:
|
|
162
|
+
description: Input representation for VideoCall EvaluateCaller
|
|
163
|
+
type: object
|
|
164
|
+
properties:
|
|
165
|
+
isAccepted:
|
|
166
|
+
description: Set whether caller is accepted for Video Call
|
|
167
|
+
type: boolean
|
|
168
|
+
participantId:
|
|
169
|
+
description: Set Participant Id for Video Caller Evaluation
|
|
170
|
+
type: string
|
|
171
|
+
EvaluateVideoCallParticipantResultRepresentation:
|
|
172
|
+
description: Output representation of EvaluateCallerVideoCall Result
|
|
173
|
+
type: object
|
|
174
|
+
properties:
|
|
175
|
+
errorMessage:
|
|
176
|
+
description: EvaluateCallerVideoCall error messages
|
|
177
|
+
type: string
|
|
178
|
+
required: false
|
|
179
|
+
isSuccess:
|
|
180
|
+
description: EvaluateCallerVideoCall success flag
|
|
181
|
+
type: boolean
|
|
182
|
+
FieldValueInputRepresentation:
|
|
183
|
+
description: Input representation for each field
|
|
184
|
+
type: object
|
|
185
|
+
properties:
|
|
186
|
+
developerName:
|
|
187
|
+
description: Developer Name
|
|
188
|
+
type: string
|
|
189
|
+
value:
|
|
190
|
+
description: Value
|
|
191
|
+
type: string
|
|
192
|
+
FieldValueListInputRepresentation:
|
|
193
|
+
description: Input representation for Selected Search Result List
|
|
194
|
+
type: object
|
|
195
|
+
properties:
|
|
196
|
+
selectedRecordObjectList:
|
|
197
|
+
description: Selected Record Object List
|
|
198
|
+
type: array
|
|
199
|
+
items:
|
|
200
|
+
# TODO hand rolled. W-10727777
|
|
201
|
+
type: FieldValueInputRepresentation
|
|
202
|
+
FieldValueOutputRepresentation:
|
|
203
|
+
description: Representation of a field value
|
|
204
|
+
type: object
|
|
205
|
+
properties:
|
|
206
|
+
developerName:
|
|
207
|
+
description: Developer Name
|
|
208
|
+
type: string
|
|
209
|
+
value:
|
|
210
|
+
description: Value
|
|
211
|
+
type: string
|
|
212
|
+
FormVerificationDisplayRecordDetailsOutput:
|
|
213
|
+
description: Details of Display record of selected record id
|
|
214
|
+
type: object
|
|
215
|
+
properties:
|
|
216
|
+
displayRecordId:
|
|
217
|
+
description: Display Record Id
|
|
218
|
+
type: string
|
|
219
|
+
displayRecordName:
|
|
220
|
+
description: Display Record Name
|
|
221
|
+
type: string
|
|
222
|
+
FormVerificationFieldInputRepresentation:
|
|
223
|
+
description: Input representation for each verification field used in form verification
|
|
224
|
+
type: object
|
|
225
|
+
properties:
|
|
226
|
+
developerName:
|
|
227
|
+
description: Developer Name
|
|
228
|
+
type: string
|
|
229
|
+
isVerified:
|
|
230
|
+
description: Verified flag to set for non-form based input
|
|
231
|
+
type: boolean
|
|
232
|
+
# TODO hand rolled. W-12571153
|
|
233
|
+
required: false
|
|
234
|
+
value:
|
|
235
|
+
description: Input value of the field
|
|
236
|
+
type: string
|
|
237
|
+
FormVerificationFieldListInputRepresentation:
|
|
238
|
+
description: Input representation for list of verification fields with values
|
|
239
|
+
type: object
|
|
240
|
+
properties:
|
|
241
|
+
formVerificationFields:
|
|
242
|
+
description: Form Input Verification field List
|
|
243
|
+
type: array
|
|
244
|
+
items:
|
|
245
|
+
# TODO hand rolled. W-12571153
|
|
246
|
+
type: FormVerificationFieldInputRepresentation
|
|
247
|
+
FormVerificationInputRepresentation:
|
|
248
|
+
description: Input representation for form verification
|
|
249
|
+
type: object
|
|
250
|
+
properties:
|
|
251
|
+
developerName:
|
|
252
|
+
description: Selected developer name of identity verification process detail
|
|
253
|
+
type: string
|
|
254
|
+
formVerificationFieldList:
|
|
255
|
+
description: Input values of the fields which are up for validations
|
|
256
|
+
# TODO hand rolled. W-12571153
|
|
257
|
+
type: FormVerificationFieldListInputRepresentation
|
|
258
|
+
selectedRecordId:
|
|
259
|
+
description: Selected Record Id
|
|
260
|
+
type: string
|
|
261
|
+
FormVerificationWrapperInputRepresentation:
|
|
262
|
+
description: wrapper of FormVerificationInputRepresentation
|
|
263
|
+
type: object
|
|
264
|
+
properties:
|
|
265
|
+
IdentityVerificationFormInputData:
|
|
266
|
+
description: Input representation for verification of input values
|
|
267
|
+
type: FormVerificationInputRepresentation
|
|
268
|
+
FormVerificationFieldListRepresentation:
|
|
269
|
+
description: List of Form Verification Fields
|
|
270
|
+
type: object
|
|
271
|
+
properties:
|
|
272
|
+
formVerificationFields:
|
|
273
|
+
description: Form Verification Fields
|
|
274
|
+
type: array
|
|
275
|
+
items:
|
|
276
|
+
type: FormVerificationFieldRepresentation
|
|
277
|
+
FormVerificationFieldRepresentation:
|
|
278
|
+
description: Representation of Form Verification results
|
|
279
|
+
type: object
|
|
280
|
+
properties:
|
|
281
|
+
developerName:
|
|
282
|
+
description: Developer Name
|
|
283
|
+
type: string
|
|
284
|
+
isVerified:
|
|
285
|
+
description: Is the field verified
|
|
286
|
+
type: boolean
|
|
287
|
+
value:
|
|
288
|
+
description: Value
|
|
289
|
+
type: string
|
|
290
|
+
FormVerificationRepresentation:
|
|
291
|
+
description: Representation of Form Verification Fields
|
|
292
|
+
type: object
|
|
293
|
+
properties:
|
|
294
|
+
developerName:
|
|
295
|
+
description: Developer name of IDV record
|
|
296
|
+
type: string
|
|
297
|
+
displayRecordDetails:
|
|
298
|
+
description: Parent record id in case redirection needs to be to parent post
|
|
299
|
+
verification
|
|
300
|
+
type: FormVerificationDisplayRecordDetailsOutput
|
|
301
|
+
required: false
|
|
302
|
+
formVerificationFieldList:
|
|
303
|
+
description: Field verification results
|
|
304
|
+
type: FormVerificationFieldListRepresentation
|
|
305
|
+
isVerified:
|
|
306
|
+
description: Flag to get the overall verification status
|
|
307
|
+
type: boolean
|
|
308
|
+
retryCount:
|
|
309
|
+
description: Retry count in case of failed attempt
|
|
310
|
+
type: integer
|
|
311
|
+
required: false
|
|
312
|
+
selectedRecordId:
|
|
313
|
+
description: Id of the selected record
|
|
314
|
+
type: string
|
|
315
|
+
status:
|
|
316
|
+
description: Field verification results status
|
|
317
|
+
type: ErrorResponseRepresentation
|
|
318
|
+
JoinVideoCallInputRepresentation:
|
|
319
|
+
description: Input representation for JoinVideoCall
|
|
320
|
+
type: object
|
|
321
|
+
properties:
|
|
322
|
+
enableTranscription:
|
|
323
|
+
description: enable transcription
|
|
324
|
+
type: boolean
|
|
325
|
+
externalMeetingId:
|
|
326
|
+
description: Set External Meeting Id for Video Call
|
|
327
|
+
type: string
|
|
328
|
+
region:
|
|
329
|
+
description: Set Region for Video Call
|
|
330
|
+
type: string
|
|
331
|
+
transcriptionType:
|
|
332
|
+
description: Set transcriptionType
|
|
333
|
+
type: string
|
|
334
|
+
JoinVideoCallResultRepresentation:
|
|
335
|
+
description: Output representation of JoinVideoCall Result
|
|
336
|
+
type: object
|
|
337
|
+
properties:
|
|
338
|
+
attendee:
|
|
339
|
+
description: JoinVideoCall API attendee information
|
|
340
|
+
type: ChimeAttendeeResultRepresentation
|
|
341
|
+
required: false
|
|
342
|
+
errorMessage:
|
|
343
|
+
description: JoinVideoCall error messages
|
|
344
|
+
type: string
|
|
345
|
+
required: false
|
|
346
|
+
isSuccess:
|
|
347
|
+
description: JoinVideoCall success flag
|
|
348
|
+
type: boolean
|
|
349
|
+
meeting:
|
|
350
|
+
description: JoinVideoCall API meeting information
|
|
351
|
+
type: ChimeMeetingResultRepresentation
|
|
352
|
+
required: false
|
|
353
|
+
LeaveVideoCallInputRepresentation:
|
|
354
|
+
description: Input representation for LeaveVideoCall
|
|
355
|
+
type: object
|
|
356
|
+
properties:
|
|
357
|
+
attendeeId:
|
|
358
|
+
description: Set Attendee for Video Call
|
|
359
|
+
type: string
|
|
360
|
+
externalMeetingId:
|
|
361
|
+
description: Set External Meeting Id for Video Call
|
|
362
|
+
type: string
|
|
363
|
+
LeaveVideoCallResultRepresentation:
|
|
364
|
+
description: Output representation of LeaveVideoCall Result
|
|
365
|
+
type: object
|
|
366
|
+
properties:
|
|
367
|
+
errorMessage:
|
|
368
|
+
description: LeaveVideoCall error messages
|
|
369
|
+
type: string
|
|
370
|
+
required: false
|
|
371
|
+
isSuccess:
|
|
372
|
+
description: LeaveVideoCall success flag
|
|
373
|
+
type: boolean
|
|
374
|
+
LinkedObjectFieldsMapInputRepresentation:
|
|
375
|
+
description: Input representation for Map of LinkedObjectFields
|
|
376
|
+
type: object
|
|
377
|
+
properties:
|
|
378
|
+
linkedObjectFields:
|
|
379
|
+
description: Set Linked Object Fields.
|
|
380
|
+
type: object
|
|
381
|
+
properties:
|
|
382
|
+
//:
|
|
383
|
+
type: string
|
|
384
|
+
NotifyAccessResultRepresentation:
|
|
385
|
+
description: Output representation of Notify Access
|
|
386
|
+
type: object
|
|
387
|
+
properties:
|
|
388
|
+
accessKey:
|
|
389
|
+
description: Notify Access Key
|
|
390
|
+
type: string
|
|
391
|
+
required: false
|
|
392
|
+
endpoint:
|
|
393
|
+
description: Notify Access Endpoint
|
|
394
|
+
type: string
|
|
395
|
+
required: false
|
|
396
|
+
externalUserId:
|
|
397
|
+
description: Notify Access External User Id
|
|
398
|
+
type: string
|
|
399
|
+
required: false
|
|
400
|
+
keyId:
|
|
401
|
+
description: Notify Access Key Id
|
|
402
|
+
type: string
|
|
403
|
+
required: false
|
|
404
|
+
PageSpecification:
|
|
405
|
+
description: Input representation for PageSpecification
|
|
406
|
+
type: object
|
|
407
|
+
properties:
|
|
408
|
+
addToTargetFile:
|
|
409
|
+
description: set true for split and add to target file
|
|
410
|
+
type: boolean
|
|
411
|
+
page:
|
|
412
|
+
description: set page index, index starts from 1
|
|
413
|
+
type: integer
|
|
414
|
+
rotation:
|
|
415
|
+
description: set page rotation angle
|
|
416
|
+
type: integer
|
|
417
|
+
PageSpecificationListInputRepresentation:
|
|
418
|
+
description: Input representation for list of PageSpecification
|
|
419
|
+
type: object
|
|
420
|
+
properties:
|
|
421
|
+
pageSpecifications:
|
|
422
|
+
description: Set Page Specifications
|
|
423
|
+
type: array
|
|
424
|
+
items:
|
|
425
|
+
type: object
|
|
426
|
+
ProcessDefinitionInputRepresentation:
|
|
427
|
+
description: Input representation for verification process defintion
|
|
428
|
+
type: object
|
|
429
|
+
properties:
|
|
430
|
+
layoutType:
|
|
431
|
+
description: Layout Type
|
|
432
|
+
type: string
|
|
433
|
+
processDetail:
|
|
434
|
+
description: Process Detail
|
|
435
|
+
# TODO hand rolled. W-10727777
|
|
436
|
+
type: ProcessDetailListInputRepresentation
|
|
437
|
+
ProcessDefinitionOutputRepresentation:
|
|
438
|
+
description: Representation of a process defintion
|
|
439
|
+
type: object
|
|
440
|
+
properties:
|
|
441
|
+
layoutType:
|
|
442
|
+
description: Layout type
|
|
443
|
+
type: string
|
|
444
|
+
processDetail:
|
|
445
|
+
description: Process Detail
|
|
446
|
+
type: array
|
|
447
|
+
items:
|
|
448
|
+
type: ProcessDetailOutputRepresentation
|
|
449
|
+
ProcessDetailInputRepresentation:
|
|
450
|
+
description: Input representation for process detail
|
|
451
|
+
type: object
|
|
452
|
+
properties:
|
|
453
|
+
apexClassName:
|
|
454
|
+
description: Apex Class Name
|
|
455
|
+
type: string
|
|
456
|
+
dataSourceType:
|
|
457
|
+
description: Data Source Type
|
|
458
|
+
type: string
|
|
459
|
+
developerName:
|
|
460
|
+
description: Developer Name
|
|
461
|
+
type: string
|
|
462
|
+
isRetryAllowedAfterLimit:
|
|
463
|
+
description: Retry Allowed After Limit
|
|
464
|
+
type: boolean
|
|
465
|
+
label:
|
|
466
|
+
description: Label
|
|
467
|
+
type: string
|
|
468
|
+
linkedVerificationProcessDetailName:
|
|
469
|
+
description: Linked Verification Process Detail Name
|
|
470
|
+
type: string
|
|
471
|
+
optionalVerifierCount:
|
|
472
|
+
description: Optional Verifier Count
|
|
473
|
+
type: integer
|
|
474
|
+
retryLimit:
|
|
475
|
+
description: Retry Limit
|
|
476
|
+
type: integer
|
|
477
|
+
searchObjectName:
|
|
478
|
+
description: Search Object Name
|
|
479
|
+
type: string
|
|
480
|
+
searchResultFilter:
|
|
481
|
+
description: Search Result Filter
|
|
482
|
+
type: string
|
|
483
|
+
searchResultSortOrder:
|
|
484
|
+
description: Search Result Sort Order
|
|
485
|
+
type: string
|
|
486
|
+
searchResultUniqueIdField:
|
|
487
|
+
description: Search Result UniqueId Field
|
|
488
|
+
type: string
|
|
489
|
+
searchSequenceNo:
|
|
490
|
+
description: Search Sequence number
|
|
491
|
+
type: integer
|
|
492
|
+
searchType:
|
|
493
|
+
description: Search Type - SOSL/SOQL
|
|
494
|
+
type: string
|
|
495
|
+
verificationProcessFieldList:
|
|
496
|
+
description: Verification Process Field List
|
|
497
|
+
# TODO hand rolled. W-10727777
|
|
498
|
+
type: VerificationProcessFieldListInputRepresentation
|
|
499
|
+
|
|
500
|
+
ProcessDetailListInputRepresentation:
|
|
501
|
+
description: Input representation for list of process detail
|
|
502
|
+
type: object
|
|
503
|
+
properties:
|
|
504
|
+
processDetailList:
|
|
505
|
+
description: Process Detail List
|
|
506
|
+
type: array
|
|
507
|
+
items:
|
|
508
|
+
# TODO hand rolled. W-10727777
|
|
509
|
+
type: ProcessDetailInputRepresentation
|
|
510
|
+
ProcessDetailOutputRepresentation:
|
|
511
|
+
description: Representation of Process Detail
|
|
512
|
+
type: object
|
|
513
|
+
properties:
|
|
514
|
+
apexClassName:
|
|
515
|
+
description: Apex Class Name
|
|
516
|
+
type: string
|
|
517
|
+
dataSourceType:
|
|
518
|
+
description: Data Source Type
|
|
519
|
+
type: string
|
|
520
|
+
developerName:
|
|
521
|
+
description: Developer Name
|
|
522
|
+
type: string
|
|
523
|
+
isRetryAllowedAfterLimit:
|
|
524
|
+
description: Retry Allowed After Limit
|
|
525
|
+
type: boolean
|
|
526
|
+
label:
|
|
527
|
+
description: Label
|
|
528
|
+
type: string
|
|
529
|
+
linkedVerificationProcessDetailName:
|
|
530
|
+
description: Linked Verification Process Definition Name
|
|
531
|
+
type: string
|
|
532
|
+
optionalVerifierCount:
|
|
533
|
+
description: Optional Verifier Count
|
|
534
|
+
type: integer
|
|
535
|
+
retryLimit:
|
|
536
|
+
description: Retry Limit
|
|
537
|
+
type: integer
|
|
538
|
+
searchObjectName:
|
|
539
|
+
description: Search Object Name
|
|
540
|
+
type: string
|
|
541
|
+
searchResultFilter:
|
|
542
|
+
description: Search Result Filter
|
|
543
|
+
type: string
|
|
544
|
+
searchResultSortOrder:
|
|
545
|
+
description: Search Result Sort Order
|
|
546
|
+
type: string
|
|
547
|
+
searchResultUniqueIdField:
|
|
548
|
+
description: Search Result Unique Id
|
|
549
|
+
type: string
|
|
550
|
+
searchSequenceNo:
|
|
551
|
+
description: Search Sequence Number
|
|
552
|
+
type: integer
|
|
553
|
+
searchType:
|
|
554
|
+
description: Search Type
|
|
555
|
+
type: string
|
|
556
|
+
verificationProcessFieldList:
|
|
557
|
+
description: List of verification process fields
|
|
558
|
+
type: VerificationProcessFieldListOutputRepresentation
|
|
559
|
+
SearchFieldRepresentation:
|
|
560
|
+
description: Representation of Search Result field
|
|
561
|
+
type: object
|
|
562
|
+
properties:
|
|
563
|
+
developerName:
|
|
564
|
+
description: Developer Name
|
|
565
|
+
type: string
|
|
566
|
+
value:
|
|
567
|
+
description: Field Value
|
|
568
|
+
type: string
|
|
569
|
+
SearchFilterInputRepresentation:
|
|
570
|
+
description: Input representation of search fields for SOQL search
|
|
571
|
+
type: object
|
|
572
|
+
properties:
|
|
573
|
+
developerName:
|
|
574
|
+
description: Developer Name
|
|
575
|
+
type: string
|
|
576
|
+
value:
|
|
577
|
+
description: Field Value
|
|
578
|
+
type: string
|
|
579
|
+
SearchFilterListInputRepresentation:
|
|
580
|
+
description: Input representation for Search filters List for SOQL framework
|
|
581
|
+
type: object
|
|
582
|
+
properties:
|
|
583
|
+
searchFilterList:
|
|
584
|
+
description: Search filter Object List
|
|
585
|
+
type: array
|
|
586
|
+
items:
|
|
587
|
+
# TODO hand rolled. W-10727777
|
|
588
|
+
type: SearchFilterInputRepresentation
|
|
589
|
+
SearchInputRepresentation:
|
|
590
|
+
description: Input representation for Search API
|
|
591
|
+
type: object
|
|
592
|
+
properties:
|
|
593
|
+
searchFilters:
|
|
594
|
+
description: Search Filter object
|
|
595
|
+
type: SearchFilterListInputRepresentation
|
|
596
|
+
#TODO hand rolled W-10727777
|
|
597
|
+
searchTerm:
|
|
598
|
+
description: Search Term
|
|
599
|
+
type: string
|
|
600
|
+
verificationContext:
|
|
601
|
+
description: Verification Context
|
|
602
|
+
type: VerificationContextInputRepresentation
|
|
603
|
+
# TODO hand rolled. W-10727777
|
|
604
|
+
# TODO hand rolled. W-10727777. Added the following wrapper manually
|
|
605
|
+
SearchWrapperInputRepresentation:
|
|
606
|
+
description: wrapper of SearchInputRepresentation
|
|
607
|
+
type: object
|
|
608
|
+
properties:
|
|
609
|
+
SearchRecordsContextData:
|
|
610
|
+
description: Input representation for SearchInputRepresentation
|
|
611
|
+
type: SearchInputRepresentation
|
|
612
|
+
SearchOutputRepresentation:
|
|
613
|
+
description: Output representation of Search API for Identity Verification feature
|
|
614
|
+
type: object
|
|
615
|
+
properties:
|
|
616
|
+
isSuccess:
|
|
617
|
+
description: Search API result success/failure
|
|
618
|
+
type: boolean
|
|
619
|
+
message:
|
|
620
|
+
description: Search API result message
|
|
621
|
+
type: string
|
|
622
|
+
searchResult:
|
|
623
|
+
description: Search API result field list
|
|
624
|
+
type: array
|
|
625
|
+
items:
|
|
626
|
+
type: SearchResultRepresentation
|
|
627
|
+
searchResultHeader:
|
|
628
|
+
description: Search API result header field list
|
|
629
|
+
type: array
|
|
630
|
+
items:
|
|
631
|
+
type: SearchResultHeaderRepresentation
|
|
632
|
+
SearchResultHeaderRepresentation:
|
|
633
|
+
description: Representation of Search API Result Header
|
|
634
|
+
type: object
|
|
635
|
+
properties:
|
|
636
|
+
dataType:
|
|
637
|
+
description: Data type of field
|
|
638
|
+
type: string
|
|
639
|
+
developerName:
|
|
640
|
+
description: Field API Name
|
|
641
|
+
type: string
|
|
642
|
+
displayLabel:
|
|
643
|
+
description: Display label for the field
|
|
644
|
+
type: string
|
|
645
|
+
SearchResultRepresentation:
|
|
646
|
+
description: Representation of Search API Result
|
|
647
|
+
type: object
|
|
648
|
+
properties:
|
|
649
|
+
searchFields:
|
|
650
|
+
description: List of search fields
|
|
651
|
+
type: array
|
|
652
|
+
items:
|
|
653
|
+
type: SearchFieldRepresentation
|
|
654
|
+
SelectedSearchResultInputRepresentation:
|
|
655
|
+
description: Input representation for Selected Search Result
|
|
656
|
+
type: object
|
|
657
|
+
properties:
|
|
658
|
+
objectName:
|
|
659
|
+
description: Object Name
|
|
660
|
+
type: string
|
|
661
|
+
selectedRecordId:
|
|
662
|
+
description: Selected Record Id
|
|
663
|
+
type: string
|
|
664
|
+
selectedRecordObject:
|
|
665
|
+
description: Selected Record Object
|
|
666
|
+
# TODO hand rolled. W-10727777
|
|
667
|
+
type: FieldValueListInputRepresentation
|
|
668
|
+
SelectedSearchResultOutputRepresentation:
|
|
669
|
+
description: Representation of a selected search result
|
|
670
|
+
type: object
|
|
671
|
+
properties:
|
|
672
|
+
objectName:
|
|
673
|
+
description: Object Name
|
|
674
|
+
type: string
|
|
675
|
+
selectedRecordId:
|
|
676
|
+
description: Selected Record Id
|
|
677
|
+
type: string
|
|
678
|
+
selectedRecordObject:
|
|
679
|
+
description: Selected Record Object
|
|
680
|
+
type: array
|
|
681
|
+
items:
|
|
682
|
+
type: FieldValueOutputRepresentation
|
|
683
|
+
SelectedVerifiedResultInputRepresentation:
|
|
684
|
+
description: Input representation for selected verified result
|
|
685
|
+
type: object
|
|
686
|
+
properties:
|
|
687
|
+
verifiedDetails:
|
|
688
|
+
description: Verified Details
|
|
689
|
+
# TODO hand rolled. W-10727777
|
|
690
|
+
type: VerifiedDetailsListInputRepresentation
|
|
691
|
+
SelectedVerifiedResultOutputRepresentation:
|
|
692
|
+
description: Output representation for selected verified result
|
|
693
|
+
type: object
|
|
694
|
+
properties:
|
|
695
|
+
verifiedDetails:
|
|
696
|
+
description: Verified Details
|
|
697
|
+
type: array
|
|
698
|
+
items:
|
|
699
|
+
type: VerifiedDetailsOutputRepresentation
|
|
700
|
+
SetupCallInputRepresentation:
|
|
701
|
+
description: Input representation for SetupCall
|
|
702
|
+
type: object
|
|
703
|
+
properties:
|
|
704
|
+
externalMeetingId:
|
|
705
|
+
description: Set External Meeting Id for Video Call Setup
|
|
706
|
+
type: string
|
|
707
|
+
participantIntakeForm:
|
|
708
|
+
description: Set Participant Intake Form for Video Call Setup
|
|
709
|
+
type: object
|
|
710
|
+
properties:
|
|
711
|
+
//:
|
|
712
|
+
type: string
|
|
713
|
+
relatedRecordId:
|
|
714
|
+
description: Set Related Record Id for Video Call Setup
|
|
715
|
+
type: string
|
|
716
|
+
SetupCallResultRepresentation:
|
|
717
|
+
description: Output representation of SetupCall Result
|
|
718
|
+
type: object
|
|
719
|
+
properties:
|
|
720
|
+
errorMessage:
|
|
721
|
+
description: SetupCall error messages
|
|
722
|
+
type: string
|
|
723
|
+
required: false
|
|
724
|
+
isModerator:
|
|
725
|
+
description: SetupCall moderator flag
|
|
726
|
+
type: boolean
|
|
727
|
+
required: false
|
|
728
|
+
isSuccess:
|
|
729
|
+
description: SetupCall success flag
|
|
730
|
+
type: boolean
|
|
731
|
+
notifyAccess:
|
|
732
|
+
description: SetupCall Notify Access
|
|
733
|
+
type: NotifyAccessResultRepresentation
|
|
734
|
+
required: false
|
|
735
|
+
TimelineDataGetResultRepresentation:
|
|
736
|
+
description: Output represantation of Timeline Data from the GET Resource
|
|
737
|
+
type: object
|
|
738
|
+
properties:
|
|
739
|
+
errors:
|
|
740
|
+
description: TimelineData GET Resource List of Errors
|
|
741
|
+
type: array
|
|
742
|
+
items:
|
|
743
|
+
type: TimelineErrorRepresentation
|
|
744
|
+
eventTypes:
|
|
745
|
+
description: TimelineData GET Resource Event Types
|
|
746
|
+
type: array
|
|
747
|
+
items:
|
|
748
|
+
type: TimelineEventTypeRepresentation
|
|
749
|
+
events:
|
|
750
|
+
description: TimelineData GET Resource fetch all events
|
|
751
|
+
type: array
|
|
752
|
+
items:
|
|
753
|
+
type: TimelineEventRepresentation
|
|
754
|
+
hasMoreData:
|
|
755
|
+
description: TimelineData Get Resource - more Data to be fetched
|
|
756
|
+
type: boolean
|
|
757
|
+
isSuccess:
|
|
758
|
+
description: TimelineData get status flag
|
|
759
|
+
type: boolean
|
|
760
|
+
TimelineElementRepresentation:
|
|
761
|
+
description: Output representation of Fields/related Lists that is returned as
|
|
762
|
+
part of the GET Timeline metadata
|
|
763
|
+
type: object
|
|
764
|
+
properties:
|
|
765
|
+
apiName:
|
|
766
|
+
description: Element API Name
|
|
767
|
+
type: string
|
|
768
|
+
dataType:
|
|
769
|
+
description: Element dataType Name
|
|
770
|
+
type: string
|
|
771
|
+
label:
|
|
772
|
+
description: Element label Name
|
|
773
|
+
type: string
|
|
774
|
+
TimelineEntityRepresentation:
|
|
775
|
+
description: Output representation of entity that is returned as part of the GET
|
|
776
|
+
Timeline metadata
|
|
777
|
+
type: object
|
|
778
|
+
properties:
|
|
779
|
+
ageField:
|
|
780
|
+
description: TimelineMetadata Age Field
|
|
781
|
+
type: string
|
|
782
|
+
entityLabel:
|
|
783
|
+
description: EntityLabel
|
|
784
|
+
type: string
|
|
785
|
+
entityName:
|
|
786
|
+
description: Entity Name
|
|
787
|
+
type: string
|
|
788
|
+
icon:
|
|
789
|
+
description: Icon
|
|
790
|
+
type: string
|
|
791
|
+
isAgeFieldSelected:
|
|
792
|
+
description: TimelineMetadata age field selected flag
|
|
793
|
+
type: boolean
|
|
794
|
+
source:
|
|
795
|
+
description: Source
|
|
796
|
+
type: string
|
|
797
|
+
TimelineErrorRepresentation:
|
|
798
|
+
description: Error response representation
|
|
799
|
+
type: object
|
|
800
|
+
properties:
|
|
801
|
+
code:
|
|
802
|
+
description: Code for Error
|
|
803
|
+
type: string
|
|
804
|
+
message:
|
|
805
|
+
description: Message Error
|
|
806
|
+
type: string
|
|
807
|
+
TimelineEventFieldRepresentation:
|
|
808
|
+
description: Output representation of the Event Field that is returned as part
|
|
809
|
+
of the GET Timeline Data Result
|
|
810
|
+
type: object
|
|
811
|
+
properties:
|
|
812
|
+
name:
|
|
813
|
+
description: Event Field Name
|
|
814
|
+
type: string
|
|
815
|
+
value:
|
|
816
|
+
description: Event Field Value
|
|
817
|
+
type: string
|
|
818
|
+
TimelineEventRepresentation:
|
|
819
|
+
description: Output representation of the Event that is returned as part of the
|
|
820
|
+
GET Timeline Data Result
|
|
821
|
+
type: object
|
|
822
|
+
properties:
|
|
823
|
+
description:
|
|
824
|
+
description: Description of the Event Entity
|
|
825
|
+
type: string
|
|
826
|
+
eventDateTime:
|
|
827
|
+
description: Date Time of the Event
|
|
828
|
+
type: string
|
|
829
|
+
fields:
|
|
830
|
+
description: Fields of the Event
|
|
831
|
+
type: array
|
|
832
|
+
items:
|
|
833
|
+
type: TimelineEventFieldRepresentation
|
|
834
|
+
id:
|
|
835
|
+
description: Record Id
|
|
836
|
+
type: string
|
|
837
|
+
title:
|
|
838
|
+
description: Title of the Event Entity
|
|
839
|
+
type: string
|
|
840
|
+
type:
|
|
841
|
+
description: Event Entity Type
|
|
842
|
+
type: string
|
|
843
|
+
TimelineEventTypeMetadataRepresentation:
|
|
844
|
+
description: Output representation of Event Object that is returned as part of
|
|
845
|
+
the GET Timeline metadata
|
|
846
|
+
type: object
|
|
847
|
+
properties:
|
|
848
|
+
anchorReferenceField:
|
|
849
|
+
description: Event Object anchor Reference field
|
|
850
|
+
type: TimelineElementRepresentation
|
|
851
|
+
entityApiName:
|
|
852
|
+
description: Event Entity API Name
|
|
853
|
+
type: string
|
|
854
|
+
entityLabel:
|
|
855
|
+
description: Event Entity Label Name
|
|
856
|
+
type: string
|
|
857
|
+
fieldsToDisplay:
|
|
858
|
+
description: Event Object fieldsToDisplay List
|
|
859
|
+
type: array
|
|
860
|
+
items:
|
|
861
|
+
type: TimelineElementRepresentation
|
|
862
|
+
relatedlistsToDisplay:
|
|
863
|
+
description: Event Object relatedlistsToDisplay List
|
|
864
|
+
type: array
|
|
865
|
+
items:
|
|
866
|
+
type: TimelineElementRepresentation
|
|
867
|
+
relationType:
|
|
868
|
+
description: Event Object relation type
|
|
869
|
+
type: string
|
|
870
|
+
sortField:
|
|
871
|
+
description: Event Object sort field
|
|
872
|
+
type: TimelineElementRepresentation
|
|
873
|
+
subTitle:
|
|
874
|
+
description: Event Object subTitle field
|
|
875
|
+
type: TimelineElementRepresentation
|
|
876
|
+
title:
|
|
877
|
+
description: Event Object title field
|
|
878
|
+
type: TimelineElementRepresentation
|
|
879
|
+
TimelineEventTypeRepresentation:
|
|
880
|
+
description: Output representation of EventType that is returned as part of the
|
|
881
|
+
GET Timeline Data Result
|
|
882
|
+
type: object
|
|
883
|
+
properties:
|
|
884
|
+
eventApiName:
|
|
885
|
+
description: Event API Name
|
|
886
|
+
type: string
|
|
887
|
+
offset:
|
|
888
|
+
description: Timeline Data Offset
|
|
889
|
+
type: integer
|
|
890
|
+
TimelineMetadataDefinitionRepresentation:
|
|
891
|
+
description: Output representation of Timeline Metadata from the GET Resource
|
|
892
|
+
type: object
|
|
893
|
+
properties:
|
|
894
|
+
anchorObject:
|
|
895
|
+
description: TimelineMetadata Anchor Object
|
|
896
|
+
type: TimelineEntityRepresentation
|
|
897
|
+
eventTypes:
|
|
898
|
+
description: TimelineMetadata GET Resource fetch all event objects
|
|
899
|
+
type: array
|
|
900
|
+
items:
|
|
901
|
+
type: TimelineEventTypeMetadataRepresentation
|
|
902
|
+
fullName:
|
|
903
|
+
description: TimelineMetadata Configuration Name
|
|
904
|
+
type: string
|
|
905
|
+
isActive:
|
|
906
|
+
description: TimelineMetadata active status flag
|
|
907
|
+
type: boolean
|
|
908
|
+
masterLabel:
|
|
909
|
+
description: TimelineMetadata Configuration Label
|
|
910
|
+
type: string
|
|
911
|
+
TimelineMetadataResultRepresentation:
|
|
912
|
+
description: Output representation of Timeline Metadata from the GET Resource
|
|
913
|
+
type: object
|
|
914
|
+
properties:
|
|
915
|
+
definitions:
|
|
916
|
+
description: TimelineMetadata GET Resource fetch all definitions
|
|
917
|
+
type: array
|
|
918
|
+
items:
|
|
919
|
+
type: TimelineMetadataDefinitionRepresentation
|
|
920
|
+
errors:
|
|
921
|
+
description: TimelineMetadata GET Resource List of Errors
|
|
922
|
+
type: array
|
|
923
|
+
items:
|
|
924
|
+
type: TimelineErrorRepresentation
|
|
925
|
+
status:
|
|
926
|
+
description: TimelineMetadata get status
|
|
927
|
+
type: string
|
|
928
|
+
UpdateVideoCallInputRepresentation:
|
|
929
|
+
description: Input representation for UpdateVideoCall
|
|
930
|
+
type: object
|
|
931
|
+
properties:
|
|
932
|
+
isEnded:
|
|
933
|
+
description: Set whether Video Call is ended or not
|
|
934
|
+
type: boolean
|
|
935
|
+
meetingId:
|
|
936
|
+
description: Set Meeting Id for Video Call update
|
|
937
|
+
type: string
|
|
938
|
+
UpdateVideoCallResultRepresentation:
|
|
939
|
+
description: Output representation of UpdateVideoCall Result
|
|
940
|
+
type: object
|
|
941
|
+
properties:
|
|
942
|
+
errorMessage:
|
|
943
|
+
description: UpdateVideoCall error messages
|
|
944
|
+
type: string
|
|
945
|
+
required: false
|
|
946
|
+
isSuccess:
|
|
947
|
+
description: UpdateVideoCall success flag
|
|
948
|
+
type: boolean
|
|
949
|
+
ValidateSignatureInputRepresentation:
|
|
950
|
+
description: Input representation for ValidateSignature
|
|
951
|
+
type: object
|
|
952
|
+
properties:
|
|
953
|
+
signature:
|
|
954
|
+
description: The signature to be validated
|
|
955
|
+
type: string
|
|
956
|
+
ValidateSignatureResultRepresentation:
|
|
957
|
+
description: Output representation of ValidateSignature
|
|
958
|
+
type: object
|
|
959
|
+
properties:
|
|
960
|
+
errorMessage:
|
|
961
|
+
description: ValidateSignature error messages
|
|
962
|
+
type: string
|
|
963
|
+
required: false
|
|
964
|
+
externalMeetingId:
|
|
965
|
+
description: The external meeting id for the supplied signature
|
|
966
|
+
type: string
|
|
967
|
+
required: false
|
|
968
|
+
isValid:
|
|
969
|
+
description: ValidateSignature valid flag
|
|
970
|
+
type: boolean
|
|
971
|
+
VerificationContextInputRepresentation:
|
|
972
|
+
description: Input representation for verification context
|
|
973
|
+
type: object
|
|
974
|
+
properties:
|
|
975
|
+
processDefinition:
|
|
976
|
+
description:
|
|
977
|
+
Process Definition
|
|
978
|
+
# TODO hand rolled. W-10727777
|
|
979
|
+
type: ProcessDefinitionInputRepresentation
|
|
980
|
+
selectedSearchResult:
|
|
981
|
+
description: Selected Search Result
|
|
982
|
+
# TODO hand rolled. W-10727777
|
|
983
|
+
type: SelectedSearchResultInputRepresentation
|
|
984
|
+
selectedVerifiedResult:
|
|
985
|
+
description: Selected Verified Result
|
|
986
|
+
type: SelectedVerifiedResultInputRepresentation
|
|
987
|
+
# TODO hand rolled. W-10727777
|
|
988
|
+
verifiedResult:
|
|
989
|
+
description: Verified Result
|
|
990
|
+
# TODO hand rolled. W-10727777
|
|
991
|
+
type: VerifiedResultInputRepresentation
|
|
992
|
+
# TODO hand rolled. W-10727777. Added the following wrapper manually
|
|
993
|
+
VerificationContextWrapperInputRepresentation:
|
|
994
|
+
description: wrapper of VerificationContextInputRepresentation
|
|
995
|
+
type: object
|
|
996
|
+
properties:
|
|
997
|
+
IdentityVerificationContextData:
|
|
998
|
+
description: Input representation for VerificationContextInputRepresentation
|
|
999
|
+
type: VerificationContextInputRepresentation
|
|
1000
|
+
VerificationContextOutputRepresentation:
|
|
1001
|
+
description: Representation of Verification Context
|
|
1002
|
+
type: object
|
|
1003
|
+
properties:
|
|
1004
|
+
isSuccess:
|
|
1005
|
+
description: API result success/failure
|
|
1006
|
+
type: boolean
|
|
1007
|
+
message:
|
|
1008
|
+
description: API result message
|
|
1009
|
+
type: string
|
|
1010
|
+
processDefinition:
|
|
1011
|
+
description: Process Definition
|
|
1012
|
+
type: ProcessDefinitionOutputRepresentation
|
|
1013
|
+
selectedSearchResult:
|
|
1014
|
+
description: Selected Search Result
|
|
1015
|
+
type: SelectedSearchResultOutputRepresentation
|
|
1016
|
+
selectedVerifiedResult:
|
|
1017
|
+
description: Selected Verified Result
|
|
1018
|
+
type: SelectedVerifiedResultOutputRepresentation
|
|
1019
|
+
verifiedResult:
|
|
1020
|
+
description: Verified Result
|
|
1021
|
+
type: VerifiedResultOutputRepresentation
|
|
1022
|
+
VerificationProcessFieldInputRepresentation:
|
|
1023
|
+
description: Input representation for verification process field
|
|
1024
|
+
type: object
|
|
1025
|
+
properties:
|
|
1026
|
+
dataSourceType:
|
|
1027
|
+
description: Data Source Type - Salesforce/External
|
|
1028
|
+
type: string
|
|
1029
|
+
dataType:
|
|
1030
|
+
description: Data type
|
|
1031
|
+
type: string
|
|
1032
|
+
developerName:
|
|
1033
|
+
description: Developer Name
|
|
1034
|
+
type: string
|
|
1035
|
+
fieldName:
|
|
1036
|
+
description: Field Name
|
|
1037
|
+
type: string
|
|
1038
|
+
fieldType:
|
|
1039
|
+
description: Field Type
|
|
1040
|
+
type: string
|
|
1041
|
+
fieldValueFormula:
|
|
1042
|
+
description: Field Value Formula
|
|
1043
|
+
type: string
|
|
1044
|
+
isManualInput:
|
|
1045
|
+
description: Is Manual Input
|
|
1046
|
+
type: boolean
|
|
1047
|
+
label:
|
|
1048
|
+
description: Label value
|
|
1049
|
+
type: string
|
|
1050
|
+
VerificationProcessFieldListInputRepresentation:
|
|
1051
|
+
description: Input representation for list of verification process field
|
|
1052
|
+
type: object
|
|
1053
|
+
properties:
|
|
1054
|
+
verificationProcessFields:
|
|
1055
|
+
description: List of verificationProcessField
|
|
1056
|
+
type: array
|
|
1057
|
+
items:
|
|
1058
|
+
# TODO hand rolled. W-10727777
|
|
1059
|
+
type: VerificationProcessFieldInputRepresentation
|
|
1060
|
+
VerificationProcessFieldListOutputRepresentation:
|
|
1061
|
+
description: List of Verification Process Field
|
|
1062
|
+
type: object
|
|
1063
|
+
properties:
|
|
1064
|
+
verificationProcessFields:
|
|
1065
|
+
description: Verification Process Fields
|
|
1066
|
+
type: array
|
|
1067
|
+
items:
|
|
1068
|
+
type: VerificationProcessFieldOutputRepresentation
|
|
1069
|
+
VerificationProcessFieldOutputRepresentation:
|
|
1070
|
+
description: Verification Process Field Output
|
|
1071
|
+
type: object
|
|
1072
|
+
properties:
|
|
1073
|
+
dataSourceType:
|
|
1074
|
+
description: Data Source Type
|
|
1075
|
+
type: string
|
|
1076
|
+
dataType:
|
|
1077
|
+
description: Data Type
|
|
1078
|
+
type: string
|
|
1079
|
+
developerName:
|
|
1080
|
+
description: Developer Name
|
|
1081
|
+
type: string
|
|
1082
|
+
fieldName:
|
|
1083
|
+
description: Field Name
|
|
1084
|
+
type: string
|
|
1085
|
+
fieldType:
|
|
1086
|
+
description: Field Type
|
|
1087
|
+
type: string
|
|
1088
|
+
fieldValueFormula:
|
|
1089
|
+
description: Field Value Formula
|
|
1090
|
+
type: string
|
|
1091
|
+
isManualInput:
|
|
1092
|
+
description: Is Manual Input
|
|
1093
|
+
type: boolean
|
|
1094
|
+
label:
|
|
1095
|
+
description: Label
|
|
1096
|
+
type: string
|
|
1097
|
+
VerifiedDetailsInputRepresentation:
|
|
1098
|
+
description: Input representation for verified details
|
|
1099
|
+
type: object
|
|
1100
|
+
properties:
|
|
1101
|
+
label:
|
|
1102
|
+
description: Label
|
|
1103
|
+
type: string
|
|
1104
|
+
processDetailName:
|
|
1105
|
+
description: Process Detail Name
|
|
1106
|
+
type: string
|
|
1107
|
+
searchObjectName:
|
|
1108
|
+
description: Search Object Name
|
|
1109
|
+
type: string
|
|
1110
|
+
verifiedId:
|
|
1111
|
+
description: Verified Id
|
|
1112
|
+
type: string
|
|
1113
|
+
VerifiedDetailsListInputRepresentation:
|
|
1114
|
+
description: Input representation for verified details
|
|
1115
|
+
type: object
|
|
1116
|
+
properties:
|
|
1117
|
+
verifiedDetailsList:
|
|
1118
|
+
description: Verified Details List
|
|
1119
|
+
type: array
|
|
1120
|
+
items:
|
|
1121
|
+
# TODO hand rolled. W-10727777
|
|
1122
|
+
type: VerifiedDetailsInputRepresentation
|
|
1123
|
+
|
|
1124
|
+
VerifiedDetailsOutputRepresentation:
|
|
1125
|
+
description: Output representation for verified details
|
|
1126
|
+
type: object
|
|
1127
|
+
properties:
|
|
1128
|
+
label:
|
|
1129
|
+
description: Label
|
|
1130
|
+
type: string
|
|
1131
|
+
processDetailName:
|
|
1132
|
+
description: Process Detail Name
|
|
1133
|
+
type: string
|
|
1134
|
+
searchObjectName:
|
|
1135
|
+
description: Search Object Name
|
|
1136
|
+
type: string
|
|
1137
|
+
verifiedId:
|
|
1138
|
+
description: Verified Id
|
|
1139
|
+
type: string
|
|
1140
|
+
VerifiedResultInputRepresentation:
|
|
1141
|
+
description: Input representation for verifier result
|
|
1142
|
+
type: object
|
|
1143
|
+
properties:
|
|
1144
|
+
optionalVerifiers:
|
|
1145
|
+
description: Optional Verifiers
|
|
1146
|
+
type: VerifierListInputRepresentation
|
|
1147
|
+
# TODO hand rolled. W-10727777
|
|
1148
|
+
requiredVerifiers:
|
|
1149
|
+
description: Required Verifiers
|
|
1150
|
+
type: VerifierListInputRepresentation
|
|
1151
|
+
# TODO hand rolled. W-10727777
|
|
1152
|
+
VerifiedResultOutputRepresentation:
|
|
1153
|
+
description: Representation of a Verified result
|
|
1154
|
+
type: object
|
|
1155
|
+
properties:
|
|
1156
|
+
optionalVerifiers:
|
|
1157
|
+
description: Optional Verifiers
|
|
1158
|
+
type: array
|
|
1159
|
+
items:
|
|
1160
|
+
type: VerifierOutputRepresentation
|
|
1161
|
+
requiredVerifiers:
|
|
1162
|
+
description: Required Verifiers
|
|
1163
|
+
type: array
|
|
1164
|
+
items:
|
|
1165
|
+
type: VerifierOutputRepresentation
|
|
1166
|
+
VerifierInputRepresentation:
|
|
1167
|
+
description: Input representation for verifier fields
|
|
1168
|
+
type: object
|
|
1169
|
+
properties:
|
|
1170
|
+
developerName:
|
|
1171
|
+
description: Developer Name
|
|
1172
|
+
type: string
|
|
1173
|
+
verificationState:
|
|
1174
|
+
description: Verification State
|
|
1175
|
+
type: string
|
|
1176
|
+
VerifierListInputRepresentation:
|
|
1177
|
+
description: Input representation for verifier result
|
|
1178
|
+
type: object
|
|
1179
|
+
properties:
|
|
1180
|
+
verifiersList:
|
|
1181
|
+
description: Verifiers List
|
|
1182
|
+
type: array
|
|
1183
|
+
items:
|
|
1184
|
+
type: VerifierInputRepresentation
|
|
1185
|
+
# TODO hand rolled. W-10727777
|
|
1186
|
+
VerifierOutputRepresentation:
|
|
1187
|
+
description: Representation of a Verifier
|
|
1188
|
+
type: object
|
|
1189
|
+
properties:
|
|
1190
|
+
developerName:
|
|
1191
|
+
description: Developer Name
|
|
1192
|
+
type: string
|
|
1193
|
+
verificationState:
|
|
1194
|
+
description: Verification State
|
|
1195
|
+
type: string
|
|
1196
|
+
VideoCallParticipantFieldRepresentation:
|
|
1197
|
+
description: Output representation of video call participant fields
|
|
1198
|
+
type: object
|
|
1199
|
+
properties:
|
|
1200
|
+
contactFieldValue:
|
|
1201
|
+
description: Field value from the contact record
|
|
1202
|
+
type: string
|
|
1203
|
+
doesFieldValuesMatch:
|
|
1204
|
+
description: Returns true when the field values from contact and intake form
|
|
1205
|
+
are same
|
|
1206
|
+
type: boolean
|
|
1207
|
+
fieldLabel:
|
|
1208
|
+
description: Field label
|
|
1209
|
+
type: string
|
|
1210
|
+
intakeFormFieldValue:
|
|
1211
|
+
description: Field value from the intake form submitted by guest
|
|
1212
|
+
type: string
|
|
1213
|
+
VideoCallParticipantRepresentation:
|
|
1214
|
+
description: Output representation of video call participant
|
|
1215
|
+
type: object
|
|
1216
|
+
properties:
|
|
1217
|
+
fields:
|
|
1218
|
+
description: List of video call participant fields with values from contact
|
|
1219
|
+
and intake form
|
|
1220
|
+
type: array
|
|
1221
|
+
items:
|
|
1222
|
+
type: VideoCallParticipantFieldRepresentation
|
|
1223
|
+
participantId:
|
|
1224
|
+
description: Participant id
|
|
1225
|
+
type: string
|
|
1226
|
+
participantName:
|
|
1227
|
+
description: Participant name
|
|
1228
|
+
type: string
|
|
1229
|
+
VideoCallParticipantResultRepresentation:
|
|
1230
|
+
description: Output representation of VideoCallParticipant
|
|
1231
|
+
type: object
|
|
1232
|
+
properties:
|
|
1233
|
+
inCallParticipants:
|
|
1234
|
+
description: List of participants who are admitted to the call
|
|
1235
|
+
type: array
|
|
1236
|
+
items:
|
|
1237
|
+
type: VideoCallParticipantRepresentation
|
|
1238
|
+
waitingParticipants:
|
|
1239
|
+
description: List of participants in the waiting room
|
|
1240
|
+
type: array
|
|
1241
|
+
items:
|
|
1242
|
+
type: VideoCallParticipantRepresentation
|
|
1243
|
+
/connect:
|
|
1244
|
+
# TODO: hand-rolled
|
|
1245
|
+
# /document-automation/contentDocuments/{contentDocumentId}/linkedObjects/{linkedObjectId}:
|
|
1246
|
+
# post:
|
|
1247
|
+
# description: API to edit Document and link object
|
|
1248
|
+
# responses:
|
|
1249
|
+
# '200':
|
|
1250
|
+
# description: Success
|
|
1251
|
+
# body:
|
|
1252
|
+
# application/json:
|
|
1253
|
+
# type: DocumentManagementResultRepresentation
|
|
1254
|
+
# body:
|
|
1255
|
+
# application/json:
|
|
1256
|
+
# type: DocumentManagementInputRepresentation
|
|
1257
|
+
# # required: false Hand Rolled Change that removed 'required: false' W-10727777
|
|
1258
|
+
# (oas-body-name): DocumentManagementInput
|
|
1259
|
+
# uriParameters:
|
|
1260
|
+
# contentDocumentId:
|
|
1261
|
+
# type: string
|
|
1262
|
+
# required: true
|
|
1263
|
+
# linkedObjectId:
|
|
1264
|
+
# type: string
|
|
1265
|
+
# required: true
|
|
1266
|
+
/identity-verification:
|
|
1267
|
+
/build-context/{processDefinitionName}:
|
|
1268
|
+
post:
|
|
1269
|
+
description: API to build context entity needed for all Identity Verification
|
|
1270
|
+
services
|
|
1271
|
+
responses:
|
|
1272
|
+
'200':
|
|
1273
|
+
description: Success
|
|
1274
|
+
body:
|
|
1275
|
+
application/json:
|
|
1276
|
+
type: VerificationContextOutputRepresentation
|
|
1277
|
+
body:
|
|
1278
|
+
application/json:
|
|
1279
|
+
type: BuildVerificationContextWrapperInputRepresentation
|
|
1280
|
+
# TODO hand rolled. W-10727777. Added the wrapper manually
|
|
1281
|
+
# TODO Hand Rolled Change that removed 'required: false' W-10727777
|
|
1282
|
+
(oas-body-name): BuildContextData
|
|
1283
|
+
uriParameters:
|
|
1284
|
+
processDefinitionName:
|
|
1285
|
+
type: string
|
|
1286
|
+
required: true
|
|
1287
|
+
/input-verification:
|
|
1288
|
+
post:
|
|
1289
|
+
description: API to verify a given record with customer inputs
|
|
1290
|
+
responses:
|
|
1291
|
+
'200':
|
|
1292
|
+
description: Success
|
|
1293
|
+
body:
|
|
1294
|
+
application/json:
|
|
1295
|
+
type: FormVerificationRepresentation
|
|
1296
|
+
body:
|
|
1297
|
+
application/json:
|
|
1298
|
+
# TODO hand rolled. W-12571153. Added the wrapper manually
|
|
1299
|
+
# TODO Hand Rolled Change to add 'required: false' W-12571153
|
|
1300
|
+
type: FormVerificationWrapperInputRepresentation
|
|
1301
|
+
(oas-body-name): IdentityVerificationFormInputData
|
|
1302
|
+
/search:
|
|
1303
|
+
post:
|
|
1304
|
+
description: API to search records for Identity Verification service
|
|
1305
|
+
responses:
|
|
1306
|
+
'200':
|
|
1307
|
+
description: Success
|
|
1308
|
+
body:
|
|
1309
|
+
application/json:
|
|
1310
|
+
type: SearchOutputRepresentation
|
|
1311
|
+
body:
|
|
1312
|
+
application/json:
|
|
1313
|
+
type: SearchWrapperInputRepresentation
|
|
1314
|
+
# TODO hand rolled. W-10727777. Added the wrapper manually
|
|
1315
|
+
# TODO Hand Rolled Change that removed 'required: false' W-10727777
|
|
1316
|
+
(oas-body-name): SearchRecordsContextData
|
|
1317
|
+
/verification:
|
|
1318
|
+
post:
|
|
1319
|
+
description: API to verify a given record
|
|
1320
|
+
responses:
|
|
1321
|
+
'200':
|
|
1322
|
+
description: Success
|
|
1323
|
+
body:
|
|
1324
|
+
application/json:
|
|
1325
|
+
type: VerificationContextOutputRepresentation
|
|
1326
|
+
body:
|
|
1327
|
+
application/json:
|
|
1328
|
+
type: VerificationContextWrapperInputRepresentation
|
|
1329
|
+
# TODO hand rolled. W-10727777. Added the wrapper manually
|
|
1330
|
+
# TODO Hand Rolled Change that removed 'required: false' W-10727777
|
|
1331
|
+
(oas-body-name): IdentityVerificationContextData
|
|
1332
|
+
/industries/video-call:
|
|
1333
|
+
# TODO: Hand rolled
|
|
1334
|
+
# post:
|
|
1335
|
+
# description: Setup VideoCall API Resource
|
|
1336
|
+
# responses:
|
|
1337
|
+
# '200':
|
|
1338
|
+
# description: Success
|
|
1339
|
+
# body:
|
|
1340
|
+
# application/json:
|
|
1341
|
+
# type: SetupCallResultRepresentation
|
|
1342
|
+
# body:
|
|
1343
|
+
# application/json:
|
|
1344
|
+
# type: SetupCallInputRepresentation
|
|
1345
|
+
# # required: false
|
|
1346
|
+
# (oas-body-name): SetupCallInput
|
|
1347
|
+
put:
|
|
1348
|
+
description: Update a video call
|
|
1349
|
+
responses:
|
|
1350
|
+
'200':
|
|
1351
|
+
description: Success
|
|
1352
|
+
body:
|
|
1353
|
+
application/json:
|
|
1354
|
+
type: UpdateVideoCallResultRepresentation
|
|
1355
|
+
body:
|
|
1356
|
+
application/json:
|
|
1357
|
+
type: UpdateVideoCallInputRepresentation
|
|
1358
|
+
# required: false
|
|
1359
|
+
(oas-body-name): UpdateVideoCallInput
|
|
1360
|
+
/join-call:
|
|
1361
|
+
# TODO: Hand rolled
|
|
1362
|
+
# post:
|
|
1363
|
+
# description: JoinVideoCall API Resource
|
|
1364
|
+
# responses:
|
|
1365
|
+
# '200':
|
|
1366
|
+
# description: Success
|
|
1367
|
+
# body:
|
|
1368
|
+
# application/json:
|
|
1369
|
+
# type: JoinVideoCallResultRepresentation
|
|
1370
|
+
# body:
|
|
1371
|
+
# application/json:
|
|
1372
|
+
# type: JoinVideoCallInputRepresentation
|
|
1373
|
+
# # required: false
|
|
1374
|
+
# (oas-body-name): JoinVideoCallInput
|
|
1375
|
+
/leave-call:
|
|
1376
|
+
put:
|
|
1377
|
+
description: LeaveVideoCall API Resource
|
|
1378
|
+
responses:
|
|
1379
|
+
'200':
|
|
1380
|
+
description: Success
|
|
1381
|
+
body:
|
|
1382
|
+
application/json:
|
|
1383
|
+
type: LeaveVideoCallResultRepresentation
|
|
1384
|
+
body:
|
|
1385
|
+
application/json:
|
|
1386
|
+
type: LeaveVideoCallInputRepresentation
|
|
1387
|
+
# required: false
|
|
1388
|
+
(oas-body-name): LeaveVideoCallInput
|
|
1389
|
+
/participant:
|
|
1390
|
+
get:
|
|
1391
|
+
description: API to get Participant data
|
|
1392
|
+
responses:
|
|
1393
|
+
'200':
|
|
1394
|
+
description: Success
|
|
1395
|
+
body:
|
|
1396
|
+
application/json:
|
|
1397
|
+
type: VideoCallParticipantResultRepresentation
|
|
1398
|
+
queryParameters:
|
|
1399
|
+
includeParticipantFields:
|
|
1400
|
+
type: boolean
|
|
1401
|
+
required: false
|
|
1402
|
+
meetingId:
|
|
1403
|
+
type: string
|
|
1404
|
+
required: false
|
|
1405
|
+
put:
|
|
1406
|
+
description: EvaluateVideoCallParticipant API Resource
|
|
1407
|
+
responses:
|
|
1408
|
+
'200':
|
|
1409
|
+
description: Success
|
|
1410
|
+
body:
|
|
1411
|
+
application/json:
|
|
1412
|
+
type: EvaluateVideoCallParticipantResultRepresentation
|
|
1413
|
+
body:
|
|
1414
|
+
application/json:
|
|
1415
|
+
type: EvaluateVideoCallParticipantInputRepresentation
|
|
1416
|
+
# required: false
|
|
1417
|
+
(oas-body-name): EvaluateVideoCallParticipantInput
|
|
1418
|
+
/validate-signature:
|
|
1419
|
+
# TODO: Hand rolled
|
|
1420
|
+
# post:
|
|
1421
|
+
# description: ValidateSignature API Resource
|
|
1422
|
+
# responses:
|
|
1423
|
+
# '200':
|
|
1424
|
+
# description: Success
|
|
1425
|
+
# body:
|
|
1426
|
+
# application/json:
|
|
1427
|
+
# type: ValidateSignatureResultRepresentation
|
|
1428
|
+
# body:
|
|
1429
|
+
# application/json:
|
|
1430
|
+
# type: ValidateSignatureInputRepresentation
|
|
1431
|
+
# # required: false
|
|
1432
|
+
# (oas-body-name): ValidateSignatureInput
|
|
1433
|
+
/timeline:
|
|
1434
|
+
/metadata/configurations:
|
|
1435
|
+
get:
|
|
1436
|
+
description: API to get Timeline metadata
|
|
1437
|
+
responses:
|
|
1438
|
+
'200':
|
|
1439
|
+
description: Success
|
|
1440
|
+
body:
|
|
1441
|
+
application/json:
|
|
1442
|
+
type: TimelineMetadataResultRepresentation
|
|
1443
|
+
queryParameters:
|
|
1444
|
+
fullNames:
|
|
1445
|
+
type: array
|
|
1446
|
+
required: false
|
|
1447
|
+
items:
|
|
1448
|
+
type: string
|
|
1449
|
+
(oas-collectionFormat): csv
|
|
1450
|
+
/{timelineObjRecordId}/timeline-definitions/{timelineConfigFullName}/events:
|
|
1451
|
+
get:
|
|
1452
|
+
description: API to get Timeline data
|
|
1453
|
+
responses:
|
|
1454
|
+
'200':
|
|
1455
|
+
description: Success
|
|
1456
|
+
body:
|
|
1457
|
+
application/json:
|
|
1458
|
+
type: TimelineDataGetResultRepresentation
|
|
1459
|
+
queryParameters:
|
|
1460
|
+
direction:
|
|
1461
|
+
type: string
|
|
1462
|
+
required: false
|
|
1463
|
+
endDate:
|
|
1464
|
+
type: string
|
|
1465
|
+
required: false
|
|
1466
|
+
eventTypeOffsets:
|
|
1467
|
+
type: string
|
|
1468
|
+
required: false
|
|
1469
|
+
eventTypes:
|
|
1470
|
+
type: string
|
|
1471
|
+
required: false
|
|
1472
|
+
startDate:
|
|
1473
|
+
type: string
|
|
1474
|
+
required: false
|
|
1475
|
+
uriParameters:
|
|
1476
|
+
timelineConfigFullName:
|
|
1477
|
+
type: string
|
|
1478
|
+
required: true
|
|
1479
|
+
timelineObjRecordId:
|
|
1480
|
+
type: string
|
|
1481
|
+
required: true
|