@tillhub/schemas 6.458.0 → 6.460.0

package/lib/v0/analytics/reports/payment_options/get.js

@@ -0,0 +1,58 @@
+module.exports.request = {
+  $id: 'https://schemas.tillhub.com/v0/analytics.reports.payment_options.get.all.query.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  type: 'object',
+  additionalProperties: true,
+  required: [],
+  properties: {
+    cursor_field: {
+      type: 'string',
+      description: 'which column to cursor on. To indicate the sorting order, add a `+` or `-` for asc/desc order'
+    },
+    legacy: {
+      type: 'boolean',
+      desciption: 'flags to us legacy table fr_transaction_payment'
+    },
+    format: {
+      type: 'string',
+      description: 'to get data in any other format then JSON straight away, you can set `format=csv`'
+    },
+    context_locations: {
+      type: 'string',
+      description: 'context locations id as a filter for transactions'
+    },
+    branch_number: {
+      oneOf: [
+        {
+          type: 'integer',
+          description: 'Filter by branch number if legacy parameter set or filter by branch UUID otherwise'
+        },
+        {
+          type: 'string',
+          format: 'uuid',
+          example: '9d110eb2-2245-4e14-9574-49b502f3a9b3'
+        }
+      ]
+    },
+    branch_group: {
+      oneOf: [
+        {
+          type: 'string',
+          description: 'filter by branches within branch group. Not applied if branch_number parameter received'
+        },
+        {
+          type: 'array',
+          items: {
+            type: 'string'
+          }
+        }
+      ]
+    },
+    staff_id: {
+      type: 'string',
+      format: 'uuid',
+      description: 'filter by staff id',
+      example: '9d110eb2-2245-4e14-9574-49b502f3a9b3'
+    }
+  }
+}

package/lib/v0/analytics/reports/payment_options/index.js

@@ -1,3 +1,4 @@
 module.exports = {
-  export: require('./export')
+  export: require('./export'),
+  get: require('./get')
 }

package/lib/v1/configurations/items/settings.js

@@ -1010,7 +1010,7 @@ module.exports = {
           required: ['shop_name']
         },
         payment_links: {
-          description: 'Payment link creation defaults.',
+          description: 'Payment link creation defaults and merchant notifications.',
           type: 'object',
           additionalProperties: false,
           properties: {
@@ -1023,7 +1023,24 @@ module.exports = {
               description: 'Default usage mode for LinkPay payment links.',
               type: 'string',
               enum: ['single_use', 'multi_use']
-            }
+            },
+            merchant_notification: oneOf({
+              description: 'Merchant email notifications for successful payment link authorizations and captures.',
+              type: 'object',
+              additionalProperties: false,
+              required: ['enabled', 'email'],
+              properties: {
+                enabled: {
+                  description: 'Enable merchant payment notification emails.',
+                  type: 'boolean'
+                },
+                email: {
+                  description: 'Recipient email address for merchant payment notifications.',
+                  type: 'string',
+                  format: 'email'
+                }
+              }
+            })
           }
         },
         hide_empty_fields: oneOf({

package/package.json

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

package/test/configurations/configurations.v1.spec.js

@@ -34,6 +34,70 @@ test('Configurations: patch schema validation', function (t) {
   t.end()
 })
 
+;['create', 'update', 'patch'].forEach(function (operation) {
+  const request = require('../../lib/v1/configurations')[operation].request
+  const validatePayload = ajv.compile(request)
+  const payload = function (paymentLinks) {
+    return {
+      ...(operation === 'create' ? { name: 'Payment link configuration', owner: 'self' } : {}),
+      settings: { payment_links: paymentLinks }
+    }
+  }
+
+  test(`Configurations: ${operation} accepts merchant notification settings`, function (t) {
+    const cases = [
+      ['configured notifications with existing defaults', {
+        default_expiry_days: 7,
+        default_usage_mode: 'single_use',
+        merchant_notification: { enabled: true, email: 'merchant@example.com' }
+      }],
+      ['omitted notifications with existing defaults', {
+        default_expiry_days: 14,
+        default_usage_mode: 'multi_use'
+      }],
+      ['omitted notifications and defaults', {}],
+      ['null notifications', { merchant_notification: null }],
+      ['disabled notifications with an email', {
+        merchant_notification: { enabled: false, email: 'merchant@example.com' }
+      }]
+    ]
+    t.plan(cases.length)
+    cases.forEach(function ([description, paymentLinks]) {
+      const valid = validatePayload(payload(paymentLinks))
+      t.ok(valid, `${description}: ${ajv.errorsText(validatePayload.errors)}`)
+    })
+    t.end()
+  })
+
+  test(`Configurations: ${operation} rejects invalid merchant notification settings`, function (t) {
+    const cases = [
+      ['enabled-only notifications', { enabled: true }],
+      ['disabled notifications without an email', { enabled: false }],
+      ['email-only notifications', { email: 'merchant@example.com' }],
+      ['empty notifications', {}],
+      ['a string enabled flag', { enabled: 'true', email: 'merchant@example.com' }],
+      ['a null enabled flag', { enabled: null, email: 'merchant@example.com' }],
+      ['a null email', { enabled: true, email: null }],
+      ['a malformed email', { enabled: true, email: 'not-an-email' }],
+      ['a numeric email', { enabled: true, email: 123 }],
+      ['a boolean email', { enabled: true, email: false }],
+      ['an object email', { enabled: true, email: {} }],
+      ['an array email', { enabled: true, email: ['merchant@example.com'] }],
+      ['an unknown notification property', {
+        enabled: true,
+        email: 'merchant@example.com',
+        recipient: 'merchant@example.com'
+      }],
+      ['a non-object notification block', 'enabled']
+    ]
+    t.plan(cases.length)
+    cases.forEach(function ([description, merchantNotification]) {
+      t.notOk(validatePayload(payload({ merchant_notification: merchantNotification })), description)
+    })
+    t.end()
+  })
+})
+
 test('Configurations: opening_hours_exceptions accepts Open all-day, Open hours, and Closed full-day', function (t) {
   t.plan(1)
   const valid = validateUpdatePayload({