@salesforce/lds-adapters-revenue-billing-batch 0.1.0-dev1

package/src/raml/luvio.raml

@@ -0,0 +1,664 @@
+#%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
+  BatchInvoiceSchedulerUpdateOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      status: status
+  InvoiceBatchRunRecoveryOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      invoiceBatchRunRecoveryId: invoiceBatchRunRecoveryId
+  InvoiceBatchDraftToPostedOutputRepresentation:
+    (luvio.ttl): 1000
+  BatchInvoiceDocGenOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      requestIdentifier: requestIdentifier
+  CronExecutionDatesOutputRepresentation:
+    (luvio.key):
+      executionDates: executionDates
+    (luvio.ttl): 1000
+
+/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"
+              }
+            }
+
+/commerce/invoicing/invoice-schedulers/{billingBatchSchedulerId}:
+  put:
+    (luvio.adapter):
+      name: editInvoicesBatchScheduler
+      tests:
+        validConfigs:
+          - |
+            { 
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE",
+              "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
+                    }
+                  ]
+                }
+              }
+          - |
+            { 
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE",
+              "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
+                    }
+                  ]
+                }
+              }
+          - |
+            { 
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE",
+              "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
+                    }
+                  ]
+                }
+              }
+          - |
+            { 
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE",
+              "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
+                    }
+                  ]
+                }
+              }
+          - |
+            { 
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE",
+              "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
+                    }
+                  ]
+                }
+              }
+          - |
+            { 
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE",
+              "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"
+              }
+            }
+          - |
+            {
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE"
+            }
+          - |
+            {
+              "BatchInvoiceSchedulerInput":
+              {
+                "schedulerName": "Batch Scheduler"
+              },
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE"
+            }
+  patch:
+    (luvio.adapter):
+      name: updateInvoicesBatchScheduler
+      tests:
+        validConfigs:
+          - |
+            { 
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE",
+              "BatchInvoiceSchedulerUpdateInput":
+              {
+                "status": "Active"
+              }
+            }
+          - |
+            { 
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE",
+              "BatchInvoiceSchedulerUpdateInput":
+              {
+                "status": "Canceled"
+              }
+            }
+          - |
+            { 
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE",
+              "BatchInvoiceSchedulerUpdateInput":
+              {
+                "status": "Draft"
+              }
+            }
+          - |
+            { 
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE",
+              "BatchInvoiceSchedulerUpdateInput":
+              {
+                "status": "Inactive"
+              }
+            }
+        invalidConfigs:
+          - |
+            {
+              "billingBatchSchedulerId": "5BSxx0000004CoyGAE"
+            }
+          - |
+            {
+              "BatchInvoiceSchedulerUpdateInput":
+              {
+                "status": "Inactive"
+              }
+            }
+/commerce/invoicing/invoice-batch-runs/{invoiceBatchRunId}/actions/draft-to-posted:
+  post:
+    (luvio.method): get
+    (luvio.adapter):
+      name: postBatchDraftInvoices
+
+/commerce/invoicing/invoice-batch-runs/{invoiceBatchRunId}/actions/recover:
+  post:
+    (luvio.adapter):
+      name: batchInvoiceRunRecovery
+
+/commerce:
+  /billing/invoices/invoice-batch-docgen/{invoiceBatchRunId}/actions/{actionName}:
+    post:
+      (luvio.adapter):
+        name: postBatchInvoiceDocGen
+/connect/billing/batch/cron/execution-dates:
+  post:
+    (luvio.adapter):
+      name: postCronExecutionDates