@salesforce/lds-adapters-revenue-billing-batch 1.284.0 → 1.285.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/raml/api.raml CHANGED
@@ -48,7 +48,32 @@ types:
48
48
  id:
49
49
  description: Billing Batch Scheduler Id
50
50
  type: string
51
-
51
+ # TODO Hand-rolled W-14972264
52
+ BatchInvoiceDocGenErrorRepresentation:
53
+ description: Connect API representation for batch invoice doc gen error response.
54
+ type: object
55
+ properties:
56
+ errorCode:
57
+ description: Error Code of the error thrown.
58
+ type: string
59
+ errorMessage:
60
+ description: Error Message of the error thrown.
61
+ type: string
62
+ BatchInvoiceDocGenOutputRepresentation:
63
+ description: Connect API representation for batch invoice doc gen output response.
64
+ type: object
65
+ properties:
66
+ errors:
67
+ description: Error response if there were issues while enqueuing
68
+ type: array
69
+ items:
70
+ type: BatchInvoiceDocGenErrorRepresentation
71
+ requestIdentifier:
72
+ description: Unique request identifier that can be used to poll async request
73
+ type: string
74
+ success:
75
+ description: Status of enqueuing Invoice PDF Generation job
76
+ type: boolean
52
77
  PaymentsBatchSchedulerInputWrapperRepresentation: # TODO Hand-rolled W-8334626
53
78
  description: Wrapper for payment batch scheduler input representation
54
79
  type: object
@@ -265,3 +290,20 @@ types:
265
290
  invoiceBatchRunId:
266
291
  type: string
267
292
  required: true
293
+
294
+ # TODO Hand-rolled W-14972264
295
+ /commerce:
296
+ /billing/invoices/invoice-batch-docgen/{invoiceBatchRunId}/actions/run:
297
+ post:
298
+ displayName: postBatchInvoiceDocGen
299
+ description: Generate batch invoice documents
300
+ responses:
301
+ '200':
302
+ description: Success
303
+ body:
304
+ application/json:
305
+ type: BatchInvoiceDocGenOutputRepresentation
306
+ uriParameters:
307
+ invoiceBatchRunId:
308
+ type: string
309
+ required: true
@@ -19,6 +19,10 @@ types:
19
19
  billingBatchSchedulerId: billingBatchScheduler.id
20
20
  InvoiceBatchDraftToPostedOutputRepresentation:
21
21
  (luvio.ttl): 1000
22
+ BatchInvoiceDocGenOutputRepresentation:
23
+ (luvio.ttl): 1000
24
+ (luvio.key):
25
+ requestIdentifier: requestIdentifier
22
26
 
23
27
  /commerce/payments/payment-schedulers:
24
28
  post:
@@ -328,3 +332,9 @@ types:
328
332
  (luvio.method): get
329
333
  (luvio.adapter):
330
334
  name: postBatchDraftInvoices
335
+
336
+ /commerce:
337
+ /billing/invoices/invoice-batch-docgen/{invoiceBatchRunId}/actions/run:
338
+ post:
339
+ (luvio.adapter):
340
+ name: postBatchInvoiceDocGen