@salesforce/lds-adapters-industries-program-mgmt 1.451.0-dev1 → 1.451.0-dev11

package/src/raml/api.raml

@@ -37,6 +37,131 @@ types:
       success:
         description: success
         type: boolean
+  PreviewBenefitSessionInputRepresentation:
+    description: Input representation for previewing benefit sessions
+    type: object
+    properties:
+      firstSessionStartDate:
+        description: First session start date
+        type: string
+        required: false
+      firstSessionEndDate:
+        description: First session end date
+        type: string
+        required: false
+      scheduleFrequency:
+        description: Schedule frequency
+        type: string
+        required: false
+      scheduleDays:
+        description: Schedule days
+        type: integer
+        required: false
+      totalRecurrencesCount:
+        description: Total recurrences count
+        type: integer
+        required: false
+      scheduleEndDate:
+        description: Schedule end date
+        type: string
+        required: false
+      benefitScheduleName:
+        description: Benefit schedule name
+        type: string
+        required: false
+      mode:
+        description: Mode
+        type: string
+        required: false
+      noOfSessions:
+        description: Number of sessions
+        type: integer
+        required: false
+  BenefitSessions:
+    description: Represents a single benefit session
+    type: object
+    properties:
+      name:
+        description: Session name
+        type: string
+      startDate:
+        description: Session start date
+        type: string
+      endDate:
+        description: Session end date
+        type: string
+  PreviewBenefitSessionsOutputRepresentation:
+    description: Output representation of the benefit sessions preview request
+    type: object
+    properties:
+      sessions:
+        description: Previewed benefit sessions
+        type: array
+        items: BenefitSessions
+      success:
+        # TODO hand rolled. W-23576522 - not yet returned by Connect API, added to satisfy
+        # Luvio's key requirement for POST adapters. Needs a matching field on the
+        # server response for this to resolve to a real value at runtime.
+        description: success
+        type: boolean
+  BenefitSessionUpsertInputRepresentation:
+    description: Input representation for a benefit session to upsert. Carries a map of
+      BenefitSession field name to value.
+    type: object
+    properties:
+      fields:
+        description: Map of BenefitSession field name to value for the session to upsert
+        type: object
+        properties:
+          //:
+            type: any
+        additionalProperties: true
+  UpdateBenefitSessionsInputRepresentation:
+    description: Input representation for upserting/deleting benefit sessions
+    type: object
+    properties:
+      upsertSessions:
+        description: Benefit sessions to upsert
+        type: array
+        items: BenefitSessionUpsertInputRepresentation
+        required: false
+      deleteSessions:
+        description: Ids of benefit sessions to delete
+        type: array
+        items: string
+        required: false
+  UpdateBenefitSessionsOutputRepresentation:
+    description: Output representation of the update benefit sessions request
+    type: object
+    properties:
+      insertedSessionCount:
+        description: Number of benefit sessions that were inserted
+        type: integer
+        required: false
+      insertedDisbursementCount:
+        description: Number of benefit disbursements that were inserted
+        type: integer
+        required: false
+      updatedSessionCount:
+        description: Number of benefit sessions that were updated
+        type: integer
+        required: false
+      deletedSessionCount:
+        description: Number of benefit sessions that were deleted
+        type: integer
+        required: false
+      deletedDisbursementCount:
+        description: Number of benefit disbursements that were deleted
+        type: integer
+        required: false
+      success:
+        # NOTE: Connect's schema marks this required: false, but it is used as this
+        # type's (luvio.key) for the POST adapter response, which the Luvio compiler
+        # requires to be a non-optional property (confirmed via a failing `yarn build`
+        # TS2322 when left optional). Kept required here on the assumption Connect
+        # always populates it for this synchronous request.
+        description: Whether the update benefit sessions request succeeded
+        type: boolean
 /connect:
   /program-mgmt:
     /benefit-schedules/{benefitScheduleId}/sessions:
@@ -52,3 +177,35 @@ types:
         benefitScheduleId:
           type: string
           required: true
+    /benefit-schedules:
+      post:
+        description: Generate a preview of benefit sessions for a Benefit Schedule
+        body:
+          application/json:
+            description: Benefit sessions preview input
+            type: PreviewBenefitSessionInputRepresentation
+            (oas-body-name): generateBenefitSessionsPreviewData
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: PreviewBenefitSessionsOutputRepresentation
+    /benefit-schedules/{benefitScheduleId}/session-updates:
+      post:
+        description: Upsert or delete Benefit Sessions for a Benefit Schedule
+        body:
+          application/json:
+            description: Benefit sessions update input
+            type: UpdateBenefitSessionsInputRepresentation
+            (oas-body-name): updateBenefitSessionsRequest
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: UpdateBenefitSessionsOutputRepresentation
+      uriParameters:
+        benefitScheduleId:
+          type: string
+          required: true

package/src/raml/luvio.raml

@@ -13,9 +13,27 @@ types:
     (luvio.ttl): 100
     (luvio.key):
       success: success
+  PreviewBenefitSessionsOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 100
+    (luvio.key):
+      success: success
+  UpdateBenefitSessionsOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 100
+    (luvio.key):
+      success: success
 
 /connect:
   /program-mgmt/benefit-schedules/{benefitScheduleId}/sessions:
     post:
       (luvio.adapter):
         name: postTriggerBenefitSessionGeneration
+  /program-mgmt/benefit-schedules:
+    post:
+      (luvio.adapter):
+        name: postBenefitSessionsPreview
+  /program-mgmt/benefit-schedules/{benefitScheduleId}/session-updates:
+    post:
+      (luvio.adapter):
+        name: postUpdateBenefitSessions