@salesforce/lds-adapters-industries-identityverification 1.100.2

package/src/raml/api.raml

@@ -0,0 +1,1521 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '57.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  BuildVerificationContextInputRepresentation:
+    description: Input representation for building verification context
+    type: object
+    properties:
+      objectName:
+        description: Object Name
+        type: string
+      processDetailName:
+        description: Process Detail Name
+        type: string
+      selectedRecordId:
+        description: Selected Record Id
+        type: string
+      selectedVerifiedResult:
+        description: Selected Verified Result
+        # TODO hand rolled. W-10727777
+        type: SelectedVerifiedResultInputRepresentation
+    # TODO hand rolled. W-10727777 added the following wrapper manually
+  BuildVerificationContextWrapperInputRepresentation:
+    description: wrapper of BuildVerificationContextInputRepresentation
+    type: object
+    properties:
+      BuildContextData:
+        description: Input representation for BuildVerificationContextInputRepresentation
+        type: BuildVerificationContextInputRepresentation
+  ChimeAttendeeResultRepresentation:
+    description: Output representation of Chime Attendee
+    type: object
+    properties:
+      attendeeId:
+        description: Chime AttendeeId
+        type: string
+        required: false
+      externalAttendeeId:
+        description: Chime ExternalAttendeeId
+        type: string
+        required: false
+      joinToken:
+        description: Chime Attendee join token
+        type: string
+        required: false
+  ChimeMediaPlacementResultRepresentation:
+    description: Output representation of Chime Media Placement Result
+    type: object
+    properties:
+      audioFallbackUrl:
+        description: ChimeMediaPlacement AudioFallbackUrl
+        type: string
+        required: false
+      audioHostUrl:
+        description: ChimeMediaPlacement AudioHostUrl
+        type: string
+        required: false
+      eventIngestionUrl:
+        description: ChimeMediaPlacement EventIngestionUrl
+        type: string
+        required: false
+      screenDataUrl:
+        description: ChimeMediaPlacement ScreenDataUrl
+        type: string
+        required: false
+      screenSharingUrl:
+        description: ChimeMediaPlacement ScreenSharingUrl
+        type: string
+        required: false
+      screenViewingUrl:
+        description: ChimeMediaPlacement ScreenViewingUrl
+        type: string
+        required: false
+      signalingUrl:
+        description: ChimeMediaPlacement SignalingUrl
+        type: string
+        required: false
+      turnControlUrl:
+        description: ChimeMediaPlacement TurnControlUrl
+        type: string
+        required: false
+  ChimeMeetingResultRepresentation:
+    description: Output representation of Chime Meeting
+    type: object
+    properties:
+      mediaPlacement:
+        description: MediaPlacementUrls of chime meeting
+        type: ChimeMediaPlacementResultRepresentation
+        required: false
+      meetingId:
+        description: Chime MeetingId
+        type: string
+        required: false
+  DocumentManagementInputRepresentation:
+    description: Input representation for DocumentManagement
+    type: object
+    properties:
+      isOcrRequested:
+        description: Is Ocr Requested
+        type: boolean
+      linkedObjectFieldsMap:
+        description: Set Linked Object Fields Map
+        type: object
+        properties:
+          //:
+            type: string
+      pageSpecificationList:
+        description: Set Page Specification List
+        type: array
+        items:
+          type: object
+      targetFileName:
+        description: Set Target File Name
+        type: string
+  DocumentManagementResultRepresentation:
+    description: Output representation of Document Management Output Result
+    type: object
+    properties:
+      contentDocumentId:
+        description: Content Document Id
+        type: string
+      error:
+        description: Error representation for a Document Management
+        type: ErrorResponseRepresentation
+      isSuccess:
+        description: Document Management success flag
+        type: boolean
+  ErrorResponseRepresentation:
+    description: Error response representation
+    type: object
+    properties:
+      code:
+        description: Code for Error
+        type: string
+      message:
+        description: Message stating the reason for error, if any
+        type: string
+  EvaluateVideoCallParticipantInputRepresentation:
+    description: Input representation for VideoCall EvaluateCaller
+    type: object
+    properties:
+      isAccepted:
+        description: Set whether caller is accepted for Video Call
+        type: boolean
+      participantId:
+        description: Set Participant Id for Video Caller Evaluation
+        type: string
+  EvaluateVideoCallParticipantResultRepresentation:
+    description: Output representation of EvaluateCallerVideoCall Result
+    type: object
+    properties:
+      errorMessage:
+        description: EvaluateCallerVideoCall error messages
+        type: string
+        required: false
+      isSuccess:
+        description: EvaluateCallerVideoCall success flag
+        type: boolean
+  FieldValueInputRepresentation:
+    description: Input representation for each field
+    type: object
+    properties:
+      developerName:
+        description: Developer Name
+        type: string
+      value:
+        description: Value
+        type: string
+  FieldValueListInputRepresentation:
+    description: Input representation for Selected Search Result List
+    type: object
+    properties:
+      selectedRecordObjectList:
+        description: Selected Record Object List
+        type: array
+        items:
+          # TODO hand rolled. W-10727777
+          type: FieldValueInputRepresentation
+  FieldValueOutputRepresentation:
+    description: Representation of a field value
+    type: object
+    properties:
+      developerName:
+        description: Developer Name
+        type: string
+      value:
+        description: Value
+        type: string
+  FormVerificationDisplayRecordDetailsOutput:
+    description: Details of reference record of selected record id
+    type: object
+    properties:
+      displayRecordId:
+        description: Reference Record Id
+        type: string
+      displayRecordName:
+        description: Reference Record Name
+        type: string
+  FormVerificationFieldInputRepresentation:
+    description: Input representation for each verification field
+    type: object
+    properties:
+      developerName:
+        description: Developer Name
+        type: string
+      isVerified:
+        description: Verified flag to set for non-form based input
+        type: boolean
+      value:
+        description: Input value of the field
+        type: string
+  FormVerificationFieldListInputRepresentation:
+    description: Input representation for Verification fields with values
+    type: object
+    properties:
+      formVerificationFields:
+        description: Form Input Verification field List
+        type: array
+        items:
+          type: object
+  FormVerificationFieldListOutputRepresentation:
+    description: List of Form Verification Fields
+    type: object
+    properties:
+      formVerificationFields:
+        description: Form Verification Fields
+        type: array
+        items:
+          type: FormVerificationFieldOutputRepresentation
+  FormVerificationFieldListRepresentation:
+    description: List of Form Verification Fields
+    type: object
+    properties:
+      formVerificationFields:
+        description: Form Verification Fields
+        type: array
+        items:
+          type: FormVerificationFieldRepresentation
+  FormVerificationFieldOutputRepresentation:
+    description: Representation of Form Verification results
+    type: object
+    properties:
+      developerName:
+        description: Developer Name
+        type: string
+      isVerified:
+        description: Is the field verified
+        type: boolean
+      value:
+        description: Value
+        type: string
+  FormVerificationFieldRepresentation:
+    description: Representation of Form Verification results
+    type: object
+    properties:
+      developerName:
+        description: Developer Name
+        type: string
+      isVerified:
+        description: Is the field verified
+        type: boolean
+      value:
+        description: Value
+        type: string
+  FormVerificationInputRepresentation:
+    description: Input representation for verification of input values
+    type: object
+    properties:
+      developerName:
+        description: Selected developer name of verification context
+        type: string
+      formVerificationFieldList:
+        description: Input values of the fields which are up for validations
+        type: FormVerificationFieldListOutputRepresentation
+      selectedRecordId:
+        description: Selected Record Id
+        type: string
+  FormVerificationOutputRepresentation:
+    description: Representation of Form Verification Fields
+    type: object
+    properties:
+      developerName:
+        description: Developer name of IDV record
+        type: string
+      formVerificationFieldList:
+        description: Field verification results
+        type: FormVerificationFieldListOutputRepresentation
+      isVerified:
+        description: Flag to get the overall verification status
+        type: boolean
+      referenceRecordDetails:
+        description: Parent record id in case redirection needs to be to parent post
+          verification
+        type: FormVerificationReferenceRecordDetailsOutput
+      retryCount:
+        description: Retry count in case of failed attempt
+        type: integer
+      selectedRecordId:
+        description: Id of the selected record
+        type: string
+      status:
+        description: Field verification results status
+        type: ErrorResponseRepresentation
+  FormVerificationReferenceRecordDetailsOutput:
+    description: Details of reference record of selected record id
+    type: object
+    properties:
+      referenceRecordId:
+        description: Reference Record Id
+        type: string
+      referenceRecordName:
+        description: Reference Record Name
+        type: string
+  FormVerificationRepresentation:
+    description: Representation of Form Verification Fields
+    type: object
+    properties:
+      developerName:
+        description: Developer name of IDV record
+        type: string
+      displayRecordDetails:
+        description: Parent record id in case redirection needs to be to parent post
+          verification
+        type: FormVerificationDisplayRecordDetailsOutput
+      formVerificationFieldList:
+        description: Field verification results
+        type: FormVerificationFieldListRepresentation
+      isVerified:
+        description: Flag to get the overall verification status
+        type: boolean
+      retryCount:
+        description: Retry count in case of failed attempt
+        type: integer
+      selectedRecordId:
+        description: Id of the selected record
+        type: string
+      status:
+        description: Field verification results status
+        type: ErrorResponseRepresentation
+  JoinVideoCallInputRepresentation:
+    description: Input representation for JoinVideoCall
+    type: object
+    properties:
+      enableTranscription:
+        description: enable transcription
+        type: boolean
+      externalMeetingId:
+        description: Set External Meeting Id for Video Call
+        type: string
+      region:
+        description: Set Region for Video Call
+        type: string
+      transcriptionType:
+        description: Set transcriptionType
+        type: string
+  JoinVideoCallResultRepresentation:
+    description: Output representation of JoinVideoCall Result
+    type: object
+    properties:
+      attendee:
+        description: JoinVideoCall API attendee information
+        type: ChimeAttendeeResultRepresentation
+        required: false
+      errorMessage:
+        description: JoinVideoCall error messages
+        type: string
+        required: false
+      isSuccess:
+        description: JoinVideoCall success flag
+        type: boolean
+      meeting:
+        description: JoinVideoCall API meeting information
+        type: ChimeMeetingResultRepresentation
+        required: false
+  LeaveVideoCallInputRepresentation:
+    description: Input representation for LeaveVideoCall
+    type: object
+    properties:
+      attendeeId:
+        description: Set Attendee for Video Call
+        type: string
+      externalMeetingId:
+        description: Set External Meeting Id for Video Call
+        type: string
+  LeaveVideoCallResultRepresentation:
+    description: Output representation of LeaveVideoCall Result
+    type: object
+    properties:
+      errorMessage:
+        description: LeaveVideoCall error messages
+        type: string
+        required: false
+      isSuccess:
+        description: LeaveVideoCall success flag
+        type: boolean
+  LinkedObjectFieldsMapInputRepresentation:
+    description: Input representation for Map of LinkedObjectFields
+    type: object
+    properties:
+      linkedObjectFields:
+        description: Set Linked Object Fields.
+        type: object
+        properties:
+          //:
+            type: string
+  NotifyAccessResultRepresentation:
+    description: Output representation of Notify Access
+    type: object
+    properties:
+      accessKey:
+        description: Notify Access Key
+        type: string
+        required: false
+      endpoint:
+        description: Notify Access Endpoint
+        type: string
+        required: false
+      externalUserId:
+        description: Notify Access External User Id
+        type: string
+        required: false
+      keyId:
+        description: Notify Access Key Id
+        type: string
+        required: false
+  PageSpecification:
+    description: Input representation for PageSpecification
+    type: object
+    properties:
+      addToTargetFile:
+        description: set true for split and add to target file
+        type: boolean
+      page:
+        description: set page index, index starts from 1
+        type: integer
+      rotation:
+        description: set page rotation angle
+        type: integer
+  PageSpecificationListInputRepresentation:
+    description: Input representation for list of PageSpecification
+    type: object
+    properties:
+      pageSpecifications:
+        description: Set Page Specifications
+        type: array
+        items:
+          type: object
+  ProcessDefinitionInputRepresentation:
+    description: Input representation for verification process defintion
+    type: object
+    properties:
+      layoutType:
+        description: Layout Type
+        type: string
+      processDetail:
+        description: Process Detail
+        # TODO hand rolled. W-10727777
+        type: ProcessDetailListInputRepresentation
+  ProcessDefinitionOutputRepresentation:
+    description: Representation of a process defintion
+    type: object
+    properties:
+      layoutType:
+        description: Layout type
+        type: string
+      processDetail:
+        description: Process Detail
+        type: array
+        items:
+          type: ProcessDetailOutputRepresentation
+  ProcessDetailInputRepresentation:
+    description: Input representation for process detail
+    type: object
+    properties:
+      apexClassName:
+        description: Apex Class Name
+        type: string
+      dataSourceType:
+        description: Data Source Type
+        type: string
+      developerName:
+        description: Developer Name
+        type: string
+      isRetryAllowedAfterLimit:
+        description: Retry Allowed After Limit
+        type: boolean
+      label:
+        description: Label
+        type: string
+      linkedVerificationProcessDetailName:
+        description: Linked Verification Process Detail Name
+        type: string
+      optionalVerifierCount:
+        description: Optional Verifier Count
+        type: integer
+      retryLimit:
+        description: Retry Limit
+        type: integer
+      searchObjectName:
+        description: Search Object Name
+        type: string
+      searchResultFilter:
+        description: Search Result Filter
+        type: string
+      searchResultSortOrder:
+        description: Search Result Sort Order
+        type: string
+      searchResultUniqueIdField:
+        description: Search Result UniqueId Field
+        type: string
+      searchSequenceNo:
+        description: Search Sequence number
+        type: integer
+      searchType:
+        description: Search Type - SOSL/SOQL
+        type: string
+      verificationProcessFieldList:
+        description: Verification Process Field List
+        # TODO hand rolled. W-10727777
+        type: VerificationProcessFieldListInputRepresentation
+
+  ProcessDetailListInputRepresentation:
+    description: Input representation for list of process detail
+    type: object
+    properties:
+      processDetailList:
+        description: Process Detail List
+        type: array
+        items:
+          # TODO hand rolled. W-10727777
+          type: ProcessDetailInputRepresentation
+  ProcessDetailOutputRepresentation:
+    description: Representation of Process Detail
+    type: object
+    properties:
+      apexClassName:
+        description: Apex Class Name
+        type: string
+      dataSourceType:
+        description: Data Source Type
+        type: string
+      developerName:
+        description: Developer Name
+        type: string
+      isRetryAllowedAfterLimit:
+        description: Retry Allowed After Limit
+        type: boolean
+      label:
+        description: Label
+        type: string
+      linkedVerificationProcessDetailName:
+        description: Linked Verification Process Definition Name
+        type: string
+      optionalVerifierCount:
+        description: Optional Verifier Count
+        type: integer
+      retryLimit:
+        description: Retry Limit
+        type: integer
+      searchObjectName:
+        description: Search Object Name
+        type: string
+      searchResultFilter:
+        description: Search Result Filter
+        type: string
+      searchResultSortOrder:
+        description: Search Result Sort Order
+        type: string
+      searchResultUniqueIdField:
+        description: Search Result Unique Id
+        type: string
+      searchSequenceNo:
+        description: Search Sequence Number
+        type: integer
+      searchType:
+        description: Search Type
+        type: string
+      verificationProcessFieldList:
+        description: List of verification process fields
+        type: VerificationProcessFieldListOutputRepresentation
+  SearchFieldRepresentation:
+    description: Representation of Search Result field
+    type: object
+    properties:
+      developerName:
+        description: Developer Name
+        type: string
+      value:
+        description: Field Value
+        type: string
+  SearchFilterInputRepresentation:
+    description: Input representation of search fields for SOQL search
+    type: object
+    properties:
+      developerName:
+        description: Developer Name
+        type: string
+      value:
+        description: Field Value
+        type: string
+  SearchFilterListInputRepresentation:
+    description: Input representation for Search filters List for SOQL framework
+    type: object
+    properties:
+      searchFilterList:
+        description: Search filter Object List
+        type: array
+        items:
+          # TODO hand rolled. W-10727777
+          type: SearchFilterInputRepresentation
+  SearchInputRepresentation:
+    description: Input representation for Search API
+    type: object
+    properties:
+      searchFilters:
+        description: Search Filter object
+        type: SearchFilterListInputRepresentation
+        #TODO hand rolled W-10727777
+      searchTerm:
+        description: Search Term
+        type: string
+      verificationContext:
+        description: Verification Context
+        type: VerificationContextInputRepresentation
+        # TODO hand rolled. W-10727777
+    # TODO hand rolled. W-10727777. Added the following wrapper manually
+  SearchWrapperInputRepresentation:
+    description: wrapper of SearchInputRepresentation
+    type: object
+    properties:
+      SearchRecordsContextData:
+        description: Input representation for SearchInputRepresentation
+        type: SearchInputRepresentation
+  SearchOutputRepresentation:
+    description: Output representation of Search API for Identity Verification feature
+    type: object
+    properties:
+      isSuccess:
+        description: Search API result success/failure
+        type: boolean
+      message:
+        description: Search API result message
+        type: string
+      searchResult:
+        description: Search API result field list
+        type: array
+        items:
+          type: SearchResultRepresentation
+      searchResultHeader:
+        description: Search API result header field list
+        type: array
+        items:
+          type: SearchResultHeaderRepresentation
+  SearchResultHeaderRepresentation:
+    description: Representation of Search API Result Header
+    type: object
+    properties:
+      dataType:
+        description: Data type of field
+        type: string
+      developerName:
+        description: Field API Name
+        type: string
+      displayLabel:
+        description: Display label for the field
+        type: string
+  SearchResultRepresentation:
+    description: Representation of Search API Result
+    type: object
+    properties:
+      searchFields:
+        description: List of search fields
+        type: array
+        items:
+          type: SearchFieldRepresentation
+  SelectedSearchResultInputRepresentation:
+    description: Input representation for Selected Search Result
+    type: object
+    properties:
+      objectName:
+        description: Object Name
+        type: string
+      selectedRecordId:
+        description: Selected Record Id
+        type: string
+      selectedRecordObject:
+        description: Selected Record Object
+        # TODO hand rolled. W-10727777
+        type: FieldValueListInputRepresentation
+  SelectedSearchResultOutputRepresentation:
+    description: Representation of a selected search result
+    type: object
+    properties:
+      objectName:
+        description: Object Name
+        type: string
+      selectedRecordId:
+        description: Selected Record Id
+        type: string
+      selectedRecordObject:
+        description: Selected Record Object
+        type: array
+        items:
+          type: FieldValueOutputRepresentation
+  SelectedVerifiedResultInputRepresentation:
+    description: Input representation for selected verified result
+    type: object
+    properties:
+      verifiedDetails:
+        description: Verified Details
+        # TODO hand rolled. W-10727777
+        type: VerifiedDetailsListInputRepresentation
+  SelectedVerifiedResultOutputRepresentation:
+    description: Output representation for selected verified result
+    type: object
+    properties:
+      verifiedDetails:
+        description: Verified Details
+        type: array
+        items:
+          type: VerifiedDetailsOutputRepresentation
+  SetupCallInputRepresentation:
+    description: Input representation for SetupCall
+    type: object
+    properties:
+      externalMeetingId:
+        description: Set External Meeting Id for Video Call Setup
+        type: string
+      participantIntakeForm:
+        description: Set Participant Intake Form for Video Call Setup
+        type: object
+        properties:
+          //:
+            type: string
+      relatedRecordId:
+        description: Set Related Record Id for Video Call Setup
+        type: string
+  SetupCallResultRepresentation:
+    description: Output representation of SetupCall Result
+    type: object
+    properties:
+      errorMessage:
+        description: SetupCall error messages
+        type: string
+        required: false
+      isModerator:
+        description: SetupCall moderator flag
+        type: boolean
+        required: false
+      isSuccess:
+        description: SetupCall success flag
+        type: boolean
+      notifyAccess:
+        description: SetupCall Notify Access
+        type: NotifyAccessResultRepresentation
+        required: false
+  TimelineDataGetResultRepresentation:
+    description: Output represantation of Timeline Data from the GET Resource
+    type: object
+    properties:
+      errors:
+        description: TimelineData GET Resource List of Errors
+        type: array
+        items:
+          type: TimelineErrorRepresentation
+      eventTypes:
+        description: TimelineData GET Resource Event Types
+        type: array
+        items:
+          type: TimelineEventTypeRepresentation
+      events:
+        description: TimelineData GET Resource fetch all events
+        type: array
+        items:
+          type: TimelineEventRepresentation
+      hasMoreData:
+        description: TimelineData Get Resource - more Data to be fetched
+        type: boolean
+      isSuccess:
+        description: TimelineData get status flag
+        type: boolean
+  TimelineElementRepresentation:
+    description: Output representation of Fields/related Lists that is returned as
+      part of the GET Timeline metadata
+    type: object
+    properties:
+      apiName:
+        description: Element API Name
+        type: string
+      dataType:
+        description: Element dataType Name
+        type: string
+      label:
+        description: Element label Name
+        type: string
+  TimelineEntityRepresentation:
+    description: Output representation of entity that is returned as part of the GET
+      Timeline metadata
+    type: object
+    properties:
+      ageField:
+        description: TimelineMetadata Age Field
+        type: string
+      entityLabel:
+        description: EntityLabel
+        type: string
+      entityName:
+        description: Entity Name
+        type: string
+      icon:
+        description: Icon
+        type: string
+      isAgeFieldSelected:
+        description: TimelineMetadata age field selected flag
+        type: boolean
+      source:
+        description: Source
+        type: string
+  TimelineErrorRepresentation:
+    description: Error response representation
+    type: object
+    properties:
+      code:
+        description: Code for Error
+        type: string
+      message:
+        description: Message Error
+        type: string
+  TimelineEventFieldRepresentation:
+    description: Output representation of the Event Field that is returned as part
+      of the GET Timeline Data Result
+    type: object
+    properties:
+      name:
+        description: Event Field Name
+        type: string
+      value:
+        description: Event Field Value
+        type: string
+  TimelineEventRepresentation:
+    description: Output representation of the Event that is returned as part of the
+      GET Timeline Data Result
+    type: object
+    properties:
+      description:
+        description: Description of the Event Entity
+        type: string
+      eventDateTime:
+        description: Date Time of the Event
+        type: string
+      fields:
+        description: Fields of the Event
+        type: array
+        items:
+          type: TimelineEventFieldRepresentation
+      id:
+        description: Record Id
+        type: string
+      title:
+        description: Title of the Event Entity
+        type: string
+      type:
+        description: Event Entity Type
+        type: string
+  TimelineEventTypeMetadataRepresentation:
+    description: Output representation of Event Object that is returned as part of
+      the GET Timeline metadata
+    type: object
+    properties:
+      anchorReferenceField:
+        description: Event Object anchor Reference field
+        type: TimelineElementRepresentation
+      entityApiName:
+        description: Event Entity API Name
+        type: string
+      entityLabel:
+        description: Event Entity Label Name
+        type: string
+      fieldsToDisplay:
+        description: Event Object fieldsToDisplay List
+        type: array
+        items:
+          type: TimelineElementRepresentation
+      relatedlistsToDisplay:
+        description: Event Object relatedlistsToDisplay List
+        type: array
+        items:
+          type: TimelineElementRepresentation
+      relationType:
+        description: Event Object relation type
+        type: string
+      sortField:
+        description: Event Object sort field
+        type: TimelineElementRepresentation
+      subTitle:
+        description: Event Object subTitle field
+        type: TimelineElementRepresentation
+      title:
+        description: Event Object title field
+        type: TimelineElementRepresentation
+  TimelineEventTypeRepresentation:
+    description: Output representation of EventType that is returned as part of the
+      GET Timeline Data Result
+    type: object
+    properties:
+      eventApiName:
+        description: Event API Name
+        type: string
+      offset:
+        description: Timeline Data Offset
+        type: integer
+  TimelineMetadataDefinitionRepresentation:
+    description: Output representation of Timeline Metadata from the GET Resource
+    type: object
+    properties:
+      anchorObject:
+        description: TimelineMetadata Anchor Object
+        type: TimelineEntityRepresentation
+      eventTypes:
+        description: TimelineMetadata GET Resource fetch all event objects
+        type: array
+        items:
+          type: TimelineEventTypeMetadataRepresentation
+      fullName:
+        description: TimelineMetadata Configuration Name
+        type: string
+      isActive:
+        description: TimelineMetadata active status flag
+        type: boolean
+      masterLabel:
+        description: TimelineMetadata Configuration Label
+        type: string
+  TimelineMetadataResultRepresentation:
+    description: Output representation of Timeline Metadata from the GET Resource
+    type: object
+    properties:
+      definitions:
+        description: TimelineMetadata GET Resource fetch all definitions
+        type: array
+        items:
+          type: TimelineMetadataDefinitionRepresentation
+      errors:
+        description: TimelineMetadata GET Resource List of Errors
+        type: array
+        items:
+          type: TimelineErrorRepresentation
+      status:
+        description: TimelineMetadata get status
+        type: string
+  UpdateVideoCallInputRepresentation:
+    description: Input representation for UpdateVideoCall
+    type: object
+    properties:
+      isEnded:
+        description: Set whether Video Call is ended or not
+        type: boolean
+      meetingId:
+        description: Set Meeting Id for Video Call update
+        type: string
+  UpdateVideoCallResultRepresentation:
+    description: Output representation of UpdateVideoCall Result
+    type: object
+    properties:
+      errorMessage:
+        description: UpdateVideoCall error messages
+        type: string
+        required: false
+      isSuccess:
+        description: UpdateVideoCall success flag
+        type: boolean
+  ValidateSignatureInputRepresentation:
+    description: Input representation for ValidateSignature
+    type: object
+    properties:
+      signature:
+        description: The signature to be validated
+        type: string
+  ValidateSignatureResultRepresentation:
+    description: Output representation of ValidateSignature
+    type: object
+    properties:
+      errorMessage:
+        description: ValidateSignature error messages
+        type: string
+        required: false
+      externalMeetingId:
+        description: The external meeting id for the supplied signature
+        type: string
+        required: false
+      isValid:
+        description: ValidateSignature valid flag
+        type: boolean
+  VerificationContextInputRepresentation:
+    description: Input representation for verification context
+    type: object
+    properties:
+      processDefinition:
+        description:
+          Process Definition
+          # TODO hand rolled. W-10727777
+        type: ProcessDefinitionInputRepresentation
+      selectedSearchResult:
+        description: Selected Search Result
+        # TODO hand rolled. W-10727777
+        type: SelectedSearchResultInputRepresentation
+      selectedVerifiedResult:
+        description: Selected Verified Result
+        type: SelectedVerifiedResultInputRepresentation
+        # TODO hand rolled. W-10727777
+      verifiedResult:
+        description: Verified Result
+        # TODO hand rolled. W-10727777
+        type: VerifiedResultInputRepresentation
+    # TODO hand rolled. W-10727777. Added the following wrapper manually
+  VerificationContextWrapperInputRepresentation:
+    description: wrapper of VerificationContextInputRepresentation
+    type: object
+    properties:
+      IdentityVerificationContextData:
+        description: Input representation for VerificationContextInputRepresentation
+        type: VerificationContextInputRepresentation
+  VerificationContextOutputRepresentation:
+    description: Representation of Verification Context
+    type: object
+    properties:
+      isSuccess:
+        description: API result success/failure
+        type: boolean
+      message:
+        description: API result message
+        type: string
+      processDefinition:
+        description: Process Definition
+        type: ProcessDefinitionOutputRepresentation
+      selectedSearchResult:
+        description: Selected Search Result
+        type: SelectedSearchResultOutputRepresentation
+      selectedVerifiedResult:
+        description: Selected Verified Result
+        type: SelectedVerifiedResultOutputRepresentation
+      verifiedResult:
+        description: Verified Result
+        type: VerifiedResultOutputRepresentation
+  VerificationProcessFieldInputRepresentation:
+    description: Input representation for verification process field
+    type: object
+    properties:
+      dataSourceType:
+        description: Data Source Type - Salesforce/External
+        type: string
+      dataType:
+        description: Data type
+        type: string
+      developerName:
+        description: Developer Name
+        type: string
+      fieldName:
+        description: Field Name
+        type: string
+      fieldType:
+        description: Field Type
+        type: string
+      fieldValueFormula:
+        description: Field Value Formula
+        type: string
+      isManualInput:
+        description: Is Manual Input
+        type: boolean
+      label:
+        description: Label value
+        type: string
+  VerificationProcessFieldListInputRepresentation:
+    description: Input representation for list of verification process field
+    type: object
+    properties:
+      verificationProcessFields:
+        description: List of verificationProcessField
+        type: array
+        items:
+          # TODO hand rolled. W-10727777
+          type: VerificationProcessFieldInputRepresentation
+  VerificationProcessFieldListOutputRepresentation:
+    description: List of Verification Process Field
+    type: object
+    properties:
+      verificationProcessFields:
+        description: Verification Process Fields
+        type: array
+        items:
+          type: VerificationProcessFieldOutputRepresentation
+  VerificationProcessFieldOutputRepresentation:
+    description: Verification Process Field Output
+    type: object
+    properties:
+      dataSourceType:
+        description: Data Source Type
+        type: string
+      dataType:
+        description: Data Type
+        type: string
+      developerName:
+        description: Developer Name
+        type: string
+      fieldName:
+        description: Field Name
+        type: string
+      fieldType:
+        description: Field Type
+        type: string
+      fieldValueFormula:
+        description: Field Value Formula
+        type: string
+      isManualInput:
+        description: Is Manual Input
+        type: boolean
+      label:
+        description: Label
+        type: string
+  VerifiedDetailsInputRepresentation:
+    description: Input representation for verified details
+    type: object
+    properties:
+      label:
+        description: Label
+        type: string
+      processDetailName:
+        description: Process Detail Name
+        type: string
+      searchObjectName:
+        description: Search Object Name
+        type: string
+      verifiedId:
+        description: Verified Id
+        type: string
+  VerifiedDetailsListInputRepresentation:
+    description: Input representation for verified details
+    type: object
+    properties:
+      verifiedDetailsList:
+        description: Verified Details List
+        type: array
+        items:
+          # TODO hand rolled. W-10727777
+          type: VerifiedDetailsInputRepresentation
+
+  VerifiedDetailsOutputRepresentation:
+    description: Output representation for verified details
+    type: object
+    properties:
+      label:
+        description: Label
+        type: string
+      processDetailName:
+        description: Process Detail Name
+        type: string
+      searchObjectName:
+        description: Search Object Name
+        type: string
+      verifiedId:
+        description: Verified Id
+        type: string
+  VerifiedResultInputRepresentation:
+    description: Input representation for verifier result
+    type: object
+    properties:
+      optionalVerifiers:
+        description: Optional Verifiers
+        type: VerifierListInputRepresentation
+        # TODO hand rolled. W-10727777
+      requiredVerifiers:
+        description: Required Verifiers
+        type: VerifierListInputRepresentation
+        # TODO hand rolled. W-10727777
+  VerifiedResultOutputRepresentation:
+    description: Representation of a Verified result
+    type: object
+    properties:
+      optionalVerifiers:
+        description: Optional Verifiers
+        type: array
+        items:
+          type: VerifierOutputRepresentation
+      requiredVerifiers:
+        description: Required Verifiers
+        type: array
+        items:
+          type: VerifierOutputRepresentation
+  VerifierInputRepresentation:
+    description: Input representation for verifier fields
+    type: object
+    properties:
+      developerName:
+        description: Developer Name
+        type: string
+      verificationState:
+        description: Verification State
+        type: string
+  VerifierListInputRepresentation:
+    description: Input representation for verifier result
+    type: object
+    properties:
+      verifiersList:
+        description: Verifiers List
+        type: array
+        items:
+          type: VerifierInputRepresentation
+        # TODO hand rolled. W-10727777
+  VerifierOutputRepresentation:
+    description: Representation of a Verifier
+    type: object
+    properties:
+      developerName:
+        description: Developer Name
+        type: string
+      verificationState:
+        description: Verification State
+        type: string
+  VideoCallParticipantFieldRepresentation:
+    description: Output representation of video call participant fields
+    type: object
+    properties:
+      contactFieldValue:
+        description: Field value from the contact record
+        type: string
+      doesFieldValuesMatch:
+        description: Returns true when the field values from contact and intake form
+          are same
+        type: boolean
+      fieldLabel:
+        description: Field label
+        type: string
+      intakeFormFieldValue:
+        description: Field value from the intake form submitted by guest
+        type: string
+  VideoCallParticipantRepresentation:
+    description: Output representation of video call participant
+    type: object
+    properties:
+      fields:
+        description: List of video call participant fields with values from contact
+          and intake form
+        type: array
+        items:
+          type: VideoCallParticipantFieldRepresentation
+      participantId:
+        description: Participant id
+        type: string
+      participantName:
+        description: Participant name
+        type: string
+  VideoCallParticipantResultRepresentation:
+    description: Output representation of VideoCallParticipant
+    type: object
+    properties:
+      inCallParticipants:
+        description: List of participants who are admitted to the call
+        type: array
+        items:
+          type: VideoCallParticipantRepresentation
+      waitingParticipants:
+        description: List of participants in the waiting room
+        type: array
+        items:
+          type: VideoCallParticipantRepresentation
+/connect:
+  /document-automation/contentDocuments/{contentDocumentId}/linkedObjects/{linkedObjectId}:
+    post:
+      description: API to edit Document and link object
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DocumentManagementResultRepresentation
+      body:
+        application/json:
+          type: DocumentManagementInputRepresentation
+          #   required: false Hand Rolled Change that removed 'required: false' W-10727777
+          (oas-body-name): DocumentManagementInput
+    uriParameters:
+      contentDocumentId:
+        type: string
+        required: true
+      linkedObjectId:
+        type: string
+        required: true
+  /identity-verification:
+    /build-context/{processDefinitionName}:
+      post:
+        description: API to build context entity needed for all Identity Verification
+          services
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: VerificationContextOutputRepresentation
+        body:
+          application/json:
+            type: BuildVerificationContextWrapperInputRepresentation
+            # TODO hand rolled. W-10727777. Added the wrapper manually
+            # TODO  Hand Rolled Change that removed 'required: false' W-10727777
+            (oas-body-name): BuildContextData
+      uriParameters:
+        processDefinitionName:
+          type: string
+          required: true
+    /input-verification:
+      post:
+        description: API to verify a given record with customer inputs
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: FormVerificationOutputRepresentation
+        body:
+          application/json:
+            type: FormVerificationInputRepresentation
+            # TODO  Hand Rolled Change that removed 'required: false' W-10727777
+            (oas-body-name): IdentityVerificationFormInputData
+    /search:
+      post:
+        description: API to search records for Identity Verification service
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SearchOutputRepresentation
+        body:
+          application/json:
+            type: SearchWrapperInputRepresentation
+            # TODO hand rolled. W-10727777. Added the wrapper manually
+            # TODO  Hand Rolled Change that removed 'required: false' W-10727777
+            (oas-body-name): SearchRecordsContextData
+    /verification:
+      post:
+        description: API to verify a given record
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: VerificationContextOutputRepresentation
+        body:
+          application/json:
+            type: VerificationContextWrapperInputRepresentation
+            # TODO hand rolled. W-10727777. Added the wrapper manually
+            # TODO  Hand Rolled Change that removed 'required: false' W-10727777
+            (oas-body-name): IdentityVerificationContextData
+  /industries/video-call:
+    post:
+      description: Setup VideoCall API Resource
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SetupCallResultRepresentation
+      body:
+        application/json:
+          type: SetupCallInputRepresentation
+          #   required: false
+          (oas-body-name): SetupCallInput
+    put:
+      description: Update a video call
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: UpdateVideoCallResultRepresentation
+      body:
+        application/json:
+          type: UpdateVideoCallInputRepresentation
+          #   required: false
+          (oas-body-name): UpdateVideoCallInput
+    /join-call:
+      post:
+        description: JoinVideoCall API Resource
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: JoinVideoCallResultRepresentation
+        body:
+          application/json:
+            type: JoinVideoCallInputRepresentation
+            # required: false
+            (oas-body-name): JoinVideoCallInput
+    /leave-call:
+      put:
+        description: LeaveVideoCall API Resource
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LeaveVideoCallResultRepresentation
+        body:
+          application/json:
+            type: LeaveVideoCallInputRepresentation
+            # required: false
+            (oas-body-name): LeaveVideoCallInput
+    /participant:
+      get:
+        description: API to get Participant data
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: VideoCallParticipantResultRepresentation
+        queryParameters:
+          includeParticipantFields:
+            type: boolean
+            required: false
+          meetingId:
+            type: string
+            required: false
+      put:
+        description: EvaluateVideoCallParticipant API Resource
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EvaluateVideoCallParticipantResultRepresentation
+        body:
+          application/json:
+            type: EvaluateVideoCallParticipantInputRepresentation
+            # required: false
+            (oas-body-name): EvaluateVideoCallParticipantInput
+    /validate-signature:
+      post:
+        description: ValidateSignature API Resource
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ValidateSignatureResultRepresentation
+        body:
+          application/json:
+            type: ValidateSignatureInputRepresentation
+            # required: false
+            (oas-body-name): ValidateSignatureInput
+  /timeline:
+    /metadata/configurations:
+      get:
+        description: API to get Timeline metadata
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: TimelineMetadataResultRepresentation
+        queryParameters:
+          fullNames:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+    /{timelineObjRecordId}/timeline-definitions/{timelineConfigFullName}/events:
+      get:
+        description: API to get Timeline data
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: TimelineDataGetResultRepresentation
+        queryParameters:
+          direction:
+            type: string
+            required: false
+          endDate:
+            type: string
+            required: false
+          eventTypeOffsets:
+            type: string
+            required: false
+          eventTypes:
+            type: string
+            required: false
+          startDate:
+            type: string
+            required: false
+      uriParameters:
+        timelineConfigFullName:
+          type: string
+          required: true
+        timelineObjRecordId:
+          type: string
+          required: true