synctos/samples/fragment-payment-processor-settlement.js

The Syncmaker. A tool to build comprehensive sync functions for Couchbase Sync Gateway.

function() {
  return {
    typeFilter: function(doc, oldDoc) {
      var typeRegex =
        createBusinessEntityRegex('paymentProcessor\\.[A-Za-z0-9_-]+\\.processedSettlement\\.[A-Za-z0-9_-]+');

      return typeRegex.test(doc._id);
    },
    channels: function(doc, oldDoc) {
      // Only staff/service users can create, replace or delete payment processor settlements to prevent regular users from tampering
      return {
        view: toSyncChannel(doc.businessId, 'VIEW_PAYMENT_PROCESSOR_SETTLEMENTS'),
        write: 'payment-settlement-write'
      };
    },
    authorizedRoles: defaultAuthorizedRoles,
    authorizedUsers: defaultAuthorizedUsers,
    documentIdRegexPattern: function(doc) {
      // Note that this regex uses double quotes rather than single quotes as a workaround to https://github.com/Kashoo/synctos/issues/116
      return new RegExp("^biz\\." + doc.businessId + "\\.paymentProcessor\\." + doc.processorId + "\\.processedSettlement\\." + doc.settlementId + "$");
    },
    immutable: true,
    propertyValidators: {
      businessId: {
        // The ID of the business with which the settlement is associated
        type: 'integer',
        required: true,
        immutable: true,
        minimumValue: 1
      },
      transferId: {
        // The ID of the Books transfer record that represents the settlement
        type: 'integer',
        required: true,
        minimumValue: 1,
        immutable: true
      },
      settlementId: {
        // The ID of the settlement as provided by the payment processor
        type: 'string',
        required: true,
        immutable: true
      },
      processorId: {
        // The Kashoo payment processor associated with the settlement
        type: 'string',
        required: true,
        immutable: true
      },
      capturedAt: {
        // The date that the settlement was completed (captured)
        type: 'datetime',
        required: true,
        immutable: true
      },
      processedAt: {
        // The date/time at which the settlement was processed/imported to Kashoo
        type: 'datetime',
        required: true,
        immutable: true
      },
      amount: {
        // The raw amount that was paid as an integer (e.g. 19999)
        type: 'integer',
        minimumValue: 1,
        required: true
      },
      currency: {
        // The currency of the settlement amount
        type: 'string',
        required: true,
        regexPattern: iso4217CurrencyCodeRegex
      },
      processorMessage: {
        // The message specified by the payment processor as part of the settlement
        type: 'string'
      }
    }
  };
}