fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/tax_statement6.rb

@@ -0,0 +1,275 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The full data contents of the document and all its contained forms including
+  # the indexing metadata values
+  class TaxStatement6 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Year for which taxes are being paid
+    # @return [Integer]
+    attr_accessor :tax_year
+
+    # True to indicate this is a corrected tax form
+    # @return [TrueClass | FalseClass]
+    attr_accessor :corrected
+
+    # Long-term persistent identity of the source account. Not the account
+    # number
+    # @return [String]
+    attr_accessor :account_id
+
+    # Long-term persistent id for this tax form. Depending upon the data
+    # provider, this may be the same id as the enclosing tax statement id, or
+    # this may be a different id, or this id may be omitted.
+    # @return [String]
+    attr_accessor :tax_form_id
+
+    # Date of production or delivery of the tax form
+    # @return [Date]
+    attr_accessor :tax_form_date
+
+    # Additional explanation text or content about this tax form
+    # @return [String]
+    attr_accessor :additional_information
+
+    # Enumerated name of the tax form entity e.g. "TaxW2"
+    # @return [TypeFormType1]
+    attr_accessor :tax_form_type
+
+    # Issuer's name, address, phone, and TIN. Issuer data need only be
+    # transmitted on enclosing TaxStatement, if it is the same on all its
+    # included tax forms.
+    # @return [TaxParty8]
+    attr_accessor :issuer
+
+    # Recipient's name, address, phone, and TIN. Recipient data need only be
+    # transmitted on enclosing TaxStatement, if it is the same on all its
+    # included tax forms.
+    # @return [TaxParty1]
+    attr_accessor :recipient
+
+    # Additional attributes for this tax form when defined fields are not
+    # available. Some specific additional attributes already defined by
+    # providers: Fields required by [IRS
+    # FIRE](https://www.irs.gov/e-file-providers/filing-information-returns-elec
+    # tronically-fire): Name Control, Type of Identification Number (EIN, SSN,
+    # ITIN, ATIN). (ATIN is tax ID number for pending adoptions.) Tax form
+    # provider field for taxpayer notification: Recipient Email Address.
+    # @return [Array[TaxFormAttribute]]
+    attr_accessor :attributes
+
+    # Present if an error was encountered while retrieving this form
+    # @return [Error2]
+    attr_accessor :error
+
+    # Links to retrieve this form as data or image, or to invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Long-term persistent id for the tax statement. Depending upon the data
+    # provider, this may be the same id as the id on the enclosed tax form(s),
+    # or this may be a different id
+    # @return [String]
+    attr_accessor :tax_statement_id
+
+    # Whether this `application/json` tax form response contains data in `forms`
+    # property (as 'JSON' format) or `pdf` property (as 'BASE64_PDF' format)
+    # @return [TypeDataType2]
+    attr_accessor :tax_data_type
+
+    # The list of data contents for all included tax forms, response should
+    # include one of `forms` or `pdf`
+    # @return [Array[TaxData]]
+    attr_accessor :forms
+
+    # PDF version of the tax statement containing all form pages, binary encoded
+    # as Base64, response should include one of `pdf` or `forms`
+    # @return [Binary]
+    attr_accessor :pdf
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_year'] = 'taxYear'
+      @_hash['corrected'] = 'corrected'
+      @_hash['account_id'] = 'accountId'
+      @_hash['tax_form_id'] = 'taxFormId'
+      @_hash['tax_form_date'] = 'taxFormDate'
+      @_hash['additional_information'] = 'additionalInformation'
+      @_hash['tax_form_type'] = 'taxFormType'
+      @_hash['issuer'] = 'issuer'
+      @_hash['recipient'] = 'recipient'
+      @_hash['attributes'] = 'attributes'
+      @_hash['error'] = 'error'
+      @_hash['links'] = 'links'
+      @_hash['tax_statement_id'] = 'taxStatementId'
+      @_hash['tax_data_type'] = 'taxDataType'
+      @_hash['forms'] = 'forms'
+      @_hash['pdf'] = 'pdf'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_year
+        corrected
+        account_id
+        tax_form_id
+        tax_form_date
+        additional_information
+        tax_form_type
+        issuer
+        recipient
+        attributes
+        error
+        links
+        tax_statement_id
+        tax_data_type
+        forms
+        pdf
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_year: SKIP, corrected: SKIP, account_id: SKIP,
+                   tax_form_id: SKIP, tax_form_date: SKIP,
+                   additional_information: SKIP, tax_form_type: SKIP,
+                   issuer: SKIP, recipient: SKIP, attributes: SKIP, error: SKIP,
+                   links: SKIP, tax_statement_id: SKIP, tax_data_type: SKIP,
+                   forms: SKIP, pdf: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_year = tax_year unless tax_year == SKIP
+      @corrected = corrected unless corrected == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @tax_form_id = tax_form_id unless tax_form_id == SKIP
+      @tax_form_date = tax_form_date unless tax_form_date == SKIP
+      @additional_information = additional_information unless additional_information == SKIP
+      @tax_form_type = tax_form_type unless tax_form_type == SKIP
+      @issuer = issuer unless issuer == SKIP
+      @recipient = recipient unless recipient == SKIP
+      @attributes = attributes unless attributes == SKIP
+      @error = error unless error == SKIP
+      @links = links unless links == SKIP
+      @tax_statement_id = tax_statement_id unless tax_statement_id == SKIP
+      @tax_data_type = tax_data_type unless tax_data_type == SKIP
+      @forms = forms unless forms == SKIP
+      @pdf = pdf unless pdf == 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.
+      tax_year = hash.key?('taxYear') ? hash['taxYear'] : SKIP
+      corrected = hash.key?('corrected') ? hash['corrected'] : SKIP
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      tax_form_id = hash.key?('taxFormId') ? hash['taxFormId'] : SKIP
+      tax_form_date = hash.key?('taxFormDate') ? hash['taxFormDate'] : SKIP
+      additional_information =
+        hash.key?('additionalInformation') ? hash['additionalInformation'] : SKIP
+      tax_form_type = hash.key?('taxFormType') ? hash['taxFormType'] : SKIP
+      issuer = TaxParty8.from_hash(hash['issuer']) if hash['issuer']
+      recipient = TaxParty1.from_hash(hash['recipient']) if hash['recipient']
+      # Parameter is an array, so we need to iterate through it
+      attributes = nil
+      unless hash['attributes'].nil?
+        attributes = []
+        hash['attributes'].each do |structure|
+          attributes << (TaxFormAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      attributes = SKIP unless hash.key?('attributes')
+      error = Error2.from_hash(hash['error']) if hash['error']
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (HateoasLink.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+      tax_statement_id =
+        hash.key?('taxStatementId') ? hash['taxStatementId'] : SKIP
+      tax_data_type = hash.key?('taxDataType') ? hash['taxDataType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      forms = nil
+      unless hash['forms'].nil?
+        forms = []
+        hash['forms'].each do |structure|
+          forms << (TaxData.from_hash(structure) if structure)
+        end
+      end
+
+      forms = SKIP unless hash.key?('forms')
+      pdf = hash.key?('pdf') ? hash['pdf'] : 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.
+      TaxStatement6.new(tax_year: tax_year,
+                        corrected: corrected,
+                        account_id: account_id,
+                        tax_form_id: tax_form_id,
+                        tax_form_date: tax_form_date,
+                        additional_information: additional_information,
+                        tax_form_type: tax_form_type,
+                        issuer: issuer,
+                        recipient: recipient,
+                        attributes: attributes,
+                        error: error,
+                        links: links,
+                        tax_statement_id: tax_statement_id,
+                        tax_data_type: tax_data_type,
+                        forms: forms,
+                        pdf: pdf,
+                        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} tax_year: #{@tax_year}, corrected: #{@corrected}, account_id:"\
+      " #{@account_id}, tax_form_id: #{@tax_form_id}, tax_form_date: #{@tax_form_date},"\
+      " additional_information: #{@additional_information}, tax_form_type: #{@tax_form_type},"\
+      " issuer: #{@issuer}, recipient: #{@recipient}, attributes: #{@attributes}, error:"\
+      " #{@error}, links: #{@links}, tax_statement_id: #{@tax_statement_id}, tax_data_type:"\
+      " #{@tax_data_type}, forms: #{@forms}, pdf: #{@pdf}, 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} tax_year: #{@tax_year.inspect}, corrected: #{@corrected.inspect},"\
+      " account_id: #{@account_id.inspect}, tax_form_id: #{@tax_form_id.inspect}, tax_form_date:"\
+      " #{@tax_form_date.inspect}, additional_information: #{@additional_information.inspect},"\
+      " tax_form_type: #{@tax_form_type.inspect}, issuer: #{@issuer.inspect}, recipient:"\
+      " #{@recipient.inspect}, attributes: #{@attributes.inspect}, error: #{@error.inspect},"\
+      " links: #{@links.inspect}, tax_statement_id: #{@tax_statement_id.inspect}, tax_data_type:"\
+      " #{@tax_data_type.inspect}, forms: #{@forms.inspect}, pdf: #{@pdf.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/tax_statement_list.rb

@@ -0,0 +1,85 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Tax statement list containing one or more tax statements
+  class TaxStatementList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of tax statements
+    # @return [Array[TaxStatement]]
+    attr_accessor :statements
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['statements'] = 'statements'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        statements
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(statements: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @statements = statements unless statements == 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.
+      # Parameter is an array, so we need to iterate through it
+      statements = nil
+      unless hash['statements'].nil?
+        statements = []
+        hash['statements'].each do |structure|
+          statements << (TaxStatement.from_hash(structure) if structure)
+        end
+      end
+
+      statements = SKIP unless hash.key?('statements')
+
+      # 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.
+      TaxStatementList.new(statements: statements,
+                           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} statements: #{@statements}, 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} statements: #{@statements.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/telephone_network.rb

@@ -0,0 +1,49 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The network technology used for this telephone. One of CELLULAR, LANDLINE,
+  # PAGER, SATELLITE, or VOIP
+  class TelephoneNetwork
+    TELEPHONE_NETWORK = [
+      # TODO: Write general description for CELLULAR
+      CELLULAR = 'CELLULAR'.freeze,
+
+      # TODO: Write general description for LANDLINE
+      LANDLINE = 'LANDLINE'.freeze,
+
+      # TODO: Write general description for PAGER
+      PAGER = 'PAGER'.freeze,
+
+      # TODO: Write general description for SATELLITE
+      SATELLITE = 'SATELLITE'.freeze,
+
+      # TODO: Write general description for VOIP
+      VOIP = 'VOIP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CELLULAR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cellular' then CELLULAR
+      when 'landline' then LANDLINE
+      when 'pager' then PAGER
+      when 'satellite' then SATELLITE
+      when 'voip' then VOIP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/telephone_number.rb

@@ -0,0 +1,130 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Standard for international phone numbers
+  class TelephoneNumber < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+    # @return [TelephoneNumberPurpose2]
+    attr_accessor :type
+
+    # Country calling codes defined by ITU-T recommendations E.123 and E.164,
+    # such as '+1' for United States and Canada, see
+    # [List_of_country_calling_codes](https://en.wikipedia.org/wiki/List_of_coun
+    # try_calling_codes)
+    # @return [String]
+    attr_accessor :country
+
+    # Telephone subscriber number defined by ITU-T recommendation E.164
+    # @return [String]
+    attr_accessor :number
+
+    # The network technology used for this telephone. One of CELLULAR, LANDLINE,
+    # PAGER, SATELLITE, or VOIP
+    # @return [TelephoneNetwork]
+    attr_accessor :network
+
+    # Whether this is the primary and first telephone number to call
+    # @return [TrueClass | FalseClass]
+    attr_accessor :primary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['country'] = 'country'
+      @_hash['number'] = 'number'
+      @_hash['network'] = 'network'
+      @_hash['primary'] = 'primary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        country
+        number
+        network
+        primary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, country: SKIP, number: SKIP, network: SKIP,
+                   primary: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @country = country unless country == SKIP
+      @number = number unless number == SKIP
+      @network = network unless network == SKIP
+      @primary = primary unless primary == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      network = hash.key?('network') ? hash['network'] : SKIP
+      primary = hash.key?('primary') ? hash['primary'] : 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.
+      TelephoneNumber.new(type: type,
+                          country: country,
+                          number: number,
+                          network: network,
+                          primary: primary,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TelephoneNumber | 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} type: #{@type}, country: #{@country}, number: #{@number}, network:"\
+      " #{@network}, primary: #{@primary}, 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} type: #{@type.inspect}, country: #{@country.inspect}, number:"\
+      " #{@number.inspect}, network: #{@network.inspect}, primary: #{@primary.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/telephone_number2.rb

@@ -0,0 +1,130 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Phone number of the merchant used to execute the payment
+  class TelephoneNumber2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+    # @return [TelephoneNumberPurpose2]
+    attr_accessor :type
+
+    # Country calling codes defined by ITU-T recommendations E.123 and E.164,
+    # such as '+1' for United States and Canada, see
+    # [List_of_country_calling_codes](https://en.wikipedia.org/wiki/List_of_coun
+    # try_calling_codes)
+    # @return [String]
+    attr_accessor :country
+
+    # Telephone subscriber number defined by ITU-T recommendation E.164
+    # @return [String]
+    attr_accessor :number
+
+    # The network technology used for this telephone. One of CELLULAR, LANDLINE,
+    # PAGER, SATELLITE, or VOIP
+    # @return [TelephoneNetwork]
+    attr_accessor :network
+
+    # Whether this is the primary and first telephone number to call
+    # @return [TrueClass | FalseClass]
+    attr_accessor :primary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['country'] = 'country'
+      @_hash['number'] = 'number'
+      @_hash['network'] = 'network'
+      @_hash['primary'] = 'primary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        country
+        number
+        network
+        primary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, country: SKIP, number: SKIP, network: SKIP,
+                   primary: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @country = country unless country == SKIP
+      @number = number unless number == SKIP
+      @network = network unless network == SKIP
+      @primary = primary unless primary == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      network = hash.key?('network') ? hash['network'] : SKIP
+      primary = hash.key?('primary') ? hash['primary'] : 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.
+      TelephoneNumber2.new(type: type,
+                           country: country,
+                           number: number,
+                           network: network,
+                           primary: primary,
+                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TelephoneNumber2 | 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} type: #{@type}, country: #{@country}, number: #{@number}, network:"\
+      " #{@network}, primary: #{@primary}, 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} type: #{@type.inspect}, country: #{@country.inspect}, number:"\
+      " #{@number.inspect}, network: #{@network.inspect}, primary: #{@primary.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end