apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/voucher_config.rb

@@ -0,0 +1,92 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Configuration for Voucher.
+  class VoucherConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Issuer of the voucher
+    # @return [String]
+    attr_reader :issuer
+
+    # The maximum number of vouchers that can be used for this order.
+    # @return [Integer]
+    attr_accessor :max_vouchers
+
+    # The maximum amount that can be authorized with voucher in this order.
+    # In most cases, this is the total amount of "PACKAGE" authorization group
+    # on the order.
+    # @return [Integer]
+    attr_accessor :max_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['issuer'] = 'issuer'
+      @_hash['max_vouchers'] = 'maxVouchers'
+      @_hash['max_amount'] = 'maxAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        max_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(max_vouchers:, max_amount: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @issuer = 'SWAV_PAYMENT_GATEWAY'
+      @max_vouchers = max_vouchers
+      @max_amount = max_amount unless max_amount == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      max_vouchers = hash.key?('maxVouchers') ? hash['maxVouchers'] : nil
+      max_amount = hash.key?('maxAmount') ? hash['maxAmount'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      VoucherConfig.new(max_vouchers: max_vouchers,
+                        max_amount: max_amount,
+                        additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} issuer: #{@issuer}, max_vouchers: #{@max_vouchers}, max_amount:"\
+      " #{@max_amount}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} issuer: #{@issuer.inspect}, max_vouchers: #{@max_vouchers.inspect},"\
+      " max_amount: #{@max_amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/voucher_issuer.rb

@@ -0,0 +1,26 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Issuer of the voucher
+  class VoucherIssuer
+    VOUCHER_ISSUER = [
+      # TODO: Write general description for SWAV_PAYMENT_GATEWAY
+      SWAV_PAYMENT_GATEWAY = 'SWAV_PAYMENT_GATEWAY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VOUCHER_ISSUER.include?(value)
+    end
+
+    def self.from_value(value, default_value = SWAV_PAYMENT_GATEWAY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/cell_point_api/models/voucher_payment_instrument.rb

@@ -0,0 +1,233 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module CellPointApi
+  # A payment instrument used for voucher-based transactions.
+  class VoucherPaymentInstrument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Payment method type.
+    # @return [PaymentMethod]
+    attr_accessor :method
+
+    # Payment method type.
+    # @return [String]
+    attr_accessor :id
+
+    # Reference for identifying an order in the merchant's system. This is
+    # mandatory for some issuers, such as SWAV.
+    # @return [String]
+    attr_accessor :merchant_order_reference
+
+    # Issuer of the voucher
+    # @return [String]
+    attr_reader :issuer
+
+    # The type number of the voucher.
+    # @return [String]
+    attr_accessor :number
+
+    # Type of voucher
+    # @return [VoucherType]
+    attr_accessor :type
+
+    # Type of voucher
+    # @return [Owner]
+    attr_accessor :owner
+
+    # The amount available on the voucher, at the latest transaction event. In a
+    # refund scenario, this is the amount that will be refunded to this voucher.
+    # @return [NonNegativeAmount]
+    attr_accessor :amount
+
+    # Date-time that asset was created.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Date-time that asset is set to expire.
+    # @return [DateTime]
+    attr_accessor :expires_at
+
+    # Custom data to attach as a pass through for the voucher.
+    # **No sensative data should ever be passed in custom fields.**
+    # > Note: These properties are not used by CellPoint Digital for any payment
+    # processing and will not be passed to any acquirers.
+    # @return [Hash[String, String]]
+    attr_accessor :custom
+
+    # Indicates whether this voucher is currently valid and can be used for
+    # payment or refund operations.
+    # This reflects the usability of the voucher at the time of the request
+    # considering issuer status,
+    # activation, expiration and any other business rules.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_valid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['method'] = 'method'
+      @_hash['id'] = 'id'
+      @_hash['merchant_order_reference'] = 'merchantOrderReference'
+      @_hash['issuer'] = 'issuer'
+      @_hash['number'] = 'number'
+      @_hash['type'] = 'type'
+      @_hash['owner'] = 'owner'
+      @_hash['amount'] = 'amount'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['expires_at'] = 'expiresAt'
+      @_hash['custom'] = 'custom'
+      @_hash['is_valid'] = 'isValid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_order_reference
+        number
+        type
+        owner
+        amount
+        created_at
+        expires_at
+        custom
+        is_valid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(method:, id:, merchant_order_reference: SKIP, number: SKIP,
+                   type: SKIP, owner: SKIP, amount: SKIP, created_at: SKIP,
+                   expires_at: SKIP, custom: SKIP, is_valid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @method = method
+      @id = id
+      @merchant_order_reference = merchant_order_reference unless merchant_order_reference == SKIP
+      @issuer = 'SWAV_PAYMENT_GATEWAY'
+      @number = number unless number == SKIP
+      @type = type unless type == SKIP
+      @owner = owner unless owner == SKIP
+      @amount = amount unless amount == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @expires_at = expires_at unless expires_at == SKIP
+      @custom = custom unless custom == SKIP
+      @is_valid = is_valid unless is_valid == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      method = hash.key?('method') ? hash['method'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      merchant_order_reference =
+        hash.key?('merchantOrderReference') ? hash['merchantOrderReference'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      owner = Owner.from_hash(hash['owner']) if hash['owner']
+      amount = NonNegativeAmount.from_hash(hash['amount']) if hash['amount']
+      created_at = if hash.key?('createdAt')
+                     (DateTimeHelper.from_rfc3339(hash['createdAt']) if hash['createdAt'])
+                   else
+                     SKIP
+                   end
+      expires_at = if hash.key?('expiresAt')
+                     (DateTimeHelper.from_rfc3339(hash['expiresAt']) if hash['expiresAt'])
+                   else
+                     SKIP
+                   end
+      custom = hash.key?('custom') ? hash['custom'] : SKIP
+      is_valid = hash.key?('isValid') ? hash['isValid'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      VoucherPaymentInstrument.new(method: method,
+                                   id: id,
+                                   merchant_order_reference: merchant_order_reference,
+                                   number: number,
+                                   type: type,
+                                   owner: owner,
+                                   amount: amount,
+                                   created_at: created_at,
+                                   expires_at: expires_at,
+                                   custom: custom,
+                                   is_valid: is_valid,
+                                   additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_expires_at
+      DateTimeHelper.to_rfc3339(expires_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VoucherPaymentInstrument | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.method,
+                                ->(val) { PaymentMethod.validate(val) }) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.issuer,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['method'],
+                              ->(val) { PaymentMethod.validate(val) }) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['issuer'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method}, id: #{@id}, merchant_order_reference:"\
+      " #{@merchant_order_reference}, issuer: #{@issuer}, number: #{@number}, type: #{@type},"\
+      " owner: #{@owner}, amount: #{@amount}, created_at: #{@created_at}, expires_at:"\
+      " #{@expires_at}, custom: #{@custom}, is_valid: #{@is_valid}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method.inspect}, id: #{@id.inspect}, merchant_order_reference:"\
+      " #{@merchant_order_reference.inspect}, issuer: #{@issuer.inspect}, number:"\
+      " #{@number.inspect}, type: #{@type.inspect}, owner: #{@owner.inspect}, amount:"\
+      " #{@amount.inspect}, created_at: #{@created_at.inspect}, expires_at:"\
+      " #{@expires_at.inspect}, custom: #{@custom.inspect}, is_valid: #{@is_valid.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/voucher_payment_instrument_node.rb

@@ -0,0 +1,198 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module CellPointApi
+  # A voucher payment instrument.
+  class VoucherPaymentInstrumentNode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # Reference for identifying an order in the merchant's system. This is
+    # mandatory for some issuers, such as SWAV.
+    # @return [String]
+    attr_accessor :merchant_order_reference
+
+    # Issuer of the voucher
+    # @return [String]
+    attr_reader :issuer
+
+    # The type number of the voucher.
+    # @return [String]
+    attr_accessor :number
+
+    # Type of voucher
+    # @return [VoucherType]
+    attr_accessor :type
+
+    # Type of voucher
+    # @return [Owner]
+    attr_accessor :owner
+
+    # The amount available on the voucher, at the latest transaction event. In a
+    # refund scenario, this is the amount that will be refunded to this voucher.
+    # @return [NonNegativeAmount]
+    attr_accessor :amount
+
+    # Date-time that asset was created.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Date-time that asset is set to expire.
+    # @return [DateTime]
+    attr_accessor :expires_at
+
+    # Custom data to attach as a pass through for the voucher.
+    # **No sensative data should ever be passed in custom fields.**
+    # > Note: These properties are not used by CellPoint Digital for any payment
+    # processing and will not be passed to any acquirers.
+    # @return [Hash[String, String]]
+    attr_accessor :custom
+
+    # Indicates whether this voucher is currently valid and can be used for
+    # payment or refund operations.
+    # This reflects the usability of the voucher at the time of the request
+    # considering issuer status,
+    # activation, expiration and any other business rules.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_valid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['merchant_order_reference'] = 'merchantOrderReference'
+      @_hash['issuer'] = 'issuer'
+      @_hash['number'] = 'number'
+      @_hash['type'] = 'type'
+      @_hash['owner'] = 'owner'
+      @_hash['amount'] = 'amount'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['expires_at'] = 'expiresAt'
+      @_hash['custom'] = 'custom'
+      @_hash['is_valid'] = 'isValid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_order_reference
+        number
+        type
+        owner
+        amount
+        created_at
+        expires_at
+        custom
+        is_valid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, merchant_order_reference: SKIP, number: SKIP,
+                   type: SKIP, owner: SKIP, amount: SKIP, created_at: SKIP,
+                   expires_at: SKIP, custom: SKIP, is_valid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @merchant_order_reference = merchant_order_reference unless merchant_order_reference == SKIP
+      @issuer = 'SWAV_PAYMENT_GATEWAY'
+      @number = number unless number == SKIP
+      @type = type unless type == SKIP
+      @owner = owner unless owner == SKIP
+      @amount = amount unless amount == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @expires_at = expires_at unless expires_at == SKIP
+      @custom = custom unless custom == SKIP
+      @is_valid = is_valid unless is_valid == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      merchant_order_reference =
+        hash.key?('merchantOrderReference') ? hash['merchantOrderReference'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      owner = Owner.from_hash(hash['owner']) if hash['owner']
+      amount = NonNegativeAmount.from_hash(hash['amount']) if hash['amount']
+      created_at = if hash.key?('createdAt')
+                     (DateTimeHelper.from_rfc3339(hash['createdAt']) if hash['createdAt'])
+                   else
+                     SKIP
+                   end
+      expires_at = if hash.key?('expiresAt')
+                     (DateTimeHelper.from_rfc3339(hash['expiresAt']) if hash['expiresAt'])
+                   else
+                     SKIP
+                   end
+      custom = hash.key?('custom') ? hash['custom'] : SKIP
+      is_valid = hash.key?('isValid') ? hash['isValid'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      VoucherPaymentInstrumentNode.new(id: id,
+                                       merchant_order_reference: merchant_order_reference,
+                                       number: number,
+                                       type: type,
+                                       owner: owner,
+                                       amount: amount,
+                                       created_at: created_at,
+                                       expires_at: expires_at,
+                                       custom: custom,
+                                       is_valid: is_valid,
+                                       additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_expires_at
+      DateTimeHelper.to_rfc3339(expires_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, merchant_order_reference: #{@merchant_order_reference}, issuer:"\
+      " #{@issuer}, number: #{@number}, type: #{@type}, owner: #{@owner}, amount: #{@amount},"\
+      " created_at: #{@created_at}, expires_at: #{@expires_at}, custom: #{@custom}, is_valid:"\
+      " #{@is_valid}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, merchant_order_reference:"\
+      " #{@merchant_order_reference.inspect}, issuer: #{@issuer.inspect}, number:"\
+      " #{@number.inspect}, type: #{@type.inspect}, owner: #{@owner.inspect}, amount:"\
+      " #{@amount.inspect}, created_at: #{@created_at.inspect}, expires_at:"\
+      " #{@expires_at.inspect}, custom: #{@custom.inspect}, is_valid: #{@is_valid.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/voucher_type.rb

@@ -0,0 +1,36 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Type of voucher
+  class VoucherType
+    VOUCHER_TYPE = [
+      # TODO: Write general description for VTC
+      VTC = 'VTC'.freeze,
+
+      # TODO: Write general description for RTF
+      RTF = 'RTF'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VOUCHER_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = VTC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'vtc' then VTC
+      when 'rtf' then RTF
+      else
+        default_value
+      end
+    end
+  end
+end