@tillhub/schemas 6.184.0 → 6.186.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [6.186.0](https://github.com/tillhub/schemas/compare/v6.185.0...v6.186.0) (2022-12-16)
+
+
+### Features
+
+* **webhooks:** use snake schema #UNTIL-5887 ([0dc2fb1](https://github.com/tillhub/schemas/commit/0dc2fb1)), closes [#UNTIL-5887](https://github.com/tillhub/schemas/issues/UNTIL-5887)
+
+# [6.185.0](https://github.com/tillhub/schemas/compare/v6.184.0...v6.185.0) (2022-12-15)
+
+
+### Features
+
+* **stocks-book:** improve multiline formatting #UNTIL-5820 ([a93bc25](https://github.com/tillhub/schemas/commit/a93bc25)), closes [#UNTIL-5820](https://github.com/tillhub/schemas/issues/UNTIL-5820)
+
 # [6.184.0](https://github.com/tillhub/schemas/compare/v6.183.0...v6.184.0) (2022-12-15)
 
 

package/lib/common/webhooks.js

@@ -8,34 +8,34 @@ module.exports.getEvent = function getEvent (payload, {
     type: 'object',
     additionalProperties: false,
     properties: {
-      webhookId: {
+      webhook_id: {
         description: 'The webhook UUID',
         example: 'ff30cfdf-5167-4f72-b4fc-c1d72db3c07e',
         type: 'string',
         format: 'uuid'
       },
-      eventId: {
+      event_id: {
         description: 'The event UUID',
         example: 'c6fe918a-7bdc-4ccd-af36-95c03853233d',
         type: 'string',
         format: 'uuid'
       },
-      eventEntity: {
+      event_entity: {
         description: 'The entity name the event refers to',
         example: eventEntityExample,
         type: 'string'
       },
-      eventType: {
+      event_type: {
         description: 'The event type (e.g. create, update, delete)',
         example: eventTypeExample,
         type: 'string'
       },
-      eventVersion: {
+      event_version: {
         description: 'The event payload version',
         example: eventVersionExample,
         type: 'number'
       },
-      entityInstanceId: {
+      entity_instance_id: {
         description: 'The entity instance UUID',
         example: '10b06f38-031d-4e0c-8706-0474c8c5b61c',
         type: 'string',

package/lib/v0/stocks_book/create.js

@@ -1,3 +1,4 @@
+const { stripIndents } = require('common-tags')
 const pick = require('just-pick')
 const { oneOf } = require('../../helpers/payload-or-null')
 const baseObject = require('../../common/base')
@@ -15,11 +16,16 @@ const baseStockBook = require('./base').simple
 const eventTypeEnum = ['transfer', 'sale', 'delivery_note']
 
 const eventBaseData = pick({
-  ...baseObject({ entityName: 'stock book' }),
+  ...baseObject({ entityName: 'stock booking' }),
   ...baseStockBook,
   type: {
     ...baseStockBook.type,
-    description: `The type of stock booking: \n'transfer' - indicates a stock change made by the operator for the logistic purpose, positive value for goods-in and negative value for goods-out \n'sale' - indicates a stock change triggered by a sale, positive value for a successful transaction and negative value for a refund or cancellation \n'delivery_note' - indicates a stock change triggered by a delivery note, positive value for a successful delivery note and negative value for a refund or cancellation`,
+    description: stripIndents`
+    The type of stock booking:
+    'transfer' - indicates a stock change made by the operator for the logistic purpose, positive value for goods-in and negative value for goods-out;
+    'sale' - indicates a stock change triggered by a sale, positive value for a successful transaction and negative value for a refund or cancellation;
+    'delivery_note' - indicates a stock change triggered by a delivery note, positive value for a successful delivery note and negative value for a refund or cancellation
+    `,
     enum: eventTypeEnum
   }
 }, ['id', 'created_at', 'qty_change', 'type'])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tillhub/schemas",
-  "version": "6.184.0",
+  "version": "6.186.0",
   "private": false,
   "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
   "main": "./lib/index.js",