payrix-api-sdk 1.0.0

data/lib/payrix/models/partitions_response.rb

@@ -0,0 +1,275 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # PartitionsResponse Model.
+  class PartitionsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of this resource.
+    # @return [String]
+    attr_accessor :id
+
+    # The date and time at which this resource was created. The format should be
+    # YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :created
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :modified
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [Object]
+    attr_accessor :creator
+
+    # The identifier of the Login that last modified this resource.
+    # @return [String]
+    attr_accessor :modifier
+
+    # The Login that owns this resource.
+    # @return [String]
+    attr_accessor :login
+
+    # The name of this Partition. 
+    # This field is stored as a text string and must be between 0 and 50
+    # characters long.
+    # @return [String]
+    attr_accessor :name
+
+    # The email address that the API should send email notifications from when
+    # processing requests in this Partition. 
+    # This field is stored as a text string and must be between 1 and 100
+    # characters long.
+    # @return [String]
+    attr_accessor :email
+
+    # The minimum number of characters that all passwords used in this Partition
+    # must have. 
+    # This field is specified as an integer. 
+    # The value must be between 8 and 16.
+    # @return [Integer]
+    attr_accessor :min_password_length
+
+    # The minimum level of complexity that all passwords used in this Partition
+    # must have.
+    # There are four complexity 'factors' that can be evaluated. These are the
+    # presence
+    # of the following character types in the password: lowercase characters,
+    # uppercase
+    # characters, integers, and special characters. For instance, the password
+    # '123a'
+    # would get a complexity rating of '2', since it contains integers and
+    # lowercase characters.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `1` - **Needs to include one type.**
+    # - `2` - **Needs to include two types.**
+    # - `3` - **Needs to include three types.**
+    # - `4` - **Needs to include four types.**
+    # </details>
+    # @return [MinPasswordComplexity1Enum]
+    attr_accessor :min_password_complexity
+
+    # The minimum number of previous passwords that the current password must be
+    # distinct from.
+    # This field is specified as an integer. The value must be between 3 and 12.
+    # @return [Integer]
+    attr_accessor :min_password_history
+
+    # Whether to disable the email address confirmation process for this
+    # Partition.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Disabled**
+    # - `1` - **Enabled**
+    # </details>
+    # @return [NoEmailConfirmationEnum]
+    attr_accessor :no_email_confirmation
+
+    # Whether to disable email notification for automated hold messages.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Disabled**
+    # - `1` - **Enabled**
+    # </details>
+    # @return [NoHoldEmailEnum]
+    attr_accessor :no_hold_email
+
+    # Whether change management is enabled.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Disabled**
+    # - `1` - **Enabled**
+    # </details>
+    # @return [ChangeManagementEnabled1Enum]
+    attr_accessor :change_management_enabled
+
+    # The currency in which an entity should board. See <a
+    # href="https://www.iban.com/currency-codes" target="_blank">Currency
+    # codes</a>  for all valid values.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created'] = 'created'
+      @_hash['modified'] = 'modified'
+      @_hash['creator'] = 'creator'
+      @_hash['modifier'] = 'modifier'
+      @_hash['login'] = 'login'
+      @_hash['name'] = 'name'
+      @_hash['email'] = 'email'
+      @_hash['min_password_length'] = 'minPasswordLength'
+      @_hash['min_password_complexity'] = 'minPasswordComplexity'
+      @_hash['min_password_history'] = 'minPasswordHistory'
+      @_hash['no_email_confirmation'] = 'noEmailConfirmation'
+      @_hash['no_hold_email'] = 'noHoldEmail'
+      @_hash['change_management_enabled'] = 'changeManagementEnabled'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        login
+        name
+        email
+        min_password_length
+        min_password_complexity
+        min_password_history
+        no_email_confirmation
+        no_hold_email
+        change_management_enabled
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        currency
+      ]
+    end
+
+    def initialize(id = SKIP, created = SKIP, modified = SKIP, creator = SKIP,
+                   modifier = SKIP, login = SKIP, name = SKIP, email = SKIP,
+                   min_password_length = SKIP, min_password_complexity = SKIP,
+                   min_password_history = SKIP, no_email_confirmation = SKIP,
+                   no_hold_email = SKIP, change_management_enabled = SKIP,
+                   currency = SKIP)
+      @id = id unless id == SKIP
+      @created = created unless created == SKIP
+      @modified = modified unless modified == SKIP
+      @creator = creator unless creator == SKIP
+      @modifier = modifier unless modifier == SKIP
+      @login = login unless login == SKIP
+      @name = name unless name == SKIP
+      @email = email unless email == SKIP
+      @min_password_length = min_password_length unless min_password_length == SKIP
+      @min_password_complexity = min_password_complexity unless min_password_complexity == SKIP
+      @min_password_history = min_password_history unless min_password_history == SKIP
+      @no_email_confirmation = no_email_confirmation unless no_email_confirmation == SKIP
+      @no_hold_email = no_hold_email unless no_hold_email == SKIP
+      unless change_management_enabled == SKIP
+        @change_management_enabled =
+          change_management_enabled
+      end
+      @currency = currency unless currency == SKIP
+    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
+      created = hash.key?('created') ? hash['created'] : SKIP
+      modified = hash.key?('modified') ? hash['modified'] : SKIP
+      creator = hash.key?('creator') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PartitionsResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      login = hash.key?('login') ? hash['login'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      min_password_length =
+        hash.key?('minPasswordLength') ? hash['minPasswordLength'] : SKIP
+      min_password_complexity =
+        hash.key?('minPasswordComplexity') ? hash['minPasswordComplexity'] : SKIP
+      min_password_history =
+        hash.key?('minPasswordHistory') ? hash['minPasswordHistory'] : SKIP
+      no_email_confirmation =
+        hash.key?('noEmailConfirmation') ? hash['noEmailConfirmation'] : SKIP
+      no_hold_email = hash.key?('noHoldEmail') ? hash['noHoldEmail'] : SKIP
+      change_management_enabled =
+        hash.key?('changeManagementEnabled') ? hash['changeManagementEnabled'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+
+      # Create object from extracted values.
+      PartitionsResponse.new(id,
+                             created,
+                             modified,
+                             creator,
+                             modifier,
+                             login,
+                             name,
+                             email,
+                             min_password_length,
+                             min_password_complexity,
+                             min_password_history,
+                             no_email_confirmation,
+                             no_hold_email,
+                             change_management_enabled,
+                             currency)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PartitionsResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, created: #{@created}, modified: #{@modified}, creator:"\
+      " #{@creator}, modifier: #{@modifier}, login: #{@login}, name: #{@name}, email: #{@email},"\
+      " min_password_length: #{@min_password_length}, min_password_complexity:"\
+      " #{@min_password_complexity}, min_password_history: #{@min_password_history},"\
+      " no_email_confirmation: #{@no_email_confirmation}, no_hold_email: #{@no_hold_email},"\
+      " change_management_enabled: #{@change_management_enabled}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, created: #{@created.inspect}, modified:"\
+      " #{@modified.inspect}, creator: #{@creator.inspect}, modifier: #{@modifier.inspect}, login:"\
+      " #{@login.inspect}, name: #{@name.inspect}, email: #{@email.inspect}, min_password_length:"\
+      " #{@min_password_length.inspect}, min_password_complexity:"\
+      " #{@min_password_complexity.inspect}, min_password_history:"\
+      " #{@min_password_history.inspect}, no_email_confirmation:"\
+      " #{@no_email_confirmation.inspect}, no_hold_email: #{@no_hold_email.inspect},"\
+      " change_management_enabled: #{@change_management_enabled.inspect}, currency:"\
+      " #{@currency.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/pass_token_enabled_enum.rb

@@ -0,0 +1,23 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # PassTokenEnabled.
+  class PassTokenEnabledEnum
+    PASS_TOKEN_ENABLED_ENUM = [
+      # Pass Token is disabled
+      DISABLED = 0,
+
+      # Pass Token is enabled
+      ENABLED = 1
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PASS_TOKEN_ENABLED_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/payment_method_enum.rb

@@ -0,0 +1,89 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # paymentMethod.
+  class PaymentMethodEnum
+    PAYMENT_METHOD_ENUM = [
+      # Unknown Payment Method.
+      UNKNOWN = 0,
+
+      # American Express.
+      AMEX = 1,
+
+      # Visa.
+      VISA = 2,
+
+      # MasterCard.
+      MC = 3,
+
+      # Diners Club.
+      DINERS = 4,
+
+      # Discover.
+      DISCOVER = 5,
+
+      # Debit Card.
+      DEBIT = 7,
+
+      # Checking Account.
+      CHECKING = 8,
+
+      # Savings Account.
+      SAVINGS = 9,
+
+      # Corporate Checking Account.
+      CORPCHECKING = 10,
+
+      # Corporate Savings Account.
+      CORPSAVINGS = 11,
+
+      # Accel.
+      ACCEL = 15,
+
+      # ATH.
+      ATH = 16,
+
+      # AFFN.
+      AFFN = 17,
+
+      # Culiance.
+      CULIANCE = 18,
+
+      # Interlink.
+      INTERLINK = 19,
+
+      # Jeanie.
+      JEANIE = 20,
+
+      # Maestro.
+      MAESTRO = 21,
+
+      # NYCE.
+      NYCE = 22,
+
+      # Pulse.
+      PULSE = 23,
+
+      # Shazam.
+      SHAZAM = 24,
+
+      # Star.
+      STAR = 25,
+
+      # Interac.
+      INTERAC = 26,
+
+      # Omnitoken.
+      OMNITOKEN = 27
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_METHOD_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/payment_methods_enum.rb

@@ -0,0 +1,98 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # PaymentMethods.
+  class PaymentMethodsEnum
+    PAYMENT_METHODS_ENUM = [
+      # American Express.
+      AMEX = 'amex'.freeze,
+
+      # Visa.
+      VISA = 'visa'.freeze,
+
+      # MasterCard.
+      MASTERCARD = 'masterCard'.freeze,
+
+      # Diners Club.
+      DINERS = 'diners'.freeze,
+
+      # Discover.
+      DISCOVER = 'discover'.freeze,
+
+      # PayPal.
+      PAYPAL = 'paypal'.freeze,
+
+      # Debit.
+      DEBIT = 'debit'.freeze,
+
+      # Personal checking.
+      CHECKING = 'checking'.freeze,
+
+      # Personal savings.
+      SAVINGS = 'savings'.freeze,
+
+      # Corporate checking.
+      CORPCHECKING = 'corpChecking'.freeze,
+
+      # Corporate savings.
+      CORPSAVINGS = 'corpSavings'.freeze,
+
+      # Gift card.
+      GIFT = 'gift'.freeze,
+
+      # EBT (Electronic Benefits Transfer).
+      EBT = 'ebt'.freeze,
+
+      # WIC (Women, Infants and Children).
+      WIC = 'wic'.freeze,
+
+      # Accel network.
+      ACCEL = 'Accel'.freeze,
+
+      # ATH network.
+      ATH = 'ATH'.freeze,
+
+      # AFFN network.
+      AFFN = 'AFFN'.freeze,
+
+      # Culiance network.
+      CULIANCE = 'Culiance'.freeze,
+
+      # Interlink network.
+      INTERLINK = 'Interlink'.freeze,
+
+      # Jeanie network.
+      JEANIE = 'Jeanie'.freeze,
+
+      # Maestro network.
+      MAESTRO = 'Maestro'.freeze,
+
+      # NYCE network.
+      NYCE = 'NYCE'.freeze,
+
+      # Pulse network.
+      PULSE = 'Pulse'.freeze,
+
+      # Shazam network.
+      SHAZAM = 'Shazam'.freeze,
+
+      # Star network.
+      STAR = 'Star'.freeze,
+
+      # Interac network.
+      INTERAC = 'Interac'.freeze,
+
+      # Omnitoken.
+      OMNITOKEN = 'Omnitoken'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_METHODS_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/payment_post_request.rb

@@ -0,0 +1,169 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # PaymentPostRequest Model.
+  class PaymentPostRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment method for this Transaction.
+    # @return [PaymentMethodEnum]
+    attr_accessor :method
+
+    # For credit payment method, the card number of the credit card associated
+    # with this Transaction.
+    # For eCheck payment method, the bank account number associated with this
+    # Transaction.
+    # @return [String]
+    attr_accessor :number
+
+    # For credit payment method, the card number of the credit card associated
+    # with this Transaction.
+    # For eCheck payment method, the bank account number associated with this
+    # Transaction.
+    # @return [String]
+    attr_accessor :last4
+
+    # The routing code for the eCheck or bank account payment associated with
+    # this Transaction.
+    # @return [String]
+    attr_accessor :routing
+
+    # The routing code for the eCheck or bank account payment associated with
+    # this Transaction.
+    # @return [String]
+    attr_accessor :bin
+
+    # The routing code for the eCheck or bank account payment associated with
+    # this Transaction.
+    # @return [String]
+    attr_accessor :payment
+
+    # The routing code for the eCheck or bank account payment associated with
+    # this Transaction.
+    # @return [String]
+    attr_accessor :last_checked
+
+    # The routing code for the eCheck or bank account payment associated with
+    # this Transaction.
+    # @return [String]
+    attr_accessor :mask
+
+    # The routing code for the eCheck or bank account payment associated with
+    # this Transaction.
+    # @return [String]
+    attr_accessor :plaid_consumer_account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['method'] = 'method'
+      @_hash['number'] = 'number'
+      @_hash['last4'] = 'last4'
+      @_hash['routing'] = 'routing'
+      @_hash['bin'] = 'bin'
+      @_hash['payment'] = 'payment'
+      @_hash['last_checked'] = 'lastChecked'
+      @_hash['mask'] = 'mask'
+      @_hash['plaid_consumer_account'] = 'plaidConsumerAccount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        method
+        number
+        last4
+        routing
+        bin
+        payment
+        last_checked
+        mask
+        plaid_consumer_account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payment
+        last_checked
+        mask
+        plaid_consumer_account
+      ]
+    end
+
+    def initialize(method = SKIP, number = SKIP, last4 = SKIP, routing = SKIP,
+                   bin = SKIP, payment = SKIP, last_checked = SKIP, mask = SKIP,
+                   plaid_consumer_account = SKIP)
+      @method = method unless method == SKIP
+      @number = number unless number == SKIP
+      @last4 = last4 unless last4 == SKIP
+      @routing = routing unless routing == SKIP
+      @bin = bin unless bin == SKIP
+      @payment = payment unless payment == SKIP
+      @last_checked = last_checked unless last_checked == SKIP
+      @mask = mask unless mask == SKIP
+      @plaid_consumer_account = plaid_consumer_account unless plaid_consumer_account == SKIP
+    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'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      last4 = hash.key?('last4') ? hash['last4'] : SKIP
+      routing = hash.key?('routing') ? hash['routing'] : SKIP
+      bin = hash.key?('bin') ? hash['bin'] : SKIP
+      payment = hash.key?('payment') ? hash['payment'] : SKIP
+      last_checked = hash.key?('lastChecked') ? hash['lastChecked'] : SKIP
+      mask = hash.key?('mask') ? hash['mask'] : SKIP
+      plaid_consumer_account =
+        hash.key?('plaidConsumerAccount') ? hash['plaidConsumerAccount'] : SKIP
+
+      # Create object from extracted values.
+      PaymentPostRequest.new(method,
+                             number,
+                             last4,
+                             routing,
+                             bin,
+                             payment,
+                             last_checked,
+                             mask,
+                             plaid_consumer_account)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentPostRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method}, number: #{@number}, last4: #{@last4}, routing:"\
+      " #{@routing}, bin: #{@bin}, payment: #{@payment}, last_checked: #{@last_checked}, mask:"\
+      " #{@mask}, plaid_consumer_account: #{@plaid_consumer_account}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method.inspect}, number: #{@number.inspect}, last4:"\
+      " #{@last4.inspect}, routing: #{@routing.inspect}, bin: #{@bin.inspect}, payment:"\
+      " #{@payment.inspect}, last_checked: #{@last_checked.inspect}, mask: #{@mask.inspect},"\
+      " plaid_consumer_account: #{@plaid_consumer_account.inspect}>"
+    end
+  end
+end