fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/base_model.rb

@@ -0,0 +1,110 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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/fdx_v660_api/models/base_payroll_rate.rb

@@ -0,0 +1,84 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Provides a person's base pay rate
+  class BasePayrollRate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The amount and currency of the base pay rate of employee
+    # @return [MonetaryAmount6]
+    attr_accessor :rate
+
+    # The unit for the worker's rate. In time period length order, one of
+    # HOURLY, DAILY, WEEKLY, BI-WEEKLY, SEMI-MONTHLY, EVERY 2.6 WEEKS, EVERY 4
+    # WEEKS, MONTHLY, EVERY 5.2 WEEKS, QUARTERLY, SEMI-ANNUALLY, ANNUAL, OTHER
+    # @return [PayrollRateType3]
+    attr_accessor :rate_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['rate'] = 'rate'
+      @_hash['rate_type'] = 'rateType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(rate:, rate_type:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @rate = rate
+      @rate_type = rate_type
+      @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.
+      rate = MonetaryAmount6.from_hash(hash['rate']) if hash['rate']
+      rate_type = hash.key?('rateType') ? hash['rateType'] : nil
+
+      # 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.
+      BasePayrollRate.new(rate: rate,
+                          rate_type: rate_type,
+                          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} rate: #{@rate}, rate_type: #{@rate_type}, 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} rate: #{@rate.inspect}, rate_type: #{@rate_type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/base_payroll_rate1.rb

@@ -0,0 +1,84 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The employee's base payroll rate
+  class BasePayrollRate1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The amount and currency of the base pay rate of employee
+    # @return [MonetaryAmount6]
+    attr_accessor :rate
+
+    # The unit for the worker's rate. In time period length order, one of
+    # HOURLY, DAILY, WEEKLY, BI-WEEKLY, SEMI-MONTHLY, EVERY 2.6 WEEKS, EVERY 4
+    # WEEKS, MONTHLY, EVERY 5.2 WEEKS, QUARTERLY, SEMI-ANNUALLY, ANNUAL, OTHER
+    # @return [PayrollRateType3]
+    attr_accessor :rate_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['rate'] = 'rate'
+      @_hash['rate_type'] = 'rateType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(rate:, rate_type:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @rate = rate
+      @rate_type = rate_type
+      @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.
+      rate = MonetaryAmount6.from_hash(hash['rate']) if hash['rate']
+      rate_type = hash.key?('rateType') ? hash['rateType'] : nil
+
+      # 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.
+      BasePayrollRate1.new(rate: rate,
+                           rate_type: rate_type,
+                           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} rate: #{@rate}, rate_type: #{@rate_type}, 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} rate: #{@rate.inspect}, rate_type: #{@rate_type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/base_terms_and_conditions.rb

@@ -0,0 +1,115 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Base type for initial and current terms and conditions for deposit and line
+  # of credit accounts
+  class BaseTermsAndConditions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID of the marketed product for which these are the Terms and
+    # Conditions
+    # @return [String]
+    attr_accessor :product_id
+
+    # Static public-facing URIs which return initial or latest account terms and
+    # conditions as PDF files or web content
+    # @return [Array[TermsAndConditionsUriEntity]]
+    attr_accessor :uris
+
+    # The PDFs or JSON data elements for the terms and conditions for the
+    # account's reward program (and reward categories, if any)
+    # @return [RewardsTermsAndConditionsEntity2]
+    attr_accessor :rewards_terms_and_conditions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'productId'
+      @_hash['uris'] = 'uris'
+      @_hash['rewards_terms_and_conditions'] = 'rewardsTermsAndConditions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+        uris
+        rewards_terms_and_conditions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id: SKIP, uris: SKIP,
+                   rewards_terms_and_conditions: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @product_id = product_id unless product_id == SKIP
+      @uris = uris unless uris == SKIP
+      unless rewards_terms_and_conditions == SKIP
+        @rewards_terms_and_conditions =
+          rewards_terms_and_conditions
+      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.
+      product_id = hash.key?('productId') ? hash['productId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      uris = nil
+      unless hash['uris'].nil?
+        uris = []
+        hash['uris'].each do |structure|
+          uris << (TermsAndConditionsUriEntity.from_hash(structure) if structure)
+        end
+      end
+
+      uris = SKIP unless hash.key?('uris')
+      if hash['rewardsTermsAndConditions']
+        rewards_terms_and_conditions = RewardsTermsAndConditionsEntity2.from_hash(hash['rewardsTermsAndConditions'])
+      end
+
+      # 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.
+      BaseTermsAndConditions.new(product_id: product_id,
+                                 uris: uris,
+                                 rewards_terms_and_conditions: rewards_terms_and_conditions,
+                                 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} product_id: #{@product_id}, uris: #{@uris}, rewards_terms_and_conditions:"\
+      " #{@rewards_terms_and_conditions}, 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} product_id: #{@product_id.inspect}, uris: #{@uris.inspect},"\
+      " rewards_terms_and_conditions: #{@rewards_terms_and_conditions.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/basic_auth_credentials.rb

@@ -0,0 +1,105 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Tax form credentials container for QR Code purposes
+  class BasicAuthCredentials < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Year for which taxes are being paid
+    # @return [Integer]
+    attr_accessor :tax_year
+
+    # Enumerated name of the tax form entity e.g. "TaxW2"
+    # @return [TypeFormType1]
+    attr_accessor :tax_form_type
+
+    # Confidential and unique identifier of the tax form
+    # @return [String]
+    attr_accessor :id
+
+    # Unique, randomized and restricted password for this document
+    # @return [String]
+    attr_accessor :passcode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_year'] = 'taxYear'
+      @_hash['tax_form_type'] = 'taxFormType'
+      @_hash['id'] = 'id'
+      @_hash['passcode'] = 'passcode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_year
+        tax_form_type
+        id
+        passcode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_year: SKIP, tax_form_type: SKIP, id: SKIP,
+                   passcode: 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
+      @tax_form_type = tax_form_type unless tax_form_type == SKIP
+      @id = id unless id == SKIP
+      @passcode = passcode unless passcode == 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
+      tax_form_type = hash.key?('taxFormType') ? hash['taxFormType'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      passcode = hash.key?('passcode') ? hash['passcode'] : 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.
+      BasicAuthCredentials.new(tax_year: tax_year,
+                               tax_form_type: tax_form_type,
+                               id: id,
+                               passcode: passcode,
+                               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}, tax_form_type: #{@tax_form_type}, id: #{@id},"\
+      " passcode: #{@passcode}, 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}, tax_form_type: #{@tax_form_type.inspect},"\
+      " id: #{@id.inspect}, passcode: #{@passcode.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/basic_auth_credentials1.rb

@@ -0,0 +1,105 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The Basic Authentication credentials to retrieve a tax form
+  class BasicAuthCredentials1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Year for which taxes are being paid
+    # @return [Integer]
+    attr_accessor :tax_year
+
+    # Enumerated name of the tax form entity e.g. "TaxW2"
+    # @return [TypeFormType1]
+    attr_accessor :tax_form_type
+
+    # Confidential and unique identifier of the tax form
+    # @return [String]
+    attr_accessor :id
+
+    # Unique, randomized and restricted password for this document
+    # @return [String]
+    attr_accessor :passcode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_year'] = 'taxYear'
+      @_hash['tax_form_type'] = 'taxFormType'
+      @_hash['id'] = 'id'
+      @_hash['passcode'] = 'passcode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_year
+        tax_form_type
+        id
+        passcode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_year: SKIP, tax_form_type: SKIP, id: SKIP,
+                   passcode: 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
+      @tax_form_type = tax_form_type unless tax_form_type == SKIP
+      @id = id unless id == SKIP
+      @passcode = passcode unless passcode == 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
+      tax_form_type = hash.key?('taxFormType') ? hash['taxFormType'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      passcode = hash.key?('passcode') ? hash['passcode'] : 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.
+      BasicAuthCredentials1.new(tax_year: tax_year,
+                                tax_form_type: tax_form_type,
+                                id: id,
+                                passcode: passcode,
+                                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}, tax_form_type: #{@tax_form_type}, id: #{@id},"\
+      " passcode: #{@passcode}, 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}, tax_form_type: #{@tax_form_type.inspect},"\
+      " id: #{@id.inspect}, passcode: #{@passcode.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/basic_auth_for_qr.rb

@@ -0,0 +1,96 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Tax form credentials container for QR Code purposes
+  class BasicAuthForQr < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Basic Authentication credentials to retrieve a tax form
+    # @return [BasicAuthCredentials1]
+    attr_accessor :basic_auth
+
+    # [Financial Data Exchange (FDX)](https://financialdataexchange.org/) schema
+    # version number (e.g. "V5.0").
+    # @return [FdxVersion1]
+    attr_accessor :version
+
+    # The FDX registration ID of company or software generating this tax data
+    # @return [String]
+    attr_accessor :software_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['basic_auth'] = 'basicAuth'
+      @_hash['version'] = 'version'
+      @_hash['software_id'] = 'softwareId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        basic_auth
+        version
+        software_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(basic_auth: SKIP, version: SKIP, software_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @basic_auth = basic_auth unless basic_auth == SKIP
+      @version = version unless version == SKIP
+      @software_id = software_id unless software_id == 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.
+      basic_auth = BasicAuthCredentials1.from_hash(hash['basicAuth']) if hash['basicAuth']
+      version = hash.key?('version') ? hash['version'] : SKIP
+      software_id = hash.key?('softwareId') ? hash['softwareId'] : 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.
+      BasicAuthForQr.new(basic_auth: basic_auth,
+                         version: version,
+                         software_id: software_id,
+                         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} basic_auth: #{@basic_auth}, version: #{@version}, software_id:"\
+      " #{@software_id}, 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} basic_auth: #{@basic_auth.inspect}, version: #{@version.inspect},"\
+      " software_id: #{@software_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end