@salesforce/lds-adapters-revenue-billing-batch 1.100.2

package/src/raml/api.raml

@@ -0,0 +1,233 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  BatchFilterCriteriaInputRepresentation:
+    description: Common elements of Billing Batch Filter Criteria Input Representation
+    discriminator: criteriaSequence # TODO hand rolled. W-9275787
+    type: object
+    properties:
+      criteriaSequence:
+        description: Sequence number for the criteria
+        type: integer
+      operation:
+        description: Operation to be performed
+        type: string
+        enum:
+          - Equals
+      value:
+        description: Value to be compared
+        type: string
+  BillingBatchSchedulerRepresentation:
+    description: Billing Batch Scheduler Output Representation
+    type: object
+    properties:
+      id:
+        description: Billing Batch Scheduler Id
+        type: string
+
+  PaymentsBatchSchedulerInputWrapperRepresentation: # TODO Hand-rolled W-8334626
+    description: Wrapper for payment batch scheduler input representation
+    type: object
+    properties:
+      PaymentsBatchSchedulerInput:
+        type: PaymentsBatchSchedulerInputRepresentation
+        description: Payments Batch Scheduler Input Representation
+  PaymentRunBatchFilterCriteriaInputRepresentation:
+    description: Billing Batch Filter Criteria Input Representation
+    type: BatchFilterCriteriaInputRepresentation
+    properties:
+      fieldName:
+        description: Field Name
+        type: string
+        enum:
+          - PaymentRunMatchingValue
+      objectName:
+        description: Object Name
+        type: string
+        enum:
+          - PaymentScheduleItem
+  PaymentRunBatchFilterCriteriaInputRepresentations:
+    description: Batch Payments Filter Criteria Input Representations
+    type: object
+    properties:
+      filterCriteria:
+        description: List of filter criteria line items
+        type: array
+        items:
+          type: object
+  PaymentsBatchSchedulerInputRepresentation:
+    description: Payments Batch Scheduler Input Representation
+    type: ScheduleOptionsInputRepresentation
+    properties:
+      criteriaMatchType:
+        description: Filter Criteria Match Type
+        required: false # TODO handrolled W-9314597
+        type: string
+        enum:
+          - MatchAny
+          - MatchNone
+      filterCriteria:
+        description: List of filter criteria line items
+        required: false # TODO handrolled W-9314597
+        type: array
+        items:
+          type: object
+  PaymentsBatchSchedulerOutputRepresentation:
+    description: Payments Batch Scheduler Output Representation
+    type: object
+    properties:
+      billingBatchScheduler:
+        description: Billing Batch Scheduler Details
+        type: BillingBatchSchedulerRepresentation
+  ScheduleOptionsInputRepresentation:
+    description: Batch Scheduler Options Input Representation
+    discriminator: schedulerName # TODO hand rolled. W-9275787
+    type: object
+    properties:
+      endDate:
+        description: Batch Job End Date
+        required: false # TODO handrolled W-9314597
+        type: string
+      frequencyCadence:
+        description: Frequency Cadence for the Batch Job
+        type: string
+        enum:
+          - Daily
+          - Monthly
+          - Once
+      preferredTime:
+        description: Batch Job Preferred Run Time
+        type: string
+      recursEveryMonthOnDay:
+        description: Batch Job Recurrence Day for Monthly Frequency Option
+        required: false # TODO handrolled W-9314597
+        type: string
+      schedulerName:
+        description: Name of the batch scheduler
+        type: string
+      startDate:
+        description: Batch Job Start Date
+        type: string
+      status:
+        description: Scheduler Status for the Batch Job
+        type: string
+        enum:
+          - Active
+          - Canceled
+          - Draft
+          - Inactive
+  ScheduleOptionsInputRepresentationForInvoice:
+    description: Batch Scheduler Options Input Representation
+    discriminator: schedulerName # TODO hand rolled. W-9275787
+    type: object
+    properties:
+      endDate:
+        description: Batch Job End Date
+        required: false # TODO handrolled W-9314597
+        type: string
+      frequencyCadence:
+        description: Frequency Cadence for the Batch Job
+        type: string
+        enum:
+          - Daily
+          - Monthly
+          - Once
+      preferredTime:
+        description: Batch Job Preferred Run Time
+        type: string
+      schedulerName:
+        description: Name of the batch scheduler
+        type: string
+      startDate:
+        description: Batch Job Start Date
+        type: string
+      status:
+        description: Scheduler Status for the Batch Job
+        type: string
+        enum:
+          - Active
+          - Canceled
+          - Draft
+          - Inactive
+      timezone:
+        description: Preferred Time Zone of the invoice Scheduler
+        type: string
+      frequencyCadenceOptions:
+        description: Frequency Cadence Options for Invoice Scheduler
+        type: object
+  InvoicesBatchSchedulerOutputRepresentation:
+    description: Invoices Batch Scheduler Output Representation
+    type: object
+    properties:
+      billingBatchScheduler:
+        description: Billing Batch Scheduler Details
+        type: BillingBatchSchedulerRepresentation
+  BatchInvoiceSchedulerInputWrapperRepresentation:
+    description: Wrapper for invoice batch scheduler input representation
+    type: object
+    properties:
+      BatchInvoiceSchedulerInput:
+        type: BatchInvoiceSchedulerInputRepresentation
+        description: Invoices Batch Scheduler Input Representation
+  BatchInvoiceSchedulerInputRepresentation:
+    description: Invoices Batch Scheduler Input Representation
+    type: ScheduleOptionsInputRepresentationForInvoice
+    properties:
+      filterCriteria:
+        description: List of filter criteria line items
+        type: array
+        required: false # TODO handrolled W-9314597
+        items:
+          type: object
+/commerce/payments/payment-schedulers:
+  post:
+    description: Create Payments Batch Job Scheduler
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: PaymentsBatchSchedulerOutputRepresentation
+    body:
+      application/json:
+        type: PaymentsBatchSchedulerInputWrapperRepresentation
+        #required: false # TODO handrolled W-9314597
+        (oas-body-name): PaymentsBatchSchedulerInput
+/commerce/invoicing/invoice-schedulers:
+  post:
+    description: Create Invoices Batch Job Scheduler
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: InvoicesBatchSchedulerOutputRepresentation
+    body:
+      application/json:
+        type: BatchInvoiceSchedulerInputWrapperRepresentation
+        #required: false # TODO handrolled W-9314597
+        (oas-body-name): BatchInvoiceSchedulerInput

package/src/raml/luvio.raml

@@ -0,0 +1,322 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'BillingBatch'
+
+types:
+  PaymentsBatchSchedulerOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      billingBatchSchedulerId: billingBatchScheduler.id
+  InvoicesBatchSchedulerOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      billingBatchSchedulerId: billingBatchScheduler.id
+
+/commerce/payments/payment-schedulers:
+  post:
+    (luvio.adapter):
+      name: createPaymentsBatchScheduler
+      tests:
+        validConfigs:
+          - |
+            { "PaymentsBatchSchedulerInput":
+              {
+                "schedulerName": "Batch Scheduler",
+                "startDate": "2021-05-11",
+                "endDate": "2021-05-15",
+                "preferredTime": "10:00 AM",
+                "frequencyCadence": "Monthly",
+                "recursEveryMonthOnDay": "28",
+                "criteriaMatchType": "MatchAny",
+                "criteriaExpression": "1 OR 2",
+                "status" : "Active",
+                "filterCriteria":
+                  [
+                    {
+                        "objectName": "PaymentScheduleItem",
+                        "fieldName": "PaymentRunMatchingValue",
+                        "operation": "Equals",
+                        "value": "Batch1",
+                        "criteriaSequence": 1
+                    },
+                    {
+                        "objectName": "PaymentScheduleItem",
+                        "fieldName": "PaymentRunMatchingValue",
+                        "operation": "Equals",
+                        "value": "Batch2",
+                        "criteriaSequence": 2
+                    }
+                  ]
+                }
+              }
+          - |
+            { "PaymentsBatchSchedulerInput":
+              {
+                "schedulerName": "Batch Scheduler",
+                "startDate": "2021-05-11",
+                "endDate": "2021-05-15",
+                "preferredTime": "10:00 AM",
+                "frequencyCadence": "Daily",
+                "criteriaMatchType": "MatchAny",
+                "criteriaExpression": "1 OR 2",
+                "status": "Active",
+                "filterCriteria": []
+              }
+            }
+        invalidConfigs:
+          - |
+            {
+              "schedulerName": "Batch Scheduler"
+            }
+          - |
+            {
+              "schedulerName": "Batch Scheduler",
+              "startDate": "2021-05-11",
+              "endDate": "2021-05-15",
+              "preferredTime": "10:00 AM",
+              "frequencyCadence": "Daily",
+              "criteriaMatchType": "MatchAny",
+              "criteriaExpression": "1 OR 2",
+              "status": "Draft",
+              "filterCriteria": []
+            }
+          - |
+            { "PaymentsBatchSchedulerInput":
+              {
+                "schedulerName": "Batch Scheduler"
+              }
+            }
+/commerce/invoicing/invoice-schedulers:
+  post:
+    (luvio.adapter):
+      name: createInvoicesBatchScheduler
+      tests:
+        validConfigs:
+          - |
+            { "BatchInvoiceSchedulerInput":
+              {
+                "schedulerName": "Invoice Batch Scheduler",
+                "startDate": "2021-05-11",
+                "endDate": "2021-05-15",
+                "preferredTime": "10:00 AM",
+                "frequencyCadence": "Monthly",
+                "timezone": "America/Los_Angeles",
+                "status" : "Active",
+                "frequencyCadenceOptions": {
+                  "recurringSubType": "Every",
+                  "recursOn": "First",
+                  "recursOnDay": "Monday"
+                 },
+                "filterCriteria":
+                  [
+                    {
+                        "objectName": "BillingSchedule",
+                        "fieldName": "Currency_Iso_code",
+                        "operation": "Equals",
+                        "value": "USD",
+                        "criteriaSequence": 1
+                    },
+                    {
+                        "objectName": "BillingSchedule",
+                        "fieldName": "InvoiceRunBatch",
+                        "operation": "Equals",
+                        "value": "Batch1",
+                        "criteriaSequence": 2
+                    }
+                  ]
+                }
+              }
+          - |
+            { "BatchInvoiceSchedulerInput":
+              {
+                "schedulerName": "Invoice Batch Scheduler",
+                "startDate": "2021-05-11",
+                "endDate": "2021-05-15",
+                "preferredTime": "10:00 AM",
+                "frequencyCadence": "Monthly",
+                "timezone": "America/Los_Angeles",
+                "status" : "Active",
+                "frequencyCadenceOptions": {
+                  "recurringSubType": "SpecificDate",       
+                  "recursOnDate": "21"
+                 },
+                "filterCriteria":
+                  [
+                    {
+                        "objectName": "BillingSchedule",
+                        "fieldName": "Currency_Iso_code",
+                        "operation": "Equals",
+                        "value": "USD",
+                        "criteriaSequence": 1
+                    },
+                    {
+                        "objectName": "BillingSchedule",
+                        "fieldName": "InvoiceRunBatch",
+                        "operation": "Equals",
+                        "value": "Batch1",
+                        "criteriaSequence": 2
+                    }
+                  ]
+                }
+              }
+          - |
+            { "BatchInvoiceSchedulerInput":
+              {
+                "schedulerName": "Invoice Batch Scheduler",
+                "startDate": "2021-05-11",
+                "endDate": "2021-05-15",
+                "preferredTime": "10:00 AM",
+                "frequencyCadence": "Daily",
+                "timezone": "America/Los_Angeles",
+                "status" : "Active",
+                "frequencyCadenceOptions": {
+                 },
+                "filterCriteria":
+                  [
+                    {
+                        "objectName": "BillingSchedule",
+                        "fieldName": "Currency_Iso_code",
+                        "operation": "Equals",
+                        "value": "USD",
+                        "criteriaSequence": 1
+                    },
+                    {
+                        "objectName": "BillingSchedule",
+                        "fieldName": "InvoiceRunBatch",
+                        "operation": "Equals",
+                        "value": "Batch1",
+                        "criteriaSequence": 2
+                    }
+                  ]
+                }
+              }
+          - |
+            { "BatchInvoiceSchedulerInput":
+              {
+                "schedulerName": "Invoice Batch Scheduler",
+                "startDate": "2021-05-11",
+                "preferredTime": "10:00 AM",
+                "frequencyCadence": "Once",
+                "timezone": "America/Los_Angeles",
+                "status" : "Active",
+                "frequencyCadenceOptions": {
+                 },
+                "filterCriteria":
+                  [
+                    {
+                        "objectName": "BillingSchedule",
+                        "fieldName": "Currency_Iso_code",
+                        "operation": "Equals",
+                        "value": "USD",
+                        "criteriaSequence": 1
+                    },
+                    {
+                        "objectName": "BillingSchedule",
+                        "fieldName": "InvoiceRunBatch",
+                        "operation": "Equals",
+                        "value": "Batch1",
+                        "criteriaSequence": 2
+                    }
+                  ]
+                }
+              }
+          - |
+            { "BatchInvoiceSchedulerInput":
+              {
+                "schedulerName": "Invoice Batch Scheduler",
+                "startDate": "2021-05-11",
+                "endDate": "2021-05-15",
+                "preferredTime": "10:00 AM",
+                "frequencyCadence": "Weekly",
+                "timezone": "America/Los_Angeles",
+                "status" : "Active",
+                "frequencyCadenceOptions": {
+                  "recursOnDay": "Monday"
+                 },
+                "filterCriteria":
+                  [
+                    {
+                        "objectName": "BillingSchedule",
+                        "fieldName": "Currency_Iso_code",
+                        "operation": "Equals",
+                        "value": "USD",
+                        "criteriaSequence": 1
+                    },
+                    {
+                        "objectName": "BillingSchedule",
+                        "fieldName": "InvoiceRunBatch",
+                        "operation": "Equals",
+                        "value": "Batch1",
+                        "criteriaSequence": 2
+                    }
+                  ]
+                }
+              }
+          - |
+            { "BatchInvoiceSchedulerInput":
+              {
+                "schedulerName": "Invoice Batch Scheduler",
+                "startDate": "2021-05-11",
+                "endDate": "2021-05-15",
+                "preferredTime": "10:00 AM",
+                "frequencyCadence": "Monthly",
+                "timezone": "America/Los_Angeles",
+                "status" : "Active",
+                "frequencyCadenceOptions": {
+                  "recurringSubType": "Every",
+                  "recursOn": "First",
+                  "recursOnDay": "Monday"
+                 },
+                "filterCriteria": []
+              }
+            }
+        invalidConfigs:
+          - |
+            {
+              "schedulerName": "Batch Scheduler"
+            }
+          - |
+            {
+              "schedulerName": "Batch Scheduler",
+              "startDate": "2021-05-11",
+              "endDate": "2021-05-15",
+              "preferredTime": "10:00 AM",
+              "frequencyCadence": "Daily",
+              "timezone": "America/Los_Angeles",
+              "status" : "Draft",
+              "frequencyCadenceOptions": {
+                  "recurringSubType": "Every",
+                  "recursOn": "First",
+                  "recursOnDay": "Monday"
+              },
+              "filterCriteria": []
+            }
+          - |
+            {
+              "schedulerName": "Batch Scheduler",
+              "startDate": "2021-05-11",
+              "endDate": "2021-05-15",
+              "preferredTime": "10:00 AM",
+              "frequencyCadence": "Daily",
+              "timezone": "America/Los_Angeles",
+              "status" : "Draft",
+              "frequencyCadenceOptions": {
+                  "recurringSubType": "Every",
+                  "recursOn": "First",
+                  "recursOnDate": "21",
+                  "recursOnDay": "Monday"
+              },
+              "filterCriteria": []
+            }
+          - |
+            { "BatchInvoiceSchedulerInput":
+              {
+                "schedulerName": "Batch Scheduler"
+              }
+            }