@salesforce/lds-adapters-industries-docgen 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,1423 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '65.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.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:
+  ClauseCategoriesResponse:
+    description: API Response Representation for Getting Clause Lib Category Config
+    type: object
+    properties:
+      clauseCategories:
+        description: This attribute is for list of category config
+        type: array
+        items:
+          type: ClauseCategoryResponse
+  ClauseCategoryResponse:
+    description: API Response Representation for Field Level info for clause category
+    type: object
+    properties:
+      id:
+        description: This attribute contains Id for custom clause config
+        type: string
+        required: false
+      name:
+        description: This attribute contains name for clause config
+        type: string
+      usageType:
+        description: This attribute contains usageType for clause config
+        type: string
+  ContentLinkDataSyncDetailRepresentation:
+    description: Output representation containing the details of the data sync to
+      salesforce Objects.
+    type: object
+    properties:
+      contentLinkId:
+        description: Record ID of the content link.
+        type: string
+      failureReason:
+        description: Failure reason.
+        type: string
+      isSuccess:
+        description: Flag representing if the data sync validation was successful.
+        type: boolean
+      value:
+        description: Represents the data for the content.
+        type: string
+  ContentLinkDataSyncInputRepresentation:
+    description: Input representation of the request to sync dataTrueUp token data
+      from the document to salesforce objects
+    type: object
+    properties:
+      contentLinkDetailsList:
+        description: List of content link details.
+        type: array
+        items:
+          type: any
+      partialCommit:
+        description: Is commit required in case of partial success.
+        type: boolean
+      referenceObjectId:
+        description: ID of the reference object to fetch the content data from.
+        type: string
+  ContentLinkDataSyncOutputRepresentation:
+    description: Output representation containing the successful and unsuccessful
+      details of Data Sync action.
+    type: object
+    properties:
+      failedContentLinkDataList:
+        description: List of failed contentLink details
+        type: array
+        items:
+          type: ContentLinkDataSyncDetailRepresentation
+      referenceObjectId:
+        description: Reference object id
+        type: string
+      saveCommitted:
+        description: Flag representing if the successful transactions are committed.
+        type: boolean
+      successContentLinkDataList:
+        description: List of successful contentLink details
+        type: array
+        items:
+          type: ContentLinkDataSyncDetailRepresentation
+  ContentLinkDetailRepresentation:
+    description: Output representation containing the content link details for the
+      given reference IDs.
+    type: object
+    properties:
+      content:
+        description: Represents the data for the content.
+        type: string
+      contentLinkId:
+        description: Record ID of the content link data.
+        type: string
+  ContentLinkInputRepresentation:
+    description: Input representation of the request to fetch the content token data
+      from the ContentLink object.
+    type: object
+    properties:
+      contentLinkIds:
+        description: List of the content link IDs to fetch the data for.
+        type: array
+        items:
+          type: string
+      referenceObjectId:
+        description: ID of the reference object to fetch the content data from.
+        type: string
+  ContentLinkListRepresentation:
+    description: Output representation containing the content data for the specified
+      reference IDs.
+    type: object
+    properties:
+      contentLinkDataList:
+        description: List of content links.
+        type: array
+        required: false
+        items:
+          type: ContentLinkDetailRepresentation
+      failedContentLinkList:
+        description: List of failed content links.
+        type: array
+        required: false
+        items:
+          type: FailedContentLinkListRepresentation
+      referenceObjectId:
+        description: Reference object id
+        type: string
+  DocumentClauseFieldsResponse:
+    description: Output Representation for List of Document Clause Fields
+    type: object
+    properties:
+      extendedFields:
+        description: Document Clause fields value based on field Name parameter
+        type: any
+      fieldValues:
+        description: Document Clause fields value based on field Name parameter
+        type: array
+        items:
+          type: string
+  DocumentClausePromotionRequest:
+    description: Input representation of a clause promotion request
+    type: object
+    properties:
+      clauseContent:
+        description: Content of the clause
+        type: string
+      clauseDescription:
+        description: Description of the clause
+        type: string
+      clauseName:
+        description: Name of the clause
+        type: string
+      clauseSetId:
+        description: ID of the clauseSet in which this clause should be added
+        type: string
+      isAlternateClause:
+        description: Whether the clause is alternate or main within the clause set
+        type: boolean
+      language:
+        description: Language of the clause
+        type: string
+      nonStandardClauseRecordId:
+        description: Record ID of the non-standard clause which needs to be promoted
+        type: string
+      notifyOnCompletion:
+        description: Whether to notify the user once the clause is promoted to the
+          library
+        type: boolean
+  DocumentClausePromotionResponse:
+    description: API Response Representation for Document Clause promotion
+    type: object
+    properties:
+      isSuccess:
+        description: whether request is submitted or not
+        type: boolean
+      message:
+        description: error/warning message if any
+        type: string
+  DocumentClauseSetListResponse:
+    description: Output Representation for List of Clause Set
+    type: object
+    properties:
+      documentClauseSets:
+        description: List of Document Clause Set
+        type: array
+        items:
+          type: DocumentClauseSetResponse
+  DocumentClauseSetResponse:
+    description: Output Representation of Clause Set
+    type: object
+    properties:
+      category:
+        description: Specifies the category of the Document Clause Set.
+        type: string
+      categoryName:
+        description: Specifies the Category Name of the Document Clause Set.
+        type: string
+      defaultLanguage:
+        description: Specifies the default language of the Document Clause Set.
+        type: string
+      id:
+        description: Id of Document Clause Set
+        type: string
+      name:
+        description: The name of the Document Clause Set.
+        type: string
+      status:
+        description: Specifies the status of the Document Clause Set such as Draft,
+          Active, or Archived.
+        type: string
+  DocumentCompareInputRepresentation:
+    description: Input representation to get comparison document of the specified
+      content versions
+    type: object
+    properties:
+      baseDocumentId:
+        description: Base Document Id
+        type: string
+      baseDocumentSourceType:
+        description: Base Document source type
+        type: string
+      compareToDocumentId:
+        description: CompareTo Document Id
+        type: string
+      compareToDocumentSourceType:
+        description: Compare to Document source type
+        type: string
+  DocumentCompareOutputRepresentation:
+    description: API Response Representation for Compare Document
+    type: object
+    properties:
+      compareDocumentId:
+        description: Document Id of the generated Compare Document
+        type: string
+      compareDocumentSourceType:
+        description: Source type of the generated Compare Document
+        type: string
+  DocumentListResponse:
+    description: Document record list
+    type: object
+    properties:
+      documents:
+        description: List of Documents associated to the sourceObjectId
+        type: array
+        required: false
+        items:
+          type: DocumentResponse
+  DocumentResponse:
+    description: Document record
+    type: object
+    properties:
+      additionalFields:
+        description: Additional fields related to document for custom implementation
+        type: object
+        required: false
+        properties:
+          //:
+            type: string
+      fileExtension:
+        description: The fileExtension of Document
+        type: string
+        required: false
+      name:
+        description: The name of Document
+        type: string
+        required: false
+      sourceId:
+        description: The sourceId of Document
+        type: string
+        required: false
+      sourceType:
+        description: The sourceType of Document
+        type: string
+        required: false
+  EnvelopeSendAnchorRequest:
+    description: Input Request representation to get send for esignature details from
+      API
+    type: object
+    properties:
+      anchorString:
+        description: Anchor String
+        type: string
+      signerRole:
+        description: SignerRole
+        type: integer
+      tabType:
+        description: tabType
+        type: string
+  EnvelopeSendAnchorsRequest:
+    description: Input Request representation to get send for esignature details from
+      API
+    type: object
+    properties:
+      anchors:
+        description: Anchor List
+        type: array
+        items:
+          type: object
+  EnvelopeSendDocumentsRequest:
+    description: Input representation to get Document details for esign
+    type: object
+    properties:
+      documentId:
+        description: documentId
+        type: string
+      fileExtension:
+        description: fileExtension
+        type: string
+      name:
+        description: ' Name'
+        type: string
+      sourceId:
+        description: sourceId
+        type: string
+      sourceType:
+        description: sourceType
+        type: string
+  EnvelopeSendEmailNotificationRequest:
+    description: Input representation to get Email Notification Details
+    type: object
+    properties:
+      emailBody:
+        description: emailBody
+        type: string
+      emailSubject:
+        description: emailSubject
+        type: string
+      supportedLanguage:
+        description: supportedLanguage
+        type: string
+  EnvelopeSendEmailSettingsRequest:
+    description: EmailSettings representation to get Email details from API
+    type: object
+    properties:
+      emailBody:
+        description: Email Body
+        type: string
+      emailSubject:
+        description: Email Subject
+        type: string
+  EnvelopeSendNotificationExpirationsRequest:
+    description: Input representation to get Notification Expiration info
+    type: object
+    properties:
+      expireAfter:
+        description: expireAfter
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      expireEnabled:
+        description: expireEnabled
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      expireWarn:
+        description: expireWarn
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  EnvelopeSendNotificationRemindersRequest:
+    description: Input representation to get Notification Reminder info for esign
+      document
+    type: object
+    properties:
+      reminderDelay:
+        description: Reminder Delay
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      reminderEnabled:
+        description: Reminder Enabled
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      reminderFrequency:
+        description: Reminder Frequency
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  EnvelopeSendNotificationRequest:
+    description: Input representation to get Notification Information for Esign
+    type: object
+    properties:
+      expirations:
+        description: expirations
+        type: object
+        required: false # TODO Hand-rolled W-9314597
+      reminders:
+        description: reminders
+        type: object
+        required: false # TODO Hand-rolled W-9314597
+      useAccountDefaults:
+        description: useAccountDefaults
+        type: boolean
+        required: false # TODO Hand-rolled W-9314597
+  EnvelopeSendRecipientDetailRequest:
+    description: Input representation to get Recipient Details
+    type: object
+    properties:
+      accessCode:
+        description: Access Code
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      email:
+        description: Email address of the Signer
+        type: string
+      emailNotification:
+        description: Email Notifications
+        type: object
+        required: false # TODO Hand-rolled W-9314597
+      id:
+        description: Recipient Id
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      name:
+        description: Name
+        type: string
+      parentSignerName:
+        description: Parent Signer Name for Inperson Signers
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      phone:
+        description: Phone number of the Signer
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      recipientId:
+        description: Recipient Id
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      recipientLocale:
+        description: Recipient Locale
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      recipientType:
+        description: Recipient Type
+        type: string
+      routingNumber:
+        description: Routing Number
+        type: integer
+        required: false # TODO Hand-rolled W-9314597
+      routingOrder:
+        description: Routing Order
+        type: integer
+        required: false # TODO Hand-rolled W-9314597
+      signerRole:
+        description: Signer Role
+        type: integer
+        required: false # TODO Hand-rolled W-9314597
+      title:
+        description: Title of the Signer
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  EnvelopeSendRecipientsRequest:
+    description: Input representation to get Different Recipients List
+    type: object
+    properties:
+      carbonCopies:
+        description: Carbon Copy User Details
+        type: array
+        required: false # TODO Hand-rolled W-9314597
+        items:
+          type: object
+      certifiedDeliveries:
+        description: Certificate deliveries Details
+        type: array
+        required: false # TODO Hand-rolled W-9314597
+        items:
+          type: object
+      inPersonSigners:
+        description: In Person Signer Details
+        type: array
+        required: false # TODO Hand-rolled W-9314597
+        items:
+          type: object
+      signers:
+        description: Signer details
+        type: array
+        items:
+          type: object
+  EnvelopeSendRequest:
+    description: Input Request representation to get send for esignature details from
+      API
+    type: object
+    properties:
+      documents:
+        description: Documents
+        type: array
+        items:
+          type: object
+      emailSettings:
+        description: Email Settings
+        type: object
+      notificationSettings:
+        description: Notification
+        type: object
+      parentId:
+        description: Object Id
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      recipients:
+        description: Esign Recipients
+        type: object
+      vendor:
+        description: Vendor Name
+        type: string
+  EnvelopeSendResponse:
+    description: API Response Representation for Send Envelop to vendor
+    type: object
+    properties:
+      envelopeId:
+        description: This attribute contains Envelope Id for the ongoing Docusign
+          Transaction
+        type: string
+      envelopeStatus:
+        description: This attribute contains Envelope Status for the ongoing Docusign
+          Transaction
+        type: string
+        required: false
+  EnvelopeStatusListResponse:
+    description: Output representation of Update Envelope related details
+    type: object
+    properties:
+      signatureStatus:
+        description: List of all envelope IDs and their other details including their
+          status whether the envelope was successfully
+        type: array
+        items:
+          type: EnvelopeStatusResponse
+      sourceObjectId:
+        description: ID of the parent object
+        type: string
+      totalEnvelopesToBeUpdated:
+        description: Total number of envelopes to be updated
+        type: integer
+      totalEnvelopesUpdated:
+        description: Actual count of envelopes updated
+        type: integer
+  EnvelopeStatusResponse:
+    description: Update Envelope Status Record
+    type: object
+    properties:
+      envelopeId:
+        description: ID of the envelope
+        type: string
+      error:
+        description: Error code corresponding to the envelope ID
+        type: string
+        required: false
+      errorMessage:
+        description: Error message corresponding to the envelope ID
+        type: string
+        required: false
+      status:
+        description: Updated envelope status
+        type: string
+      success:
+        description: Status whether the envelope was successfully updated or not
+        type: boolean
+  EnvelopeVoidRequest:
+    description: Input representation to get Void Envelope related details
+    type: object
+    properties:
+      senderEmail:
+        description: Refers to the email of the user who initiated the voiding
+        type: string
+      voidedReason:
+        description: Reason for which the envelope is being voided
+        type: string
+  EnvelopeVoidResponse:
+    description: Output representation of Void Envelope related details
+    type: object
+    properties:
+      failedEnvelopeList:
+        description: List envelopes that failed to void and their details
+        type: array
+        items:
+          type: EnvelopeStatusResponse
+      sourceObjectId:
+        description: ID of the parent object
+        type: string
+      successfulEnvelopeIds:
+        description: ID of envelopes successfully voided
+        type: array
+        items:
+          type: string
+      totalEnvelopesToBeVoided:
+        description: Total number of envelopes to be voided
+        type: integer
+      totalEnvelopesVoided:
+        description: Actual count of envelopes voided
+        type: integer
+  FailedContentLinkListRepresentation:
+    description: Output representation containing the content ID and error details
+      for the failed requests.
+    type: object
+    properties:
+      failedContentLinkId:
+        description: ID of the content link associated with the failure.
+        type: string
+      failureReason:
+        description: Reason for failure of the API request to fetch the content link.
+        type: string
+  GenericOutputRepresentation:
+    description: Generic Output Representation
+    type: object
+    properties:
+      id:
+        description: id
+        type: string
+      isSuccess:
+        description: API success status
+        type: boolean
+        required: false
+  NotificationExpirationResponse:
+    description: E-Signature Notification Expiration Settings
+    type: object
+    properties:
+      expireAfter:
+        description: The expireAfter for NotificationExpirationSetting
+        type: integer
+        required: false
+      expireEnabled:
+        description: The expireEnabled flag for NotificationExpirationSetting
+        type: boolean
+        required: false
+      expireWarn:
+        description: The expireWarn for NotificationExpirationSetting
+        type: integer
+        required: false
+  NotificationReminderResponse:
+    description: E-Signature Notification Reminder Settings
+    type: object
+    properties:
+      reminderDelay:
+        description: The reminderDelay for NotificationReminderSetting
+        type: integer
+        required: false
+      reminderEnabled:
+        description: The reminderEnabled flag for NotificationReminderSetting
+        type: boolean
+        required: false
+      reminderFrequency:
+        description: The reminderFrequency for NotificationReminderSetting
+        type: integer
+        required: false
+  NotificationSettingResponse:
+    description: Output representation of E-Signature Notification Settings
+    type: object
+    properties:
+      expirations:
+        description: The expirations settings for NotificationSetting
+        type: NotificationExpirationResponse
+        required: false
+      reminders:
+        description: The reminder settings for NotificationSetting
+        type: NotificationReminderResponse
+        required: false
+      useAccountDefaults:
+        description: The useAccountDefaults flag for NotificationSetting
+        type: boolean
+        required: false
+  RecipientListResponse:
+    description: Recipient List
+    type: object
+    properties:
+      recipients:
+        description: List of recipients
+        type: array
+        required: false
+        items:
+          type: RecipientResponse
+  RecipientResponse:
+    description: Recipient
+    type: object
+    properties:
+      additionalFields:
+        description: Recipient additional fields
+        type: object
+        required: false
+        properties:
+          //:
+            type: string
+      email:
+        description: Recipient email
+        type: string
+        required: false
+      id:
+        description: Recipient id
+        type: string
+        required: false
+      name:
+        description: Recipient name
+        type: string
+        required: false
+  SignerRolesResponse:
+    description: Signer Roles
+    type: object
+    properties:
+      signerRoles:
+        description: List of signer roles
+        type: array
+        required: false
+        items:
+          type: string
+    # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  EnvelopeVoidRequestWrapper:
+    description: Wrapper for EnvelopeVoidRequest
+    type: object
+    properties:
+      voidParam:
+        type: EnvelopeVoidRequest
+        description: An Input Representation for void envelope
+  # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  EnvelopeSendRequestWrapper:
+    description: Wrapper for EnvelopeSendRequest
+    type: object
+    properties:
+      envelope:
+        type: EnvelopeSendRequest
+        description: An Input Representation for send envelope
+  DocumentTemplateUpdateInputRepresentation:
+    description: Input representation to update document template
+    type: object
+    properties:
+      contentDocumentId:
+        description: ID of the Document associated with a document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      documentGenerationMechanism:
+        description: Specifies the method for generating the document
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      extractOmniDataTransformName:
+        description: The name of the OmniDataTransform bundle of the extract type
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      isActive:
+        description: Indicates whether the document template set to active/inactive
+        type: boolean
+        required: false # TODO Hand-rolled W-9314597
+      mapperOmniDataTransformName:
+        description: The name of the OmniDataTransform bundle of the mapper type
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      status:
+        description: Specifies the status to be set for the document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      tokenList:
+        description: List of token present in document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      tokenMappingMethodType:
+        description: Specifies the processing method for the data which can come from
+          same source object
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      usageType:
+        description: The UsageType of the document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      shouldDisplayUnmappedToken:
+        description: Indicates whether the document template unmapped tokens be displayed or not
+        type: boolean
+        required: false # TODO Hand-rolled W-9314597
+      contextDefinitionName:
+        description: The name of the context definition that contains the mapping details used for extraction in the Context Service token mapping type
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      contextMappingName:
+        description: The name of the context mapping used for extraction in the Context Service token mapping type
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  DocumentTemplateRequest:
+    description: Input representation of a document template resource
+    type: object
+    properties:
+      contentDocumentId:
+        description: ID of the Document associated with a document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      documentGenerationMechanism:
+        description: Specifies the method for generating the document
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      extractOmniDataTransformName:
+        description: The name of the OmniDataTransform bundle of the extract type
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      mapperOmniDataTransformName:
+        description: The name of the OmniDataTransform bundle of the mapper type
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      name:
+        description: Name of the document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      shouldExtractEmbeddedTmplToken:
+        description: Indicates whether tokens from all the templates embedded within
+          the document template must be extracted
+        type: boolean
+        required: false # TODO Hand-rolled W-9314597
+      status:
+        description: Specifies the status of the document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      tokenList:
+        description: List of token present in document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      tokenMappingMethodType:
+        description: Specifies the processing method for the data which can come from
+          same source object
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      tokenMappingType:
+        description: Specifies the mapping type for tokens of the document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      type:
+        description: Specifies the type of document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      usageType:
+        description: Specifies the document template usage
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      versionNumber:
+        description: Version of document template
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      xmlRelationshipMetadata:
+        description: The WML relationship metadata
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      contextDefinitionName:
+        description: The name of the context definition that contains the mapping details used for extraction in the Context Service token mapping type
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      contextMappingName:
+        description: The name of the context mapping used for extraction in the Context Service token mapping type
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  DocumentTemplateRepresentation:
+    description: DocumentTemplate record
+    type: object
+    properties:
+      documentTemplateId:
+        description: The record Id of DocumentTemplate
+        type: string
+  DocumentTemplateListRepresentation:
+    description: API Response Representation for DocumentTemplate List
+    type: object
+    properties:
+      data:
+        description: List of DocumentTemplateParent record
+        type: array
+        required: false
+        items:
+          type: DocumentTemplateParentRepresentation
+      next:
+        description: The url of next page record for pagination
+        type: string
+        required: false
+      totalRecord:
+        description: Total number of record fetched
+        type: integer
+        required: false
+  DocumentTemplateParentRepresentation:
+    description: DocumentTemplateParent record
+    type: object
+    properties:
+      hasMoreVersions:
+        description: Indicated if DocumentTemplateParent has more Draft and Archive
+          versions
+        type: boolean
+        required: false
+      isActive:
+        description: IsActive status of DocumentTemplateParent
+        type: boolean
+      lastModifiedDate:
+        description: The lastModifiedDate of DocumentTemplateParent
+        type: string
+      name:
+        description: The name of DocumentTemplateParent
+        type: string
+      namespace:
+        description: Namespace associated with DocumentTemplateParent
+        type: string
+        required: false
+      type:
+        description: The type of DocumentTemplateParent
+        type: string
+      usageType:
+        description: The usageType of DocumentTemplateParent
+        type: string
+        required: false
+      versions:
+        description: List of versions associated to DocumentTemplateParent
+        type: array
+        items:
+          type: DocumentTemplateChildRepresentation
+  DocumentTemplateChildRepresentation:
+    description: DocumentTemplateChild record
+    type: object
+    properties:
+      id:
+        description: The id of DocumentTemplate
+        type: string
+      lastModified:
+        description: The lastModified date of DocumentTemplate
+        type: string
+      name:
+        description: The name of DocumentTemplate
+        type: string
+      status:
+        description: The status of DocumentTemplate
+        type: string
+  DocGenConfigDataRepresentation:
+    description: Represents the DocGen config data
+    type: object
+    properties:
+      configData:
+        description: Config data
+        type: any
+      configType:
+        description: Config type
+        type: string
+  DocGenConfigInputRepresentation:
+    description: Input representation to get DocGen configs
+    type: object
+    properties:
+      configInput:
+        description: Config Input
+        type: any
+        required: false
+      configType:
+        description: Config type
+        type: string
+  DocGenConfigOutputRepresentation:
+    description: API Response Representation for DocGen config
+    type: object
+    properties:
+      data:
+        description: Represents the config response data.
+        type: DocGenConfigDataRepresentation
+      status:
+        description: Represents the status of API response.
+        type: string
+  DocPreviewInputRepresentation:
+    description: Input representation to get document previews
+    type: object
+    properties:
+      communityId:
+        description: Community id
+        type: string
+        required: false
+      endPageNumber:
+        description: End page number
+        type: integer
+        required: false
+      fileId:
+        description: ContentDocument id
+        type: string
+        required: true
+      previewFormat:
+        description: Preview format
+        type: string
+        required: true
+      startPageNumber:
+        description: Start page number
+        type: integer
+        required: false
+      versionNumber:
+        description: Version number
+        type: integer
+        required: false
+  DocPreviewOutputRepresentation:
+    description: API Response Representation for document preview
+    type: object
+    properties:
+      fileId:
+        description: Represents the input fileId.
+        type: string
+      format:
+        description: Represents the format of the preview.
+        type: string
+      pageCount:
+        description: Represents the number of pages this preview type has.
+        type: integer
+      previewUrlCount:
+        description: Represents the number of preview items this preview type has.
+        type: integer
+      previewUrls:
+        description: Represents a URI to retrieve the preview for a specific preview.
+        type: array
+        items:
+          type: DocPreviewUrlRepresentation
+      status:
+        description: Represents the availability status of the preview.
+        type: string
+  DocPreviewUrlRepresentation:
+    description: Represents the information to retrieve a preview item of a document.
+    type: object
+    properties:
+      pageNumber:
+        description: Preview Page Number (Optional)
+        type: integer
+      previewUrl:
+        description: Represents the file preview URL.
+        type: string
+/connect:
+  /clause-library:
+    /clause-category-configurations:
+      get:
+        description: Connect endpoint to fetch Clause Category List from configuration
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ClauseCategoriesResponse
+        queryParameters:
+          id:
+            type: string
+            required: false
+          name:
+            type: string
+            required: false
+          usageType:
+            type: string
+            required: false
+    /document-clause-sets:
+      get:
+        description: Get Document Clause Sets as per specified filters and sorting
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentClauseSetListResponse
+        queryParameters:
+          category:
+            description: Comma seperated Category values used for filtering
+            type: string
+            required: false
+          defaultLanguage:
+            description: Comma seperated Language values used for filtering
+            type: string
+            required: false
+          limit:
+            description: Limit value for Pagination
+            type: integer
+            required: false
+          name:
+            description: Name of Clause Set
+            type: string
+            required: false
+          offset:
+            description: Offset value for Pagination
+            type: integer
+            required: false
+          status:
+            description: Comma seperated Status values used for filtering
+            type: string
+            required: false
+    /document-clauses/fields:
+      get:
+        description: Get Document clause fields based on clauseSetId
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentClauseFieldsResponse
+        queryParameters:
+          clauseSetId:
+            description: Clause Set Id
+            type: string
+            required: false
+          extendedFields:
+            description: extendedFields
+            type: string
+            required: false
+          fieldName:
+            description: Field Name
+            type: string
+            required: false
+          language:
+            description: Clause Language
+            type: string
+            required: false
+          name:
+            description: Clause Name
+            type: string
+            required: false
+          status:
+            description: Status
+            type: string
+            required: false
+    /promote-clause:
+      post:
+        displayName: postDocumentClausePromotion
+        description: Create/Initialize review with the specified list of reviewers
+          for a given contractDocVersion
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentClausePromotionResponse
+        body:
+          application/json:
+            type: DocumentClausePromotionRequest
+            # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+            #required: false
+            (oas-body-name): promotionRequest
+  /content-link:
+    /data-sync:
+      post:
+        displayName: postContentLinkDataSync
+        description: Fetches the Content Data for a given ReferenceId or Set of Content
+          Link Ids
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ContentLinkDataSyncOutputRepresentation
+        body:
+          application/json:
+            type: ContentLinkDataSyncInputRepresentation
+            #required: false
+            (oas-body-name): getContentLinkDataSyncInput
+    /load:
+      post:
+        displayName: postContentLinkLoad
+        description: Fetches the Content Data for a given ReferenceId or Set of Content
+          Link Ids
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ContentLinkListRepresentation
+        body:
+          application/json:
+            type: ContentLinkInputRepresentation
+            (oas-body-name): getContentLinkInput
+  /docgen:
+    /doc-generation-batch-process/{docGenerationBatchProcessId}/{actionName}:
+      patch:
+        description: Run, Cancel, Pause & Resume the DocGenerationBatchProcess
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GenericOutputRepresentation
+      uriParameters:
+        actionName:
+          type: string
+          required: true
+          enum:
+            - Cancel
+            - Pause
+            - Resume
+            - Run
+        docGenerationBatchProcessId:
+          type: string
+          required: true
+    /document-compare:
+      post:
+        displayName: postDocumentCompare
+        description: Create the difference Document by Comparing the provided Content
+          Versions
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentCompareOutputRepresentation
+        body:
+          application/json:
+            type: DocumentCompareInputRepresentation
+            (oas-body-name): documentCompareInput
+    /document/preview:
+      post:
+        displayName: postDocumentPreview
+        description: Return the document preview of specified format
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocPreviewOutputRepresentation
+        body:
+          application/json:
+            type: DocPreviewInputRepresentation
+            (oas-body-name): documentPreviewInput
+    /config:
+      post:
+        displayName: postDocGenConfig
+        description: Return the DocGen configs based on input config type
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocGenConfigOutputRepresentation
+        body:
+          application/json:
+            type: DocGenConfigInputRepresentation
+            (oas-body-name): docGenConfigInput
+    /document-templates:
+      get:
+        displayName: getDocumentTemplate
+        description: List/Search Document Templates with pagination
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentTemplateListRepresentation
+        queryParameters:
+          cloneOnly:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          limit:
+            type: string
+            required: false
+          offset:
+            type: string
+            required: false
+          searchString:
+            type: string
+            required: false
+          type:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          usageType:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+      patch:
+        displayName: patchDocumentTemplate
+        description: Update/Activate/Deactivate a Document Template
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentTemplateRepresentation
+        queryParameters:
+          documentTemplateId:
+            type: string
+            required: false
+        body:
+          application/json:
+            type: DocumentTemplateUpdateInputRepresentation
+            # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+            #required: false
+            (oas-body-name): documentTemplateUpdateInput
+      post:
+        displayName: postDocumentTemplate
+        description: Save/Create New Version/Clone a Document Template
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentTemplateRepresentation
+        queryParameters:
+          action:
+            type: string
+            required: false
+            enum:
+              - Clone
+              - NewVersion
+          documentTemplateId:
+            type: string
+            required: false
+        body:
+          application/json:
+            type: DocumentTemplateRequest
+            # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+            #required: false
+            (oas-body-name): documentTemplate
+  /e-sign:
+    /documents:
+      get:
+        description: Get Documents based on the source Id
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentListResponse
+        queryParameters:
+          documentSelector:
+            type: string
+            required: false
+          sourceObjectId:
+            type: string
+            required: false
+    /notification-settings:
+      get:
+        description: Get Notification Settings for object ID
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: NotificationSettingResponse
+        queryParameters:
+          sourceObjectId:
+            type: string
+            required: false
+    /recipients:
+      get:
+        description: Get recipients
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecipientListResponse
+        queryParameters:
+          recipientSelector:
+            type: string
+            required: false
+          sourceObjectId:
+            type: string
+            required: false
+    /signature-requests/{sourceObjectId}:
+      /envelope/send:
+        post:
+          description: Connect endpoint for sending document envelope to vendor for
+            esign
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: EnvelopeSendResponse
+          body:
+            application/json:
+              # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+              type: EnvelopeSendRequestWrapper
+              # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+              # required: false
+              (oas-body-name): envelope
+        uriParameters:
+          sourceObjectId:
+            type: string
+            required: true
+      /envelopes:
+        /status:
+          patch:
+            description: Update status of “awaiting-signature” contract status whose
+              parent Object ID is provided
+            responses:
+              '200':
+                description: Success
+                body:
+                  application/json:
+                    type: EnvelopeStatusListResponse
+          uriParameters:
+            sourceObjectId:
+              type: string
+              required: true
+        /void:
+          patch:
+            description: Void all associated envelopes whose parent Object ID is provided
+            responses:
+              '200':
+                description: Success
+                body:
+                  application/json:
+                    type: EnvelopeVoidResponse
+            body:
+              application/json:
+                # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+                type: EnvelopeVoidRequestWrapper
+                # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+                # required: false
+                (oas-body-name): voidParam
+          uriParameters:
+            sourceObjectId:
+              type: string
+              required: true
+    /signer-roles:
+      get:
+        description: Get signer roles
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SignerRolesResponse