@tillhub/schemas 6.448.0 → 6.449.0

package/lib/v0/vouchers/export.js

@@ -0,0 +1,69 @@
+module.exports.request = {
+  $id: 'https://schemas.tillhub.com/v0/vouchers.export.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  type: 'object',
+  additionalProperties: true,
+  required: ['format', 'documentType', 'email'],
+  properties: {
+    start: { type: 'string', format: 'date-time' },
+    updated_start: { type: 'string', format: 'date-time' },
+    updated_end: { type: 'string', format: 'date-time' },
+    deleted: { type: 'string', enum: ['true', 'false'] },
+    active: { type: 'string', enum: ['true', 'false'] },
+    issuable: { type: 'string', enum: ['true', 'false'] },
+    reissuable: { type: 'string', enum: ['true', 'false'] },
+    restriction_single_transaction: { type: 'string', enum: ['true', 'false'] },
+    partial_redemption: { type: 'string', enum: ['true', 'false'] },
+    limited_to_region: { type: 'string', enum: ['true', 'false'] },
+    refundable: { type: 'string', enum: ['true', 'false'] },
+    mutable: { type: 'string', enum: ['true', 'false'] },
+    exchange_for_cash: { type: 'string', enum: ['true', 'false'] },
+    is_campaign: { type: 'string', enum: ['true', 'false'] },
+    code: { type: 'string' },
+    regions: {
+      oneOf: [
+        { type: 'array', minItems: 1, items: { type: 'string', minLength: 2, maxLength: 2 } },
+        { type: 'string', minLength: 2, maxLength: 2 }
+      ]
+    },
+    system: {
+      oneOf: [
+        { type: 'array', minItems: 1, items: { type: 'string', format: 'uuid' } },
+        { type: 'string', format: 'uuid' }
+      ]
+    },
+    voucher_system: { type: 'string', format: 'uuid' },
+    amount_from: { type: 'string', minLength: 1, maxLength: 15 },
+    amount_to: { type: 'string', minLength: 1, maxLength: 15 },
+    expires_at_start: { type: 'string', format: 'date-time' },
+    expires_at_end: { type: 'string', format: 'date-time' },
+    location: {
+      oneOf: [
+        { type: 'string' },
+        { type: 'array', items: { type: 'string' } }
+      ]
+    },
+    q: { type: 'string' },
+    cursor_field: { type: 'string' },
+    filename_prefix: { type: 'string' },
+    timezone: { type: 'string' },
+    limit: { type: 'string', maxLength: 10 },
+    offset: { type: 'string', maxLength: 10 },
+    page: { type: 'string', maxLength: 10 },
+    size: { type: 'string', maxLength: 10 },
+    pageSize: { type: 'string', maxLength: 10 },
+
+    format: { type: 'string', enum: ['csv', 'xls'] },
+    delimiter: { type: 'string', enum: ['comma', 'semicolon'] },
+    enclosure: { type: 'string', enum: ['single', 'double'] },
+    show_column_name: { type: 'string', enum: ['true', 'false'] },
+    column_selection: { type: 'array', items: { type: 'string' } },
+
+    documentType: { type: 'string', enum: ['VouchersListExport'] },
+    email: { type: 'string', minLength: 5 },
+    lang: { type: 'string' },
+    scheduled_id: { type: 'string', minLength: 1, maxLength: 64 },
+    existingId: { type: 'string', format: 'uuid' },
+    correlationId: { type: 'string', format: 'uuid' }
+  }
+}

package/lib/v0/vouchers/index.js

@@ -4,3 +4,4 @@ module.exports.incrementOrDecrement = require('./increment-or-decrement')
 module.exports.get = require('./get')
 module.exports.customers = require('./customers')
 module.exports.bulk = require('./bulk')
+module.exports.export = require('./export')

package/lib/v0/vouchers/query.js

@@ -125,5 +125,38 @@ module.exports = {
   expires_at_end: {
     type: 'string',
     format: 'date-time'
+  },
+  updated_start: {
+    type: 'string',
+    format: 'date-time'
+  },
+  updated_end: {
+    type: 'string',
+    format: 'date-time'
+  },
+  system: {
+    oneOf: [
+      {
+        type: 'array',
+        minItems: 1,
+        items: {
+          type: 'string',
+          format: 'uuid'
+        }
+      },
+      {
+        type: 'string',
+        format: 'uuid'
+      }
+    ]
+  },
+  location: {
+    oneOf: [
+      { type: 'string' },
+      { type: 'array', items: { type: 'string' } }
+    ]
+  },
+  q: {
+    type: 'string'
   }
 }

package/package.json

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

package/test/vouchers/vouchers.v0.spec.js

@@ -36,3 +36,12 @@ test('Vouchers: bulk create schema validation', function (t) {
   t.error(error, 'should not get any error')
   t.end()
 })
+
+test('Vouchers: export request schema validation', function (t) {
+  t.plan(2)
+  const exportRequest = require('../../lib/v0/vouchers').export.request
+  const { valid, error } = validate(exportRequest)
+  t.ok(valid, 'export request schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})