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

package/src/raml/api.raml

@@ -0,0 +1,447 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.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:
+  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
+          - InList
+      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
+  # TODO Hand-rolled W-14972264
+  BatchInvoiceDocGenErrorRepresentation:
+    description: Connect API representation for batch invoice doc gen error response.
+    type: object
+    properties:
+      errorCode:
+        description: Error Code of the error thrown.
+        type: string
+      errorMessage:
+        description: Error Message of the error thrown.
+        type: string
+  BatchInvoiceDocGenOutputRepresentation:
+    description: Connect API representation for batch invoice doc gen output response.
+    type: object
+    properties:
+      errors:
+        description: Error response if there were issues while enqueuing
+        type: array
+        items:
+          type: BatchInvoiceDocGenErrorRepresentation
+      requestIdentifier:
+        description: Unique request identifier that can be used to poll async request
+        type: string
+      success:
+        description: Status of enqueuing Invoice PDF Generation job
+        type: boolean
+  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
+        required: false
+        type: string
+      schedulerName:
+        description: Name of the batch scheduler
+        type: string
+      startDate:
+        description: Batch Job Start Date
+        required: false
+        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
+        required: false
+        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
+  BatchInvoiceSchedulerUpdateInputWrapperRepresentation:
+    description: Wrapper for BatchInvoice Scheduler Update Input Representation
+    type: object
+    properties:
+      BatchInvoiceSchedulerUpdateInput:
+        type: BatchInvoiceSchedulerUpdateInputRepresentation
+        description: BatchInvoice Scheduler Update Input Representation
+  BatchInvoiceSchedulerUpdateInputRepresentation:
+    type: object
+    description: BatchInvoice Scheduler Update Input Representation
+    properties:
+      status:
+        description: Billing Batch Scheduler Status
+        type: string
+        enum:
+          - Active
+          - Canceled
+          - Draft
+          - Inactive
+  BatchInvoiceSchedulerUpdateOutputRepresentation:
+    type: object
+    description: BatchInvoice Scheduler Update Output Representation
+    properties:
+      status:
+        description: Status
+        type: string
+        enum:
+          - Active
+          - Canceled
+          - Draft
+          - Inactive
+  InvoiceBatchDraftToPostedInputRepresentation:
+    description: Invoice Batch Draft To Posted Input Representation
+    type: object
+    properties: {}
+  InvoiceBatchDraftToPostedOutputRepresentation:
+    description: Invoice Batch Draft To Posted Output Representation
+    type: object
+    properties:
+      invoiceBatchDraftToPostedId:
+        description: Invoice Batch Draft To Posted ID
+        type: string
+      success:
+        description: Flag indicating the overall enqueue status
+        type: boolean
+  InvoiceBatchRunRecoveryOutputRepresentation:
+    type: object
+    description: Invoice Batch Run Recovery Output Representation
+    properties:
+      invoiceBatchRunRecoveryId:
+        description: Invoice Batch Run Recovery ID
+        type: string
+  CronExecutionDatesInputRepresentation:
+    description: Cron Execution Dates Input Representation
+    type: object
+    properties:
+      numberOfNextExecutionDates:
+        description: Number of next execution dates to be returned for the Batch Job
+        type: integer
+      startDate:
+        description: Batch Job Start Date
+        type: string
+      timezone:
+        description: Preferred Time Zone of the invoice Scheduler
+        type: string
+      frequencyCadenceOptions:
+        description: Frequency Cadence Options for Invoice Scheduler
+        type: any
+      frequencyCadence:
+        description: Frequency Cadence for the Batch Job
+        type: string
+        enum:
+          - Daily
+          - Monthly
+          - Once
+          - Weekly
+      preferredTime:
+        description: Batch Job Preferred Run Time
+        type: string
+  CronExecutionDatesOutputRepresentation:
+    description: Cron Execution Dates Output Representation
+    type: object
+    properties:
+      executionDates:
+        description: Execution Dates
+        type: array
+        items:
+          type: string
+/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
+/commerce/invoicing/invoice-schedulers/{billingBatchSchedulerId}:
+  put:
+    displayName: editInvoicesBatchScheduler
+    description: Edit Invoices Batch Job Scheduler
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: InvoicesBatchSchedulerOutputRepresentation
+    body:
+      application/json:
+        type: BatchInvoiceSchedulerInputWrapperRepresentation
+        (oas-body-name): BatchInvoiceSchedulerInput
+  patch:
+    displayName: updateInvoicesBatchScheduler
+    description: Update Batch Invoice Job Scheduler
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: BatchInvoiceSchedulerUpdateOutputRepresentation
+    body:
+      application/json:
+        type: BatchInvoiceSchedulerUpdateInputWrapperRepresentation
+        (oas-body-name): BatchInvoiceSchedulerUpdateInput
+  uriParameters:
+    billingBatchSchedulerId:
+      type: string
+      required: true
+/commerce/invoicing/invoice-batch-runs/{invoiceBatchRunId}/actions/draft-to-posted:
+  post:
+    displayName: postInvoiceBatchDraftToPosted
+    description: Trigger a BatchInvoice Draft to Posted
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: InvoiceBatchDraftToPostedOutputRepresentation
+    body:
+      application/json:
+        type: InvoiceBatchDraftToPostedInputRepresentation
+        #required: false # TODO handrolled W-13817376
+        (oas-body-name): invoiceBatchDraftToPostedInput
+  uriParameters:
+    invoiceBatchRunId:
+      type: string
+      required: true
+/commerce/invoicing/invoice-batch-runs/{invoiceBatchRunId}/actions/recover:
+  post:
+    displayName: batchInvoiceRunRecovery
+    description: Trigger a BatchInvoiceRun recovery
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: InvoiceBatchRunRecoveryOutputRepresentation
+  uriParameters:
+    invoiceBatchRunId:
+      type: string
+      required: true
+# TODO Hand-rolled W-14972264 + W-15776899
+/commerce:
+  /billing/invoices/invoice-batch-docgen/{invoiceBatchRunId}/actions/{actionName}:
+    post:
+      displayName: postBatchInvoiceDocGen
+      description: Generate batch invoice documents
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: BatchInvoiceDocGenOutputRepresentation
+    uriParameters:
+      invoiceBatchRunId:
+        type: string
+        required: true
+      actionName:
+        type: string
+        required: true
+/connect/billing/batch/cron/execution-dates:
+  post:
+    displayName: postCronExecutionDates
+    description: Get Execution Dates
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: CronExecutionDatesOutputRepresentation
+    body:
+      application/json:
+        type: CronExecutionDatesInputRepresentation
+        (oas-body-name): CronExecutionDatesInput