fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/telephone_number_purpose.rb

@@ -0,0 +1,54 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Purpose of the telephone number, one of HOME, BUSINESS, PERSONAL, FAX, or
+  # BOTH. BOTH indicates number is used for both HOME and BUSINESS purposes.
+  # `CELL` value is deprecated in v6.3, replaced by TelephoneNetwork
+  class TelephoneNumberPurpose
+    TELEPHONE_NUMBER_PURPOSE = [
+      # TODO: Write general description for BOTH
+      BOTH = 'BOTH'.freeze,
+
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'BUSINESS'.freeze,
+
+      # TODO: Write general description for CELL
+      CELL = 'CELL'.freeze,
+
+      # TODO: Write general description for FAX
+      FAX = 'FAX'.freeze,
+
+      # TODO: Write general description for HOME
+      HOME = 'HOME'.freeze,
+
+      # TODO: Write general description for PERSONAL
+      PERSONAL = 'PERSONAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BOTH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'both' then BOTH
+      when 'business' then BUSINESS
+      when 'cell' then CELL
+      when 'fax' then FAX
+      when 'home' then HOME
+      when 'personal' then PERSONAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/telephone_number_purpose2.rb

@@ -0,0 +1,54 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Purpose of the phone number: HOME, BUSINESS, PERSONAL, FAX, or BOTH. BOTH
+  # indicates number is used for both HOME and BUSINESS purposes. `CELL` value
+  # is deprecated in v6.3, replaced as a `network` value
+  class TelephoneNumberPurpose2
+    TELEPHONE_NUMBER_PURPOSE2 = [
+      # TODO: Write general description for BOTH
+      BOTH = 'BOTH'.freeze,
+
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'BUSINESS'.freeze,
+
+      # TODO: Write general description for CELL
+      CELL = 'CELL'.freeze,
+
+      # TODO: Write general description for FAX
+      FAX = 'FAX'.freeze,
+
+      # TODO: Write general description for HOME
+      HOME = 'HOME'.freeze,
+
+      # TODO: Write general description for PERSONAL
+      PERSONAL = 'PERSONAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BOTH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'both' then BOTH
+      when 'business' then BUSINESS
+      when 'cell' then CELL
+      when 'fax' then FAX
+      when 'home' then HOME
+      when 'personal' then PERSONAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/terms_and_conditions_common_elements.rb

@@ -0,0 +1,238 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Base response entity for terms and conditions data elements shared among
+  # account types
+  class TermsAndConditionsCommonElements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date that the document or content became effective
+    # @return [Date]
+    attr_accessor :effective_date
+
+    # A terms and conditions clause that requires the parties to resolve their
+    # disputes through an arbitration process. If `true`, the terms and
+    # conditions have an Arbitration Provision
+    # @return [TrueClass | FalseClass]
+    attr_accessor :arbitration_provision
+
+    # Fee for replacement of debit or credit card (Rush order?). The value is
+    # zero if not charged on this account
+    # @return [Float]
+    attr_accessor :card_replacement_fee
+
+    # Fee for paper statements. The value is zero if not charged on this account
+    # @return [Float]
+    attr_accessor :paper_statements_fee
+
+    # Fee for ATM withdrawal or advance in account-holder's own country and
+    # currency. The value is zero if not charged on this account
+    # @return [Float]
+    attr_accessor :domestic_atm_fee
+
+    # Fee for foreign transaction ATM withdrawal or advance in foreign currency.
+    # The value is zero if not charged on this account
+    # @return [Float]
+    attr_accessor :foreign_atm_foreign_currency_advance_fee
+
+    # Fee for foreign transaction ATM withdrawal or advance in US Dollars. The
+    # value is zero if not charged on this account
+    # @return [Float]
+    attr_accessor :foreign_atm_us_dollar_advance_fee
+
+    # Fee for foreign transaction purchase in foreign currency. The value is
+    # zero if not charged on this account
+    # @return [Float]
+    attr_accessor :foreign_purchase_foreign_currency_fee
+
+    # The various maximum amounts on different types of account transactions
+    # @return [Array[TransactionLimit]]
+    attr_accessor :transaction_limits
+
+    # The promotions originally defined in Terms and Conditions or currently
+    # active on the account
+    # @return [Array[PromotionEntity]]
+    attr_accessor :promotions
+
+    # Array of Financial institution-specific attributes
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['effective_date'] = 'effectiveDate'
+      @_hash['arbitration_provision'] = 'arbitrationProvision'
+      @_hash['card_replacement_fee'] = 'cardReplacementFee'
+      @_hash['paper_statements_fee'] = 'paperStatementsFee'
+      @_hash['domestic_atm_fee'] = 'domesticAtmFee'
+      @_hash['foreign_atm_foreign_currency_advance_fee'] =
+        'foreignAtmForeignCurrencyAdvanceFee'
+      @_hash['foreign_atm_us_dollar_advance_fee'] =
+        'foreignAtmUsDollarAdvanceFee'
+      @_hash['foreign_purchase_foreign_currency_fee'] =
+        'foreignPurchaseForeignCurrencyFee'
+      @_hash['transaction_limits'] = 'transactionLimits'
+      @_hash['promotions'] = 'promotions'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        effective_date
+        arbitration_provision
+        card_replacement_fee
+        paper_statements_fee
+        domestic_atm_fee
+        foreign_atm_foreign_currency_advance_fee
+        foreign_atm_us_dollar_advance_fee
+        foreign_purchase_foreign_currency_fee
+        transaction_limits
+        promotions
+        fi_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(effective_date: SKIP, arbitration_provision: SKIP,
+                   card_replacement_fee: 0, paper_statements_fee: 0,
+                   domestic_atm_fee: 0,
+                   foreign_atm_foreign_currency_advance_fee: 0,
+                   foreign_atm_us_dollar_advance_fee: 0,
+                   foreign_purchase_foreign_currency_fee: 0,
+                   transaction_limits: SKIP, promotions: SKIP,
+                   fi_attributes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @effective_date = effective_date unless effective_date == SKIP
+      @arbitration_provision = arbitration_provision unless arbitration_provision == SKIP
+      @card_replacement_fee = card_replacement_fee unless card_replacement_fee == SKIP
+      @paper_statements_fee = paper_statements_fee unless paper_statements_fee == SKIP
+      @domestic_atm_fee = domestic_atm_fee unless domestic_atm_fee == SKIP
+      unless foreign_atm_foreign_currency_advance_fee == SKIP
+        @foreign_atm_foreign_currency_advance_fee =
+          foreign_atm_foreign_currency_advance_fee
+      end
+      unless foreign_atm_us_dollar_advance_fee == SKIP
+        @foreign_atm_us_dollar_advance_fee =
+          foreign_atm_us_dollar_advance_fee
+      end
+      unless foreign_purchase_foreign_currency_fee == SKIP
+        @foreign_purchase_foreign_currency_fee =
+          foreign_purchase_foreign_currency_fee
+      end
+      @transaction_limits = transaction_limits unless transaction_limits == SKIP
+      @promotions = promotions unless promotions == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == 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.
+      effective_date = hash.key?('effectiveDate') ? hash['effectiveDate'] : SKIP
+      arbitration_provision =
+        hash.key?('arbitrationProvision') ? hash['arbitrationProvision'] : SKIP
+      card_replacement_fee = hash['cardReplacementFee'] ||= 0
+      paper_statements_fee = hash['paperStatementsFee'] ||= 0
+      domestic_atm_fee = hash['domesticAtmFee'] ||= 0
+      foreign_atm_foreign_currency_advance_fee =
+        hash['foreignAtmForeignCurrencyAdvanceFee'] ||= 0
+      foreign_atm_us_dollar_advance_fee =
+        hash['foreignAtmUsDollarAdvanceFee'] ||= 0
+      foreign_purchase_foreign_currency_fee =
+        hash['foreignPurchaseForeignCurrencyFee'] ||= 0
+      # Parameter is an array, so we need to iterate through it
+      transaction_limits = nil
+      unless hash['transactionLimits'].nil?
+        transaction_limits = []
+        hash['transactionLimits'].each do |structure|
+          transaction_limits << (TransactionLimit.from_hash(structure) if structure)
+        end
+      end
+
+      transaction_limits = SKIP unless hash.key?('transactionLimits')
+      # Parameter is an array, so we need to iterate through it
+      promotions = nil
+      unless hash['promotions'].nil?
+        promotions = []
+        hash['promotions'].each do |structure|
+          promotions << (PromotionEntity.from_hash(structure) if structure)
+        end
+      end
+
+      promotions = SKIP unless hash.key?('promotions')
+      # Parameter is an array, so we need to iterate through it
+      fi_attributes = nil
+      unless hash['fiAttributes'].nil?
+        fi_attributes = []
+        hash['fiAttributes'].each do |structure|
+          fi_attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+
+      # 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.
+      TermsAndConditionsCommonElements.new(effective_date: effective_date,
+                                           arbitration_provision: arbitration_provision,
+                                           card_replacement_fee: card_replacement_fee,
+                                           paper_statements_fee: paper_statements_fee,
+                                           domestic_atm_fee: domestic_atm_fee,
+                                           foreign_atm_foreign_currency_advance_fee: foreign_atm_foreign_currency_advance_fee,
+                                           foreign_atm_us_dollar_advance_fee: foreign_atm_us_dollar_advance_fee,
+                                           foreign_purchase_foreign_currency_fee: foreign_purchase_foreign_currency_fee,
+                                           transaction_limits: transaction_limits,
+                                           promotions: promotions,
+                                           fi_attributes: fi_attributes,
+                                           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} effective_date: #{@effective_date}, arbitration_provision:"\
+      " #{@arbitration_provision}, card_replacement_fee: #{@card_replacement_fee},"\
+      " paper_statements_fee: #{@paper_statements_fee}, domestic_atm_fee: #{@domestic_atm_fee},"\
+      " foreign_atm_foreign_currency_advance_fee: #{@foreign_atm_foreign_currency_advance_fee},"\
+      " foreign_atm_us_dollar_advance_fee: #{@foreign_atm_us_dollar_advance_fee},"\
+      " foreign_purchase_foreign_currency_fee: #{@foreign_purchase_foreign_currency_fee},"\
+      " transaction_limits: #{@transaction_limits}, promotions: #{@promotions}, fi_attributes:"\
+      " #{@fi_attributes}, 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} effective_date: #{@effective_date.inspect}, arbitration_provision:"\
+      " #{@arbitration_provision.inspect}, card_replacement_fee: #{@card_replacement_fee.inspect},"\
+      " paper_statements_fee: #{@paper_statements_fee.inspect}, domestic_atm_fee:"\
+      " #{@domestic_atm_fee.inspect}, foreign_atm_foreign_currency_advance_fee:"\
+      " #{@foreign_atm_foreign_currency_advance_fee.inspect}, foreign_atm_us_dollar_advance_fee:"\
+      " #{@foreign_atm_us_dollar_advance_fee.inspect}, foreign_purchase_foreign_currency_fee:"\
+      " #{@foreign_purchase_foreign_currency_fee.inspect}, transaction_limits:"\
+      " #{@transaction_limits.inspect}, promotions: #{@promotions.inspect}, fi_attributes:"\
+      " #{@fi_attributes.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/terms_and_conditions_uri_entity.rb

@@ -0,0 +1,142 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # A static public-facing URI which returns account terms and conditions via
+  # PDF files or web content rather than the JSON data elements defined in
+  # parallel
+  class TermsAndConditionsUriEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Static public-facing URI which can return terms and conditions PDF files
+    # or HTML content
+    # @return [String]
+    attr_accessor :uri
+
+    # Name or description of the content that will be returned from the uri
+    # @return [String]
+    attr_accessor :title
+
+    # What type of document or content lives at the uri, one of PDF or HTML
+    # @return [UriContentType2]
+    attr_accessor :type
+
+    # The ISO 639-1 two-character language code of the content if it is not in
+    # English, as listed at [ISO
+    # 639.2](https://www.loc.gov/standards/iso639-2/php/code_list.php).
+    # Requestor indicates desired non-English language(s) in Accept-Language
+    # request header
+    # @return [String]
+    attr_accessor :lang
+
+    # Date that the document or content became effective
+    # @return [Date]
+    attr_accessor :effective_date
+
+    # Date that the document or content will expire
+    # @return [Date]
+    attr_accessor :expire_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uri'] = 'uri'
+      @_hash['title'] = 'title'
+      @_hash['type'] = 'type'
+      @_hash['lang'] = 'lang'
+      @_hash['effective_date'] = 'effectiveDate'
+      @_hash['expire_date'] = 'expireDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uri
+        title
+        type
+        lang
+        effective_date
+        expire_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uri: SKIP, title: SKIP, type: SKIP, lang: 'en',
+                   effective_date: SKIP, expire_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @uri = uri unless uri == SKIP
+      @title = title unless title == SKIP
+      @type = type unless type == SKIP
+      @lang = lang unless lang == SKIP
+      @effective_date = effective_date unless effective_date == SKIP
+      @expire_date = expire_date unless expire_date == 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.
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      lang = hash['lang'] ||= 'en'
+      effective_date = hash.key?('effectiveDate') ? hash['effectiveDate'] : SKIP
+      expire_date = hash.key?('expireDate') ? hash['expireDate'] : 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.
+      TermsAndConditionsUriEntity.new(uri: uri,
+                                      title: title,
+                                      type: type,
+                                      lang: lang,
+                                      effective_date: effective_date,
+                                      expire_date: expire_date,
+                                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TermsAndConditionsUriEntity | 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} uri: #{@uri}, title: #{@title}, type: #{@type}, lang: #{@lang},"\
+      " effective_date: #{@effective_date}, expire_date: #{@expire_date}, 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} uri: #{@uri.inspect}, title: #{@title.inspect}, type: #{@type.inspect},"\
+      " lang: #{@lang.inspect}, effective_date: #{@effective_date.inspect}, expire_date:"\
+      " #{@expire_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/time_and_occurrence_based_transfer_limits.rb

@@ -0,0 +1,115 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The transfer amount limits for each timeframe or occurrence
+  class TimeAndOccurrenceBasedTransferLimits < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The transfer limits for the current day
+    # @return [TimeframeBasedLimitsForAPaymentNetwork5]
+    attr_accessor :day
+
+    # The transfer limits for the current week
+    # @return [TimeframeBasedLimitsForAPaymentNetwork1]
+    attr_accessor :week
+
+    # The transfer limits for the current month
+    # @return [TimeframeBasedLimitsForAPaymentNetwork2]
+    attr_accessor :month
+
+    # The transfer limits for the current year
+    # @return [TimeframeBasedLimitsForAPaymentNetwork3]
+    attr_accessor :year
+
+    # The transfer limits taking effect from all the timeframe limits
+    # @return [OccurrenceBasedLimitsForAPaymentNetwork2]
+    attr_accessor :transaction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['day'] = 'day'
+      @_hash['week'] = 'week'
+      @_hash['month'] = 'month'
+      @_hash['year'] = 'year'
+      @_hash['transaction'] = 'transaction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        day
+        week
+        month
+        year
+        transaction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(day: SKIP, week: SKIP, month: SKIP, year: SKIP,
+                   transaction: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @day = day unless day == SKIP
+      @week = week unless week == SKIP
+      @month = month unless month == SKIP
+      @year = year unless year == SKIP
+      @transaction = transaction unless transaction == 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.
+      day = TimeframeBasedLimitsForAPaymentNetwork5.from_hash(hash['day']) if hash['day']
+      week = TimeframeBasedLimitsForAPaymentNetwork1.from_hash(hash['week']) if hash['week']
+      month = TimeframeBasedLimitsForAPaymentNetwork2.from_hash(hash['month']) if hash['month']
+      year = TimeframeBasedLimitsForAPaymentNetwork3.from_hash(hash['year']) if hash['year']
+      transaction = OccurrenceBasedLimitsForAPaymentNetwork2.from_hash(hash['transaction']) if
+        hash['transaction']
+
+      # 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.
+      TimeAndOccurrenceBasedTransferLimits.new(day: day,
+                                               week: week,
+                                               month: month,
+                                               year: year,
+                                               transaction: transaction,
+                                               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} day: #{@day}, week: #{@week}, month: #{@month}, year: #{@year},"\
+      " transaction: #{@transaction}, 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} day: #{@day.inspect}, week: #{@week.inspect}, month: #{@month.inspect},"\
+      " year: #{@year.inspect}, transaction: #{@transaction.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end