apimatic-gp-sdk 0.0.1

data/lib/batches/models/action.rb

@@ -0,0 +1,125 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Action Model.
+  class Action < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique identifier generated by the platform to identify an action.
+    # @return [String]
+    attr_accessor :id
+
+    # Indicates the specific action taken.
+    # @return [TypeBatchesActionType]
+    attr_accessor :type
+
+    # Time indicating when the object was created in ISO-8601 format.
+    # @return [String]
+    attr_accessor :time_created
+
+    # The result of the action executed.
+    # @return [ResultCodeBatchesActionResultCode]
+    attr_accessor :result_code
+
+    # The id of the app that was used to create the token.
+    # @return [String]
+    attr_accessor :app_id
+
+    # The name of the app the user gave to the application.
+    # @return [String]
+    attr_accessor :app_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash['time_created'] = 'time_created'
+      @_hash['result_code'] = 'result_code'
+      @_hash['app_id'] = 'app_id'
+      @_hash['app_name'] = 'app_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        type
+        time_created
+        result_code
+        app_id
+        app_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, type: SKIP, time_created: SKIP, result_code: SKIP,
+                   app_id: SKIP, app_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @type = type unless type == SKIP
+      @time_created = time_created unless time_created == SKIP
+      @result_code = result_code unless result_code == SKIP
+      @app_id = app_id unless app_id == SKIP
+      @app_name = app_name unless app_name == 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'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      time_created = hash.key?('time_created') ? hash['time_created'] : SKIP
+      result_code = hash.key?('result_code') ? hash['result_code'] : SKIP
+      app_id = hash.key?('app_id') ? hash['app_id'] : SKIP
+      app_name = hash.key?('app_name') ? hash['app_name'] : 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.
+      Action.new(id: id,
+                 type: type,
+                 time_created: time_created,
+                 result_code: result_code,
+                 app_id: app_id,
+                 app_name: app_name,
+                 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} id: #{@id}, type: #{@type}, time_created: #{@time_created}, result_code:"\
+      " #{@result_code}, app_id: #{@app_id}, app_name: #{@app_name}, 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}, type: #{@type.inspect}, time_created:"\
+      " #{@time_created.inspect}, result_code: #{@result_code.inspect}, app_id:"\
+      " #{@app_id.inspect}, app_name: #{@app_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/batches/models/authentication_invalid401.rb

@@ -0,0 +1,102 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Not Authenticated
+  class AuthenticationInvalid401 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This action failed as token in the request is not valid.
+    # @return [ErrorCode1]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode1]
+    attr_accessor :detailed_error_code
+
+    # Unique Text describing the specific error.
+    # @return [String]
+    attr_accessor :detailed_error_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_code'] = 'error_code'
+      @_hash['detailed_error_code'] = 'detailed_error_code'
+      @_hash['detailed_error_description'] = 'detailed_error_description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_code
+        detailed_error_code
+        detailed_error_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error_code: SKIP, detailed_error_code: SKIP,
+                   detailed_error_description: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @error_code = error_code unless error_code == SKIP
+      @detailed_error_code = detailed_error_code unless detailed_error_code == SKIP
+      unless detailed_error_description == SKIP
+        @detailed_error_description =
+          detailed_error_description
+      end
+      @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.
+      error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      detailed_error_code =
+        hash.key?('detailed_error_code') ? hash['detailed_error_code'] : SKIP
+      detailed_error_description =
+        hash.key?('detailed_error_description') ? hash['detailed_error_description'] : 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.
+      AuthenticationInvalid401.new(error_code: error_code,
+                                   detailed_error_code: detailed_error_code,
+                                   detailed_error_description: detailed_error_description,
+                                   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} error_code: #{@error_code}, detailed_error_code: #{@detailed_error_code},"\
+      " detailed_error_description: #{@detailed_error_description}, 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} error_code: #{@error_code.inspect}, detailed_error_code:"\
+      " #{@detailed_error_code.inspect}, detailed_error_description:"\
+      " #{@detailed_error_description.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/batches/models/avs_address_result_batches_transactions_payment_method_card_avs_address_result.rb

@@ -0,0 +1,40 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # The result of the AVS address check.
+  class AvsAddressResultBatchesTransactionsPaymentMethodCardAvsAddressResult
+    AVS_ADDRESS_RESULT_BATCHES_TRANSACTIONS_PAYMENT_METHOD_CARD_AVS_ADDRESS_RESULT = [
+      # TODO: Write general description for MATCHED
+      MATCHED = 'MATCHED'.freeze,
+
+      # TODO: Write general description for NOT_MATCHED
+      NOT_MATCHED = 'NOT_MATCHED'.freeze,
+
+      # TODO: Write general description for NOT_CHECKED
+      NOT_CHECKED = 'NOT_CHECKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AVS_ADDRESS_RESULT_BATCHES_TRANSACTIONS_PAYMENT_METHOD_CARD_AVS_ADDRESS_RESULT.include?(value)
+    end
+
+    def self.from_value(value, default_value = MATCHED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'matched' then MATCHED
+      when 'not_matched' then NOT_MATCHED
+      when 'not_checked' then NOT_CHECKED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/avs_postal_code_result_batches_transactions_payment_method_card_avs_postal_code_result.rb

@@ -0,0 +1,40 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # The result of the AVS postal code check.
+  class AvsPostalCodeResultBatchesTransactionsPaymentMethodCardAvsPostalCodeResult
+    AVS_POSTAL_CODE_RESULT_BATCHES_TRANSACTIONS_PAYMENT_METHOD_CARD_AVS_POSTAL_CODE_RESULT = [
+      # TODO: Write general description for MATCHED
+      MATCHED = 'MATCHED'.freeze,
+
+      # TODO: Write general description for NOT_MATCHED
+      NOT_MATCHED = 'NOT_MATCHED'.freeze,
+
+      # TODO: Write general description for NOT_CHECKED
+      NOT_CHECKED = 'NOT_CHECKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AVS_POSTAL_CODE_RESULT_BATCHES_TRANSACTIONS_PAYMENT_METHOD_CARD_AVS_POSTAL_CODE_RESULT.include?(value)
+    end
+
+    def self.from_value(value, default_value = MATCHED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'matched' then MATCHED
+      when 'not_matched' then NOT_MATCHED
+      when 'not_checked' then NOT_CHECKED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/base_model.rb

@@ -0,0 +1,110 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/batches/models/batches_request.rb

@@ -0,0 +1,142 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # BatchesRequest Model.
+  class BatchesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique identifier that is used to identify and reference an instance of
+    # this resource. This id is used when actioning or referencing a specific
+    # account. Begins with the three letters, TRA.
+    # @return [String]
+    attr_accessor :account_id
+
+    # A meaningful label that better identifies the account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Describes whether the transaction was processed in a face to face(CP)
+    # scenario or a Customer Not Present (CNP) scenario. 
+    #                 * `CP` - A Customer Present transaction is when the payer
+    # and the merchant are in direct face to face contact when exchanging
+    # payment method information to fulfill a transaction. e.g. in a store and
+    # paying at the counter that is attended by a clerk. 
+    #                 * `CNP` - A Customer NOT Present transaction is when the
+    # payer and the merchant are not together when exchanging payment method
+    # information to fulfill a transaction. e.g. a transaction executed from a
+    # merchant's website or over the phone
+    # @return [ChannelBatchesChannel]
+    attr_accessor :channel
+
+    # The currency of the amount in ISO-4217(alpha-3)
+    # @return [String]
+    attr_accessor :currency
+
+    # This is the country the merchant is domiciled in. For example, if the
+    # merchant is based in Canada it must be set to CA.if the merchant is based
+    # in England it must be set to GB.if the merchant is based in USA it must be
+    # set to US.The country in ISO-3166-1(alpha-2 code) format.
+    # @return [String]
+    attr_accessor :country
+
+    # Indicates the Payment Methods used to carry out the transactions in the
+    # batch
+    # @return [Array[PaymentMethod2]]
+    attr_accessor :payment_methods
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'account_id'
+      @_hash['account_name'] = 'account_name'
+      @_hash['channel'] = 'channel'
+      @_hash['currency'] = 'currency'
+      @_hash['country'] = 'country'
+      @_hash['payment_methods'] = 'payment_methods'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_name
+        channel
+        currency
+        country
+        payment_methods
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, account_name: SKIP, channel: SKIP,
+                   currency: SKIP, country: SKIP, payment_methods: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id unless account_id == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @channel = channel unless channel == SKIP
+      @currency = currency unless currency == SKIP
+      @country = country unless country == SKIP
+      @payment_methods = payment_methods unless payment_methods == 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.
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      account_name = hash.key?('account_name') ? hash['account_name'] : SKIP
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      payment_methods =
+        hash.key?('payment_methods') ? hash['payment_methods'] : 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.
+      BatchesRequest.new(account_id: account_id,
+                         account_name: account_name,
+                         channel: channel,
+                         currency: currency,
+                         country: country,
+                         payment_methods: payment_methods,
+                         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} account_id: #{@account_id}, account_name: #{@account_name}, channel:"\
+      " #{@channel}, currency: #{@currency}, country: #{@country}, payment_methods:"\
+      " #{@payment_methods}, 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} account_id: #{@account_id.inspect}, account_name: #{@account_name.inspect},"\
+      " channel: #{@channel.inspect}, currency: #{@currency.inspect}, country:"\
+      " #{@country.inspect}, payment_methods: #{@payment_methods.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/batches/models/brand_batches_brand_breakdown_brand.rb

@@ -0,0 +1,56 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Indicates the card brand that this batch summary pertains to.
+  class BrandBatchesBrandBreakdownBrand
+    BRAND_BATCHES_BRAND_BREAKDOWN_BRAND = [
+      # TODO: Write general description for VISA
+      VISA = 'VISA'.freeze,
+
+      # TODO: Write general description for MASTERCARD
+      MASTERCARD = 'MASTERCARD'.freeze,
+
+      # TODO: Write general description for AMEX
+      AMEX = 'AMEX'.freeze,
+
+      # TODO: Write general description for DINERS
+      DINERS = 'DINERS'.freeze,
+
+      # TODO: Write general description for DISCOVER
+      DISCOVER = 'DISCOVER'.freeze,
+
+      # TODO: Write general description for JCB
+      JCB = 'JCB'.freeze,
+
+      # TODO: Write general description for CUP
+      CUP = 'CUP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BRAND_BATCHES_BRAND_BREAKDOWN_BRAND.include?(value)
+    end
+
+    def self.from_value(value, default_value = VISA)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'visa' then VISA
+      when 'mastercard' then MASTERCARD
+      when 'amex' then AMEX
+      when 'diners' then DINERS
+      when 'discover' then DISCOVER
+      when 'jcb' then JCB
+      when 'cup' then CUP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/batches/models/brand_batches_transactions_payment_method_card_brand.rb

@@ -0,0 +1,56 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Indicates the card brand that issued the card.
+  class BrandBatchesTransactionsPaymentMethodCardBrand
+    BRAND_BATCHES_TRANSACTIONS_PAYMENT_METHOD_CARD_BRAND = [
+      # TODO: Write general description for VISA
+      VISA = 'VISA'.freeze,
+
+      # TODO: Write general description for MASTERCARD
+      MASTERCARD = 'MASTERCARD'.freeze,
+
+      # TODO: Write general description for AMEX
+      AMEX = 'AMEX'.freeze,
+
+      # TODO: Write general description for DINERS
+      DINERS = 'DINERS'.freeze,
+
+      # TODO: Write general description for DISCOVER
+      DISCOVER = 'DISCOVER'.freeze,
+
+      # TODO: Write general description for JCB
+      JCB = 'JCB'.freeze,
+
+      # TODO: Write general description for CUP
+      CUP = 'CUP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BRAND_BATCHES_TRANSACTIONS_PAYMENT_METHOD_CARD_BRAND.include?(value)
+    end
+
+    def self.from_value(value, default_value = VISA)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'visa' then VISA
+      when 'mastercard' then MASTERCARD
+      when 'amex' then AMEX
+      when 'diners' then DINERS
+      when 'discover' then DISCOVER
+      when 'jcb' then JCB
+      when 'cup' then CUP
+      else
+        default_value
+      end
+    end
+  end
+end