diff --git a/packages/api-core/src/resources/README.md b/packages/api-core/src/resources/README.md index a270af59e..7c59ed77a 100644 --- a/packages/api-core/src/resources/README.md +++ b/packages/api-core/src/resources/README.md @@ -129,19 +129,44 @@ Upload a batch of files to a designated channel configured on the server. #### `uploadFilesDelivery(data, config)` Method to upload a batch of file deliveries. `data` contains an array of `deliveries`. Provide the `fileUri` (reference field from AvFiles), `deliveryChannel`, and the required `metadata` for that channel. -Example: +Example `data`: ```html data = { deliveries: [ { fileURI: upload.references[0], deliveryChannel: 'DEMO', - metadata: { payerId: "DEMOPAYERID", requestId: "123", patientLastName: "lastName", patientFirstName: "firstName" }, + metadata: { payerId: "PAYERID", requestId: "123", patientLastName: "lastName", patientFirstName: "firstName" }, } ] }; ``` `config` should contain `customerId` and `clientId` +#### Example Response +```html +{ "id": "123456", // batchId + "status": "COMPLETE", // COMPLETE/INPROGRESS + "deliveries": [ + { + "id": "56789", // deliveryId + "deliveryBatchId": "123456", + "fileURI": , + "deliveryChannel": "DEMO", + "deliveryStatus": "ERRORED", // INPROGRESS/REJECTED/ERRORED/DELIVERED + "errors": [ + { + "message": "error message", + "subject": "subject of error" + } + ], + "metadata": { + payerId: "PAYERID", requestId: "123", patientLastName: "lastName", patientFirstName: "firstName" + } + } + ] +} +``` + ### `AvSettings` Store and retrieve settings to be reused.