fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/state_code.rb

@@ -0,0 +1,286 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The codes for U.S. states, possessions and military overseas addresses. From
+  # [USPS Publication 28 - Postal Addressing
+  # Standards](https://pe.usps.com/text/pub28/28apb.htm) and [IRS Zip Code and
+  # State
+  # Abbreviations](https://www.irs.gov/pub/irs-utl/zip_code_and_state_abbreviati
+  # ons.pdf). Includes codes for 50 states and District of Columbia plus:   * AA
+  # - Armed Forces Americas (except Canada)   * AE - Armed Forces Europe,
+  # Africa, the Middle East, and Canada   * AP - Armed Forces Pacific   * AS -
+  # American Samoa   * FM - Federated States of Micronesia   * GU - Guam   * MH
+  # - Marshall Islands   * MP - Northern Mariana Islands   * PR - Puerto Rico
+  # * PW - Palau   * VI - U.S. Virgin Islands
+  class StateCode
+    STATE_CODE = [
+      # TODO: Write general description for AA
+      AA = 'AA'.freeze,
+
+      # TODO: Write general description for AE
+      AE = 'AE'.freeze,
+
+      # TODO: Write general description for AK
+      AK = 'AK'.freeze,
+
+      # TODO: Write general description for AL
+      AL = 'AL'.freeze,
+
+      # TODO: Write general description for AP
+      AP = 'AP'.freeze,
+
+      # TODO: Write general description for AR
+      AR = 'AR'.freeze,
+
+      # TODO: Write general description for AS
+      AS = 'AS'.freeze,
+
+      # TODO: Write general description for AZ
+      AZ = 'AZ'.freeze,
+
+      # TODO: Write general description for CA
+      CA = 'CA'.freeze,
+
+      # TODO: Write general description for CO
+      CO = 'CO'.freeze,
+
+      # TODO: Write general description for CT
+      CT = 'CT'.freeze,
+
+      # TODO: Write general description for DC
+      DC = 'DC'.freeze,
+
+      # TODO: Write general description for DE
+      DE = 'DE'.freeze,
+
+      # TODO: Write general description for FL
+      FL = 'FL'.freeze,
+
+      # TODO: Write general description for FM
+      FM = 'FM'.freeze,
+
+      # TODO: Write general description for GA
+      GA = 'GA'.freeze,
+
+      # TODO: Write general description for GU
+      GU = 'GU'.freeze,
+
+      # TODO: Write general description for HI
+      HI = 'HI'.freeze,
+
+      # TODO: Write general description for IA
+      IA = 'IA'.freeze,
+
+      # TODO: Write general description for ID
+      ID = 'ID'.freeze,
+
+      # TODO: Write general description for IL
+      IL = 'IL'.freeze,
+
+      # TODO: Write general description for IN
+      IN = 'IN'.freeze,
+
+      # TODO: Write general description for KS
+      KS = 'KS'.freeze,
+
+      # TODO: Write general description for KY
+      KY = 'KY'.freeze,
+
+      # TODO: Write general description for LA
+      LA = 'LA'.freeze,
+
+      # TODO: Write general description for MA
+      MA = 'MA'.freeze,
+
+      # TODO: Write general description for MD
+      MD = 'MD'.freeze,
+
+      # TODO: Write general description for ME
+      ME = 'ME'.freeze,
+
+      # TODO: Write general description for MH
+      MH = 'MH'.freeze,
+
+      # TODO: Write general description for MI
+      MI = 'MI'.freeze,
+
+      # TODO: Write general description for MN
+      MN = 'MN'.freeze,
+
+      # TODO: Write general description for MO
+      MO = 'MO'.freeze,
+
+      # TODO: Write general description for MP
+      MP = 'MP'.freeze,
+
+      # TODO: Write general description for MS
+      MS = 'MS'.freeze,
+
+      # TODO: Write general description for MT
+      MT = 'MT'.freeze,
+
+      # TODO: Write general description for NC
+      NC = 'NC'.freeze,
+
+      # TODO: Write general description for ND
+      ND = 'ND'.freeze,
+
+      # TODO: Write general description for NE
+      NE = 'NE'.freeze,
+
+      # TODO: Write general description for NH
+      NH = 'NH'.freeze,
+
+      # TODO: Write general description for NJ
+      NJ = 'NJ'.freeze,
+
+      # TODO: Write general description for NM
+      NM = 'NM'.freeze,
+
+      # TODO: Write general description for NV
+      NV = 'NV'.freeze,
+
+      # TODO: Write general description for NY
+      NY = 'NY'.freeze,
+
+      # TODO: Write general description for OH
+      OH = 'OH'.freeze,
+
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for OR
+      OR = 'OR'.freeze,
+
+      # TODO: Write general description for PA
+      PA = 'PA'.freeze,
+
+      # TODO: Write general description for PR
+      PR = 'PR'.freeze,
+
+      # TODO: Write general description for PW
+      PW = 'PW'.freeze,
+
+      # TODO: Write general description for RI
+      RI = 'RI'.freeze,
+
+      # TODO: Write general description for SC
+      SC = 'SC'.freeze,
+
+      # TODO: Write general description for SD
+      SD = 'SD'.freeze,
+
+      # TODO: Write general description for TN
+      TN = 'TN'.freeze,
+
+      # TODO: Write general description for TX
+      TX = 'TX'.freeze,
+
+      # TODO: Write general description for UT
+      UT = 'UT'.freeze,
+
+      # TODO: Write general description for VA
+      VA = 'VA'.freeze,
+
+      # TODO: Write general description for VI
+      VI = 'VI'.freeze,
+
+      # TODO: Write general description for VT
+      VT = 'VT'.freeze,
+
+      # TODO: Write general description for WA
+      WA = 'WA'.freeze,
+
+      # TODO: Write general description for WI
+      WI = 'WI'.freeze,
+
+      # TODO: Write general description for WV
+      WV = 'WV'.freeze,
+
+      # TODO: Write general description for WY
+      WY = 'WY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = AA)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'aa' then AA
+      when 'ae' then AE
+      when 'ak' then AK
+      when 'al' then AL
+      when 'ap' then AP
+      when 'ar' then AR
+      when 'as' then AS
+      when 'az' then AZ
+      when 'ca' then CA
+      when 'co' then CO
+      when 'ct' then CT
+      when 'dc' then DC
+      when 'de' then DE
+      when 'fl' then FL
+      when 'fm' then FM
+      when 'ga' then GA
+      when 'gu' then GU
+      when 'hi' then HI
+      when 'ia' then IA
+      when 'id' then ID
+      when 'il' then IL
+      when 'in' then IN
+      when 'ks' then KS
+      when 'ky' then KY
+      when 'la' then LA
+      when 'ma' then MA
+      when 'md' then MD
+      when 'me' then ME
+      when 'mh' then MH
+      when 'mi' then MI
+      when 'mn' then MN
+      when 'mo' then MO
+      when 'mp' then MP
+      when 'ms' then MS
+      when 'mt' then MT
+      when 'nc' then NC
+      when 'nd' then ND
+      when 'ne' then NE
+      when 'nh' then NH
+      when 'nj' then NJ
+      when 'nm' then NM
+      when 'nv' then NV
+      when 'ny' then NY
+      when 'oh' then OH
+      when 'ok' then OK
+      when 'or' then OR
+      when 'pa' then PA
+      when 'pr' then PR
+      when 'pw' then PW
+      when 'ri' then RI
+      when 'sc' then SC
+      when 'sd' then SD
+      when 'tn' then TN
+      when 'tx' then TX
+      when 'ut' then UT
+      when 'va' then VA
+      when 'vi' then VI
+      when 'vt' then VT
+      when 'wa' then WA
+      when 'wi' then WI
+      when 'wv' then WV
+      when 'wy' then WY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/state_code1.rb

@@ -0,0 +1,276 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # State two-digit code
+  class StateCode1
+    STATE_CODE1 = [
+      # TODO: Write general description for AA
+      AA = 'AA'.freeze,
+
+      # TODO: Write general description for AE
+      AE = 'AE'.freeze,
+
+      # TODO: Write general description for AK
+      AK = 'AK'.freeze,
+
+      # TODO: Write general description for AL
+      AL = 'AL'.freeze,
+
+      # TODO: Write general description for AP
+      AP = 'AP'.freeze,
+
+      # TODO: Write general description for AR
+      AR = 'AR'.freeze,
+
+      # TODO: Write general description for AS
+      AS = 'AS'.freeze,
+
+      # TODO: Write general description for AZ
+      AZ = 'AZ'.freeze,
+
+      # TODO: Write general description for CA
+      CA = 'CA'.freeze,
+
+      # TODO: Write general description for CO
+      CO = 'CO'.freeze,
+
+      # TODO: Write general description for CT
+      CT = 'CT'.freeze,
+
+      # TODO: Write general description for DC
+      DC = 'DC'.freeze,
+
+      # TODO: Write general description for DE
+      DE = 'DE'.freeze,
+
+      # TODO: Write general description for FL
+      FL = 'FL'.freeze,
+
+      # TODO: Write general description for FM
+      FM = 'FM'.freeze,
+
+      # TODO: Write general description for GA
+      GA = 'GA'.freeze,
+
+      # TODO: Write general description for GU
+      GU = 'GU'.freeze,
+
+      # TODO: Write general description for HI
+      HI = 'HI'.freeze,
+
+      # TODO: Write general description for IA
+      IA = 'IA'.freeze,
+
+      # TODO: Write general description for ID
+      ID = 'ID'.freeze,
+
+      # TODO: Write general description for IL
+      IL = 'IL'.freeze,
+
+      # TODO: Write general description for IN
+      IN = 'IN'.freeze,
+
+      # TODO: Write general description for KS
+      KS = 'KS'.freeze,
+
+      # TODO: Write general description for KY
+      KY = 'KY'.freeze,
+
+      # TODO: Write general description for LA
+      LA = 'LA'.freeze,
+
+      # TODO: Write general description for MA
+      MA = 'MA'.freeze,
+
+      # TODO: Write general description for MD
+      MD = 'MD'.freeze,
+
+      # TODO: Write general description for ME
+      ME = 'ME'.freeze,
+
+      # TODO: Write general description for MH
+      MH = 'MH'.freeze,
+
+      # TODO: Write general description for MI
+      MI = 'MI'.freeze,
+
+      # TODO: Write general description for MN
+      MN = 'MN'.freeze,
+
+      # TODO: Write general description for MO
+      MO = 'MO'.freeze,
+
+      # TODO: Write general description for MP
+      MP = 'MP'.freeze,
+
+      # TODO: Write general description for MS
+      MS = 'MS'.freeze,
+
+      # TODO: Write general description for MT
+      MT = 'MT'.freeze,
+
+      # TODO: Write general description for NC
+      NC = 'NC'.freeze,
+
+      # TODO: Write general description for ND
+      ND = 'ND'.freeze,
+
+      # TODO: Write general description for NE
+      NE = 'NE'.freeze,
+
+      # TODO: Write general description for NH
+      NH = 'NH'.freeze,
+
+      # TODO: Write general description for NJ
+      NJ = 'NJ'.freeze,
+
+      # TODO: Write general description for NM
+      NM = 'NM'.freeze,
+
+      # TODO: Write general description for NV
+      NV = 'NV'.freeze,
+
+      # TODO: Write general description for NY
+      NY = 'NY'.freeze,
+
+      # TODO: Write general description for OH
+      OH = 'OH'.freeze,
+
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for OR
+      OR = 'OR'.freeze,
+
+      # TODO: Write general description for PA
+      PA = 'PA'.freeze,
+
+      # TODO: Write general description for PR
+      PR = 'PR'.freeze,
+
+      # TODO: Write general description for PW
+      PW = 'PW'.freeze,
+
+      # TODO: Write general description for RI
+      RI = 'RI'.freeze,
+
+      # TODO: Write general description for SC
+      SC = 'SC'.freeze,
+
+      # TODO: Write general description for SD
+      SD = 'SD'.freeze,
+
+      # TODO: Write general description for TN
+      TN = 'TN'.freeze,
+
+      # TODO: Write general description for TX
+      TX = 'TX'.freeze,
+
+      # TODO: Write general description for UT
+      UT = 'UT'.freeze,
+
+      # TODO: Write general description for VA
+      VA = 'VA'.freeze,
+
+      # TODO: Write general description for VI
+      VI = 'VI'.freeze,
+
+      # TODO: Write general description for VT
+      VT = 'VT'.freeze,
+
+      # TODO: Write general description for WA
+      WA = 'WA'.freeze,
+
+      # TODO: Write general description for WI
+      WI = 'WI'.freeze,
+
+      # TODO: Write general description for WV
+      WV = 'WV'.freeze,
+
+      # TODO: Write general description for WY
+      WY = 'WY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = AA)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'aa' then AA
+      when 'ae' then AE
+      when 'ak' then AK
+      when 'al' then AL
+      when 'ap' then AP
+      when 'ar' then AR
+      when 'as' then AS
+      when 'az' then AZ
+      when 'ca' then CA
+      when 'co' then CO
+      when 'ct' then CT
+      when 'dc' then DC
+      when 'de' then DE
+      when 'fl' then FL
+      when 'fm' then FM
+      when 'ga' then GA
+      when 'gu' then GU
+      when 'hi' then HI
+      when 'ia' then IA
+      when 'id' then ID
+      when 'il' then IL
+      when 'in' then IN
+      when 'ks' then KS
+      when 'ky' then KY
+      when 'la' then LA
+      when 'ma' then MA
+      when 'md' then MD
+      when 'me' then ME
+      when 'mh' then MH
+      when 'mi' then MI
+      when 'mn' then MN
+      when 'mo' then MO
+      when 'mp' then MP
+      when 'ms' then MS
+      when 'mt' then MT
+      when 'nc' then NC
+      when 'nd' then ND
+      when 'ne' then NE
+      when 'nh' then NH
+      when 'nj' then NJ
+      when 'nm' then NM
+      when 'nv' then NV
+      when 'ny' then NY
+      when 'oh' then OH
+      when 'ok' then OK
+      when 'or' then OR
+      when 'pa' then PA
+      when 'pr' then PR
+      when 'pw' then PW
+      when 'ri' then RI
+      when 'sc' then SC
+      when 'sd' then SD
+      when 'tn' then TN
+      when 'tx' then TX
+      when 'ut' then UT
+      when 'va' then VA
+      when 'vi' then VI
+      when 'vt' then VT
+      when 'wa' then WA
+      when 'wi' then WI
+      when 'wv' then WV
+      when 'wy' then WY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/state_exempt_income.rb

@@ -0,0 +1,95 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # State exempt income details
+  class StateExemptIncome < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # State two-digit code
+    # @return [StateCode1]
+    attr_accessor :state_code
+
+    # This state's percent of total of enclosing fund
+    # @return [Float]
+    attr_accessor :percent
+
+    # This state's exempt amount. Total of enclosing fund times state's percent
+    # @return [Float]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['state_code'] = 'stateCode'
+      @_hash['percent'] = 'percent'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        state_code
+        percent
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(state_code: SKIP, percent: SKIP, amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @state_code = state_code unless state_code == SKIP
+      @percent = percent unless percent == SKIP
+      @amount = amount unless 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.
+      state_code = hash.key?('stateCode') ? hash['stateCode'] : SKIP
+      percent = hash.key?('percent') ? hash['percent'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : 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.
+      StateExemptIncome.new(state_code: state_code,
+                            percent: percent,
+                            amount: 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} state_code: #{@state_code}, percent: #{@percent}, amount: #{@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} state_code: #{@state_code.inspect}, percent: #{@percent.inspect}, amount:"\
+      " #{@amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end