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

package/src/raml/api.raml

@@ -0,0 +1,630 @@
+#%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 the error details
+    type: object
+    properties:
+      code:
+        description: Code of the error
+        type: string
+      message:
+        description: Message of the error
+        type: string
+  DeleteClaimCoveragePaymentDetailRep:
+    description: Output Representation for Delete Claim Coverage Payment Detail Connect resource
+    type: object
+    properties:
+      errors:
+        description: A list of errors, including detailed information about each one.
+        type: array
+        items:
+          type: ErrorDetail
+        required: false
+      isSuccess:
+        description: Indicates whether the API operation was successful
+        type: boolean
+        required: true
+      paymentDetailId:
+        description: ID of the Claim Coverage Payment Detail
+        type: string
+        required: false
+  CancelClaimCoveragePaymentDetailRep:
+    description: Output Representation for Cancel Claim Coverage Payment Detail Connect resource
+    type: object
+    properties:
+      errors:
+        description: A list of errors, including detailed information about each one.
+        type: array
+        items:
+          type: ErrorDetail
+        required: false
+      isSuccess:
+        description: Indicates whether the API operation was successful
+        type: boolean
+        required: true
+      paymentDetailId:
+        description: ID of the Claim Coverage Payment Detail
+        type: string
+        required: false
+  CreateClaimCovPaymentDetailInputRep:
+    description: Input Representation for Create Claim Coverage Payment Detail Connect
+      resource
+    type: object
+    properties:
+      additionalFields:
+        description: Additional fields for the payment detail
+        type: any
+        required: false
+      adjustedAmount:
+        description: Adjusted amount of the claim
+        format: float
+        type: number
+        required: false
+      benefitName:
+        description: Sub coverage information
+        type: string
+        required: false
+      claimedAmount:
+        description: Amount of the claim
+        format: float
+        type: number
+      description:
+        description: Description of the payment detail
+        type: string
+        required: false
+      recipientId:
+        description: ID of the recipient
+        type: string
+        required: false
+      coveragePaymentType:
+        description: Type of the payment detail
+        type: string
+      limitUnitCount:
+        description: Number of units
+        type: integer
+        required: false
+  CreateClaimCoveragePaymentDetailRep:
+    description: Output Representation for Create Claim Coverage Payment Detail Connect
+      resource
+    type: object
+    properties:
+      adjustedAmount:
+        description: Adjusted amount of the claim coverage payment detail
+        format: double
+        type: number
+        required: false
+      adjustedReason:
+        description: Reason for the adjustment
+        type: string
+        required: false
+      errors:
+        description: A list of errors, including detailed information about each one
+        type: array
+        items:
+          type: ErrorDetail
+        required: false
+      insurancePolicyLimitTrackingIds:
+        description: IDs of the insurance policy limit tracking
+        type: array
+        items:
+          type: string
+        required: false
+      isSuccess:
+        description: Indicates whether the API operation was successful
+        type: boolean
+        required: true
+      paymentDetailId:
+        description: ID of the created claim coverage payment detail
+        type: string
+        required: false
+  CalculateAdjustmentsInputRepresentation:
+    description: Input Representation for calculating the adjustments for the claim loss items.
+    type: object
+    properties:
+      claimedAmount:
+        description: Amount requested by the claimant when submitting the loss.
+        format: float
+        type: number
+        required: true
+  CalculateAdjustmentsRepresentation:
+    description: Output Representation for Calculate Adjustments Connect resource
+    type: object
+    properties:
+      adjustedAmount:
+        description: Amount after adjustments are made based on the current standings
+          of the policy limits.
+        format: float
+        type: number
+        required: false
+      adjustmentReason:
+        description: Reason for the claim coverage payment detail adjustment such
+          as deductible, copay, or coinsurance.
+        type: string
+        required: false
+      claimCovPaymentAdjustments:
+        description: List of claim coverage payment adjustment details.
+        type: array
+        items:
+          type: ClaimCovPaymentAdjDetailsRep
+        required: false
+      errors:
+        description: List of errors
+        type: array
+        items:
+          type: ErrorDetail
+        required: false
+      insPolicyLimitTrackings:
+        description: List of insurance policy limit tracking details.
+        type: array
+        items:
+          type: InsPolicyLimitTrackingDetailsRep
+        required: false
+      isSuccess:
+        description: Indicates whether the API operation was successful
+        type: boolean
+        required: true
+  ClaimCovPaymentAdjDetailsRep:
+    description: Output representation for the claim coverage payment adjustment details.
+    type: object
+    properties:
+      adjustedAmount:
+        description: Amount deducted from the Posted Amount based on the respective
+          attribute category.
+        format: float
+        type: number
+        required: false
+      adjustmentReason:
+        description: Reason for the claim coverage payment adjustment such as deductible,
+          copay, or coinsurance.
+        type: string
+        required: false
+  InsPolicyLimitTrackingDetailsRep:
+    description: Output representation for the insurance policy limit tracking details.
+    type: object
+    properties:
+      calcInitialAmount:
+        description: Calculated currency amount that's used as the base value for
+          tracking the policy attribute consumption.
+        format: double
+        type: number
+        required: false
+      calcInitialValue:
+        description: Count that's used as the base for tracking the policy attribute
+          consumption.
+        type: integer
+        required: false
+      category:
+        description: Category of the associated attribute.
+        type: string
+        required: false
+      policyLimitId:
+        description: ID of the Insurance Policy Limit record.
+        type: string
+        required: false
+      postedAmount:
+        description: Amount requested by the claimant when submitting the loss.
+        format: float
+        type: number
+        required: false
+      postedValue:
+        description: Count that's populated when submitting the loss.
+        type: integer
+        required: false
+      remainingAmount:
+        description: Remaining amount to carry forward for the next loss processing.
+        format: float
+        type: number
+        required: false
+      remainingValue:
+        description: Remaining value to carry forward for the next loss processing.
+        type: integer
+        required: false
+      scope:
+        description: Scope for tracking the associated attribute.
+        type: string
+        required: false
+      totalUsedAmount:
+        description: Total amount used till date.
+        format: float
+        type: number
+        required: false
+      totalUsedValue:
+        description: Total value used till date.
+        type: integer
+        required: false
+  InsPolicyLmtCurrentStandingsInputRep:
+    description: Input Representation for Current Policy Limits Standing Connect resource
+    type: object
+    properties:
+      claimId:
+        description: Unique ID of the Claim
+        type: string
+        required: false
+      claimCoverageId:
+        description: Unique ID of the Claim Coverage
+        type: string
+        required: false
+      options:
+        description: Options for include pending values and filter coverage
+        type: any
+        required: false
+      policyAssetId:
+        description: Unique ID of the Policy Asset
+        type: string
+        required: false
+      policyCoverageId:
+        description: Unique ID of the Policy Coverage
+        type: string
+        required: false
+      policyId:
+        description: Unique ID of the Policy
+        type: string
+        required: false
+      policyParticipantId:
+        description: Unique ID of the Policy Participant
+        type: string
+        required: false
+  InsPolicyLmtCalcStandingNode:
+    description: Node representation for Insurance Policy Limit Standing Calculation
+      Node
+    type: object
+    properties:
+      applicableActions:
+        description: List of actions that initiate the attribute processing.
+        type: array
+        items:
+          type: string
+      category:
+        description: Category of the limit.
+        type: string
+      claimCoverageId:
+        description: ID of the related claim coverage.
+        type: string
+        required: false
+      claimId:
+        description: ID of the related claim.
+        type: string
+        required: false
+      durationType:
+        description: Duration type over which the attribute consumption is actively
+          monitored during processing.
+        type: string
+      initialAmount:
+        description: Configured  amount.
+        format: double
+        type: number
+        required: false
+      initialValue:
+        description: Configured value of the limit.
+        type: integer
+        required: false
+      itemType:
+        description: Type of the item.
+        type: string
+        required: false
+      parentMappedScopeId:
+        description: ID of the parent product attribute mapped scope that's associated
+          with the product attribute to define parent-child relationship between attribute
+          mappings.
+        type: string
+        required: false
+      pendingAmount:
+        description: Amount that's pending
+        format: double
+        type: number
+        required: false
+      pendingValue:
+        description: Value that's pending.
+        type: integer
+        required: false
+      policyAssetId:
+        description: ID of the related policy asset.
+        type: string
+        required: false
+      policyCoverageId:
+        description: ID of the related policy coverage.
+        type: string
+        required: false
+      policyLimitId:
+        description: ID of the insurance policy limit record.
+        type: string
+      policyLimitStandingKey:
+        description: Unique identifier for the insurance policy limit standing.
+        type: string
+      policyParticipantId:
+        description: ID of the related policy participant.
+        type: string
+        required: false
+      predictedRemainingAmount:
+        description: Remaining amount to carry forward for the next payment after
+          calculating the pending value.
+        format: double
+        type: number
+        required: false
+      predictedRemainingValue:
+        description: Remaining value to carry forward for the next payment after calculating
+          the pending value.
+        type: integer
+        required: false
+      prodtAttrMappedScopeId:
+        description: 'ID of the product attribute mapped scope that defines how a
+          product attribute is associated with a specific scope, such as a product
+          type or category. '
+        type: string
+        required: false
+      remainingAmount:
+        description: Remaining amount to carry forward for the next payment.
+        format: double
+        type: number
+        required: false
+      remainingValue:
+        description: Remaining value to carry forward for the next payment.
+        type: integer
+        required: false
+      scope:
+        description: Scope, where the limit is applied.
+        type: string
+      totalUsedAmount:
+        description: Total amount used till date.
+        format: double
+        type: number
+        required: false
+      totalUsedValue:
+        description: Total value used till date.
+        type: integer
+        required: false
+  InsPolicyLmtCalcStandingRepresentation:
+    description: Output representation for the current standings of the insurance
+      policy limits.
+    type: object
+    properties:
+      errors:
+        description: The node is for errors for calculate standings
+        type: array
+        items:
+          type: ErrorDetail
+        required: false
+      insPolicyLmtCalcStandingNodes:
+        description: List of policy limit  current standing nodes.
+        type: array
+        items:
+          type: InsPolicyLmtCalcStandingNode
+        required: false
+      isSuccess:
+        description: The flag indicates whether operation completed successfully
+        type: boolean
+  LimitStandingOptionInputRepresentation:
+    description: options for calculate-standings
+    type: object
+    properties:
+      includePendingAmount:
+        description: Include pending values in response
+        type: boolean
+        required: false
+      viewOption:
+        description: Filter for coverages
+        type: string
+        required: false
+  VerifyPolicyCoverageInputRepresentation:
+    description: Input representation of a policy coverage's applicability for a specified loss date under an insurance policy.
+    type: object
+    properties:
+      insuredAssetOrParticipantId:
+        description: ID of the insured asset or participant that's related to the policy coverage.
+        type: string
+        required: false
+      lossDate:
+        description: Date on which the incident occurred.
+        type: string
+  VerifyPolicyCoverageRepresentation:
+    description: Output representation of a policy coverage's applicability for a specified loss date under an insurance policy.
+    type: object
+    properties:
+      errors:
+        description: List of errors, including detailed information about each one.
+        type: array
+        items:
+          type: ErrorDetail
+        required: false
+      isSuccess:
+        type: boolean
+        description: Indicates whether the policy coverage is valid for the date on which the incident occurred.
+  PayClaimCoveragePaymentDetailRep:
+    description: Output representation for the payment of the claim coverage payment detail record.
+    type: object
+    properties:
+      errors:
+        description: List of errors, including detailed information about each one
+        type: array
+        items:
+          type: ErrorDetail
+        required: false
+      isSuccess:
+        description: Indicates whether the API operation is successful (true) or not (false)
+        type: boolean
+        required: true
+
+/connect:
+  /insurance:
+    /claims/{claimId}/coverages/{coverageId}:
+      /payment-details:
+        post:
+          displayName: postCreateClaimCoveragePaymentDetail
+          description: HTTP POST Method to create claim coverage payment detail
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: CreateClaimCoveragePaymentDetailRep
+          body:
+            application/json:
+              type: CreateClaimCovPaymentDetailInputRep
+              (oas-body-name): CreateClaimCoveragePaymentDetailInput
+        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
+      /payment-details/{paymentDetailId}:
+        /cancel:
+          post:
+            displayName: postCancelClaimCoveragePaymentDetail
+            description: HTTP POST Method to mark a Claim Coverage Payment Detail
+              record as cancelled
+            responses:
+              '200':
+                description: Success
+                body:
+                  application/json:
+                    type: CancelClaimCoveragePaymentDetailRep
+          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
+            paymentDetailId:
+              description: Unique Id to represent a claim coverage payment details
+              type: string
+              required: true
+        /delete:
+          post:
+            displayName: postDeleteClaimCoveragePaymentDetail
+            description: HTTP POST Method to mark a Claim Coverage Payment Detail
+              record as deleted
+            responses:
+              '200':
+                description: Success
+                body:
+                  application/json:
+                    type: DeleteClaimCoveragePaymentDetailRep
+          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
+            paymentDetailId:
+              description: Unique Id to represent a claim coverage payment details
+              type: string
+              required: true
+        /pay:
+          post:
+            displayName: postPayClaimCoveragePaymentDetail
+            description: HTTP POST Method to pay ClaimCoveragePaymentDetail
+            responses:
+              '200':
+                description: Success
+                body:
+                  application/json:
+                    type: PayClaimCoveragePaymentDetailRep
+          uriParameters:
+            paymentDetailId:
+              description: Unique Id to represent a claim coverage payment details
+              type: string
+              required: true
+            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
+      /calculate-adjustments:
+        post:
+          displayName: postInsuranceCalculateAdjustments
+          description: Post Resource method for calculate adjustment during the creation of Loss Item
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: CalculateAdjustmentsRepresentation
+          body:
+            application/json:
+              type: CalculateAdjustmentsInputRepresentation
+              (oas-body-name): CalculateAdjustmentsInput
+        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
+    /policy-limit/calculate-standings:
+      post:
+        displayName: postInsurancePolicyLimitStandingCalculation
+        description: HTTP POST Method to calculate and get current standing
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: InsPolicyLmtCalcStandingRepresentation
+        body:
+          application/json:
+            type: InsPolicyLmtCurrentStandingsInputRep
+            (oas-body-name): InsurancePolicyLimitStandingCalculationInput
+    /policies/{policyId}:
+      /coverages/{coverageId}/verify:
+        post:
+          displayName: postVerifyPolicyCoverage
+          description: HTTP POST Method to verify if a policy coverage is valid for a given loss date
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: VerifyPolicyCoverageRepresentation
+          body:
+            application/json:
+              type: VerifyPolicyCoverageInputRepresentation
+              (oas-body-name): verifyPolicyCoverageInput
+        uriParameters:
+          coverageId:
+            description: Unique Id to represent a policy coverage
+            type: string
+            required: true
+          policyId:
+            description: Unique Id to represent an insurance policy
+            type: string
+            required: true

package/src/raml/luvio.raml

@@ -0,0 +1,84 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+(luvio.keyPrefix): 'insuranceclaim'
+(luvio.ttl): 1000
+(luvio.moduleName): 'Insurance Claim'
+(luvio.moduleDescription): 'API for managing insurance claims'
+
+types:
+  DeleteClaimCoveragePaymentDetailRep:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: isSuccess
+  CancelClaimCoveragePaymentDetailRep:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: isSuccess
+  CreateClaimCoveragePaymentDetailRep:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: isSuccess
+  CalculateAdjustmentsRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: isSuccess
+  InsPolicyLmtCalcStandingRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      message: isSuccess
+  VerifyPolicyCoverageRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: isSuccess
+  PayClaimCoveragePaymentDetailRep:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: isSuccess
+
+/connect/insurance:
+  /claims/{claimId}/coverages/{coverageId}:
+    /payment-details:
+      post:
+        description: HTTP POST Method to create claim coverage payment detail
+        (luvio.adapter):
+          name: CreateClaimCoveragePaymentDetail
+    /payment-details/{paymentDetailId}:
+      /cancel:
+        post:
+          description: Cancel a claim coverage payment detail
+          (luvio.adapter):
+            name: CancelClaimCoveragePaymentDetail
+      /delete:
+        post:
+          description: Delete a claim coverage payment detail
+          (luvio.adapter):
+            name: DeleteClaimCoveragePaymentDetail
+      /pay:
+        post:
+          description: Pay a claim coverage payment detail
+          (luvio.adapter):
+            name: PayClaimCoveragePaymentDetail
+    /calculate-adjustments:
+      post:
+        description: Post Resource method for calculate adjustment during the creation of Loss Item
+        (luvio.adapter):
+          name: CalculateAdjustments
+  /policy-limit/calculate-standings:
+    post:
+      (luvio.adapter):
+        name: PolicyLimitStandingCalculation
+  /policies/{policyId}/coverages/{coverageId}/verify:
+    post:
+      description: HTTP POST Method to verify if a policy coverage is valid for a given loss date
+      (luvio.adapter):
+        name: postVerifyPolicyCoverage