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

package/src/raml/api.raml

@@ -0,0 +1,448 @@
+#%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:
+  ErrorDetail:
+    description: Output Representation for Error
+    type: object
+    properties:
+      code:
+        description: Code of the error
+        type: string
+      message:
+        description: Message of the error
+        type: string
+  ClaimAttributeInputRepresentation:
+    description: Input Representation for Attributes
+    type: object
+    properties:
+      apiName:
+        description: Attribute API Name
+        type: string
+        required: false
+      value:
+        description: Value of the attribute
+        type: string
+        required: false
+  ClaimAttributesInput:
+    description: Attributes list wrapper
+    type: object
+    properties:
+      list:
+        description: Attributes list
+        type: array
+        items:
+          type: ClaimAttributeInputRepresentation
+  ClaimErrorOutputRepresentation:
+    description: Output Representation for Error
+    type: object
+    properties:
+      code:
+        description: Code of the error
+        type: string
+      message:
+        description: Message of the error
+        type: string
+  ClaimErrorsOutput:
+    description: Errors
+    type: object
+    properties:
+      list:
+        description: List of errors
+        type: array
+        items:
+          type: ClaimErrorOutputRepresentation
+  ClaimInputRepresentation:
+    description: Input Representation for Create Claim Connect resource
+    type: object
+    properties:
+      accountId:
+        description: Account Id
+        type: string
+        required: false
+      additionalFields:
+        description: The additional fields of the claim product
+        type: any
+        required: false
+      attributes:
+        description: The attributes of the claim product
+        type: ClaimAttributesInput
+        required: false
+      claimReason:
+        description: Reason for claim
+        type: string
+        required: false
+      claimReasonType:
+        description: Claim reason type
+        type: string
+        required: false
+      claimType:
+        description: The type of claim
+        type: string
+        required: false
+      incidentTypeId:
+        description: Id of the incident type
+        type: string
+        required: false
+      insurancePolicyId:
+        description: Policy Id on which the claim is raised
+        type: string
+        required: false
+      items:
+        description: Claim Items associated with claim
+        type: ClaimItemsInput
+        required: false
+      lossDate:
+        description: The date on which loss occurred
+        type: string
+        required: false
+      lossType:
+        description: Type of the loss for which claim is raised
+        type: string
+        required: false
+      name:
+        description: Name of the claim
+        type: string
+        required: false
+      options:
+        description: Options to pass while creation/updation of claim
+        type: any
+        required: false
+      participants:
+        description: Claim Participants associated with claim
+        type: ClaimParticipantsInput
+        required: false
+      productCode:
+        description: The product code of the claim product
+        type: string
+        required: false
+  # ClaimInputWrapperRepresentation: # removing redundant wrapper over the input representation
+  #   description: Input representation wrapper for ClaimInputRepresentation
+  #   type: object
+  #   properties:
+  #     updateClaimInput:
+  #       description: Input representation wrapper for ClaimInputRepresentation
+  #       type: ClaimInputRepresentation
+  ClaimItemInputRepresentation:
+    description: Input Representation for Claim Item
+    type: object
+    properties:
+      action:
+        description: Action to be performed during update operation
+        type: string
+        #required: true
+      additionalFields:
+        description: The additional fields of the claim item
+        type: any
+        required: false
+      attributes:
+        description: The attributes of the claim item
+        type: ClaimAttributesInput | nil
+        required: false
+      category:
+        description: The category of the claim item
+        type: string | nil
+        required: false
+      instanceKey:
+        description: The unique instanceKey of the claim item
+        type: string
+        required: true
+      insurancePolicyCoverageId:
+        description: Id of the insurance policy coverage
+        type: string | nil
+        required: false
+      insuredItemId:
+        description: The id of the insuredItem involved
+        type: string | nil
+        required: false
+      name:
+        description: Name of the claim item
+        type: string | nil
+        required: false
+      participantInstanceKey:
+        description: Instance Key of Related Claim Participant
+        type: string | nil
+        required: false
+      productCode:
+        description: The product code of the claim item product
+        type: string | nil
+        required: false
+      relatedObjects:
+        description: Claim Item Related Objects
+        type: ClaimRelatedObjectsInput | nil
+        required: false
+  ClaimItemsInput:
+    description: Claim Items List wrapper object
+    type: object
+    properties:
+      list:
+        description: Claim Items List
+        type: array
+        items:
+          type: ClaimItemInputRepresentation
+  ClaimOptionsInputRepresentation:
+    description: Options for create/update claim
+    type: object
+    properties:
+      executeConfigurationRules:
+        description: Execute configuration rules or not
+        type: string
+  ClaimParticipantInputRepresentation:
+    description: Input representation for Claim Participant
+    type: object
+    properties:
+      accountId:
+        description: Account id of the claim participant
+        type: string
+        required: false
+      action:
+        description: Action to be performed during update operation
+        type: string
+        required: true
+      additionalFields:
+        description: Additional Fields of the claim participant
+        type: any
+        required: false
+      contactId:
+        description: Contact Id of the claim participant
+        type: string
+        required: false
+      instanceKey:
+        description: Unique instanceKey of the claim participant
+        type: string
+        required: true
+      insurancePolicyParticipantId:
+        description: Insurance Policy Participant Id of the claim participant
+        type: string
+        required: false
+      isInjured:
+        description: Is insured or not
+        type: string
+        required: false
+      roles:
+        description: Claim Participant Roles
+        type: ClaimParticipantRolesInput
+        required: false
+  ClaimParticipantRolesInput:
+    description: Claim Participant Roles List wrapper object
+    type: object
+    properties:
+      list:
+        description: Claim Participant Roles list
+        type: array
+        required: false
+        items:
+          type: string
+  ClaimParticipantsInput:
+    description: Claim Participants List wrapper object
+    type: object
+    properties:
+      list:
+        description: Claim Participants List
+        type: array
+        items:
+          type: ClaimParticipantInputRepresentation
+  ClaimRelatedObjectInputRepresentation:
+    description: Input Representation for Related Object
+    type: object
+    properties:
+      recordId:
+        description: Claim Item Related Object Id
+        type: string
+        required: false
+      recordObjName:
+        description: Claim Item Related Object Name
+        type: string
+        required: false
+  ClaimRelatedObjectsInput:
+    description: Related Objects List wrapper object
+    type: object
+    properties:
+      list:
+        description: Claim Item Related Objects List
+        type: array
+        items:
+          type: ClaimRelatedObjectInputRepresentation
+  CreateClaimOutputRepresentation:
+    description: Output Representation for create claim service
+    type: object
+    properties:
+      claimId:
+        description: The id of the created claim
+        type: string | nil
+        required: false
+      errors:
+        description: A list of errors, including detailed information about each one.
+        required: false
+        type: array
+        items:
+          type: ClaimErrorOutputRepresentation
+      isSuccess:
+        description: IsSuccess to specify the success of operation
+        type: boolean
+  CreateClaimCoverageInputRepresentation:
+    description: Input Representation for Create Claim Coverage Connect resource
+    type: object
+    properties:
+      additionalFields:
+        description: Additional Fields for Claim Coverage
+        type: any
+        required: false
+      claimItemId:
+        description: ID of the claim item
+        type: string
+      claimParticipantId:
+        description: ID of the claim participant
+        type: string
+      currencyIsoCode:
+        description: Currency ISO Code for Reserve Adjustments
+        type: string
+        required: false
+      expenseReserveAmount:
+        description: Expense reserve amount for the coverage
+        format: float
+        type: number
+        required: false
+      insurancePolicyAssetId:
+        description: ID of the insurance policy asset
+        type: string
+        required: false
+      insurancePolicyCoverageId:
+        description: ID of the insurance policy coverage
+        type: string
+        required: false
+      lossReserveAmount:
+        description: Loss reserve amount for the coverage
+        format: float
+        type: number
+        required: false
+      name:
+        description: Name of Claim Coverage
+        type: string
+        required: false
+      reserveProcessingMode:
+        description: Reserve Processing Mode for claim coverage
+        type: string
+  ClaimCoverageRepresentation:
+    description: Output Representation for claim coverage creation service
+    type: object
+    properties:
+      coverageId:
+        description: The ID of the created coverage
+        type: string
+        required: false
+      errors:
+        description: A list of errors, including detailed information about each one.
+        type: array
+        items:
+          type: ErrorDetail
+        required: false
+      isSuccess:
+        description: Indicates whether the claim coverage creation was successful
+        type: boolean
+  UpdateClaimCoverageInputRepresentation:
+    description: Input Representation for Update Claim Coverage Connect resource
+    type: object
+    properties:
+      additionalFields:
+        description: Additional fields for the coverage
+        type: any
+        required: false
+      expenseReserveAmount:
+        description: Expense reserve amount for the coverage
+        format: float
+        type: number
+        required: false
+      lossReserveAmount:
+        description: Loss reserve amount for the coverage
+        format: float
+        type: number
+        required: false
+
+/connect:
+  /claims/{claimId}:
+    patch:
+      displayName: patchClaim
+      description: API to update claim
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CreateClaimOutputRepresentation
+      body:
+        application/json:
+          # type: ClaimInputWrapperRepresentation
+          type: ClaimInputRepresentation
+          #required: false
+          (oas-body-name): UpdateClaimInput
+    uriParameters:
+      claimId:
+        description: Unique Id to represent a claim
+        type: string
+        required: true
+  /claims/{claimId}/coverages:
+    post:
+      displayName: postCreateClaimCoverage
+      description: HTTP POST Method to create claim coverage
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ClaimCoverageRepresentation
+      body:
+        application/json:
+          type: CreateClaimCoverageInputRepresentation
+          (oas-body-name): CreateClaimCoverageInput
+    uriParameters:
+      claimId:
+        description: Unique Id to represent a claim
+        type: string
+        required: true
+  /claims/{claimId}/coverages/{coverageId}:
+    patch:
+      displayName: patchClaimCoverage
+      description: HTTP PATCH Method to update claim coverage
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ClaimCoverageRepresentation
+      body:
+        application/json:
+          type: UpdateClaimCoverageInputRepresentation
+          (oas-body-name): UpdateClaimCoverageInput
+    uriParameters:
+      claimId:
+        description: Unique Id to represent a claim
+        type: string
+        required: true
+      coverageId:
+        description: Unique Id to represent a claim coverage
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,41 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'Claim'
+(luvio.ttl): 1000
+
+types:
+  CreateClaimOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: isSuccess
+  ClaimCoverageInputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      claimItemId: claimItemId
+  ClaimCoverageRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: isSuccess
+
+/connect:
+  /claims/{claimId}:
+    patch:
+      (luvio.adapter):
+        name: UpdateClaim
+  /claims/{claimId}/coverages:
+    post:
+      description: Create a new claim coverage
+      (luvio.adapter):
+        name: CreateClaimCoverage
+  /claims/{claimId}/coverages/{coverageId}:
+    patch:
+      description: Update an existing claim coverage
+      (luvio.adapter):
+        name: UpdateClaimCoverage