fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/state_tax_withholding.rb

@@ -0,0 +1,95 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Income in a state and its tax withholding
+  class StateTaxWithholding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of state income tax withheld
+    # @return [Float]
+    attr_accessor :tax_withheld
+
+    # Filer's state tax id
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Income amount for state tax purposes
+    # @return [Float]
+    attr_accessor :income
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_withheld'] = 'taxWithheld'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['income'] = 'income'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_withheld
+        tax_id
+        income
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_withheld: SKIP, tax_id: SKIP, income: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_withheld = tax_withheld unless tax_withheld == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @income = income unless income == 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_withheld = hash.key?('taxWithheld') ? hash['taxWithheld'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      income = hash.key?('income') ? hash['income'] : 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.
+      StateTaxWithholding.new(tax_withheld: tax_withheld,
+                              tax_id: tax_id,
+                              income: income,
+                              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_withheld: #{@tax_withheld}, tax_id: #{@tax_id}, income: #{@income},"\
+      " 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_withheld: #{@tax_withheld.inspect}, tax_id: #{@tax_id.inspect}, income:"\
+      " #{@income.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/state_tax_withholding2.rb

@@ -0,0 +1,95 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Amount of state income tax withheld
+  class StateTaxWithholding2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of state income tax withheld
+    # @return [Float]
+    attr_accessor :tax_withheld
+
+    # Filer's state tax id
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Income amount for state tax purposes
+    # @return [Float]
+    attr_accessor :income
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_withheld'] = 'taxWithheld'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['income'] = 'income'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_withheld
+        tax_id
+        income
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_withheld: SKIP, tax_id: SKIP, income: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_withheld = tax_withheld unless tax_withheld == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @income = income unless income == 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_withheld = hash.key?('taxWithheld') ? hash['taxWithheld'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      income = hash.key?('income') ? hash['income'] : 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.
+      StateTaxWithholding2.new(tax_withheld: tax_withheld,
+                               tax_id: tax_id,
+                               income: income,
+                               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_withheld: #{@tax_withheld}, tax_id: #{@tax_id}, income: #{@income},"\
+      " 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_withheld: #{@tax_withheld.inspect}, tax_id: #{@tax_id.inspect}, income:"\
+      " #{@income.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/statement_encoded_entity.rb

@@ -0,0 +1,160 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # An account statement sent as a Base64-encoded image or in an encrypted
+  # payload
+  class StatementEncodedEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Corresponds to accountId in Account entity
+    # @return [String]
+    attr_accessor :account_id
+
+    # Long-term persistent identity of the statement
+    # @return [String]
+    attr_accessor :statement_id
+
+    # Date of the statement
+    # @return [Date]
+    attr_accessor :statement_date
+
+    # Description of statement
+    # @return [String]
+    attr_accessor :description
+
+    # The links to retrieve this account statement, or to invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Availability status of statement
+    # @return [DocumentStatus2]
+    attr_accessor :status
+
+    # File type of the Base64-encoded image, one of the image types
+    # application/pdf, application/zip, image/gif, image/jpeg, image/png,
+    # image/tiff
+    # @return [ContentTypes1]
+    attr_accessor :image_type
+
+    # Base64-encoded image of the account statement, in the given image type. A
+    # file of the given imageType can also be delivered separately via a link
+    # included in the inherited `links` field if the file is too large to
+    # deliver here via base64 encoding
+    # @return [Binary]
+    attr_accessor :image
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['statement_id'] = 'statementId'
+      @_hash['statement_date'] = 'statementDate'
+      @_hash['description'] = 'description'
+      @_hash['links'] = 'links'
+      @_hash['status'] = 'status'
+      @_hash['image_type'] = 'imageType'
+      @_hash['image'] = 'image'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        statement_id
+        statement_date
+        description
+        links
+        status
+        image_type
+        image
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, statement_id: SKIP, statement_date: SKIP,
+                   description: SKIP, links: SKIP, status: SKIP,
+                   image_type: SKIP, image: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id unless account_id == SKIP
+      @statement_id = statement_id unless statement_id == SKIP
+      @statement_date = statement_date unless statement_date == SKIP
+      @description = description unless description == SKIP
+      @links = links unless links == SKIP
+      @status = status unless status == SKIP
+      @image_type = image_type unless image_type == SKIP
+      @image = image unless image == 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.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      statement_id = hash.key?('statementId') ? hash['statementId'] : SKIP
+      statement_date = hash.key?('statementDate') ? hash['statementDate'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # 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')
+      status = hash.key?('status') ? hash['status'] : SKIP
+      image_type = hash.key?('imageType') ? hash['imageType'] : SKIP
+      image = hash.key?('image') ? hash['image'] : 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.
+      StatementEncodedEntity.new(account_id: account_id,
+                                 statement_id: statement_id,
+                                 statement_date: statement_date,
+                                 description: description,
+                                 links: links,
+                                 status: status,
+                                 image_type: image_type,
+                                 image: image,
+                                 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} account_id: #{@account_id}, statement_id: #{@statement_id}, statement_date:"\
+      " #{@statement_date}, description: #{@description}, links: #{@links}, status: #{@status},"\
+      " image_type: #{@image_type}, image: #{@image}, 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} account_id: #{@account_id.inspect}, statement_id: #{@statement_id.inspect},"\
+      " statement_date: #{@statement_date.inspect}, description: #{@description.inspect}, links:"\
+      " #{@links.inspect}, status: #{@status.inspect}, image_type: #{@image_type.inspect}, image:"\
+      " #{@image.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/statement_encoded_entity1.rb

@@ -0,0 +1,161 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # A JSON response with Base64-encoded statement image as StatementEncoded
+  # entity if not encrypted, or as the JSON payload which is encrypted for an
+  # application/jwt response
+  class StatementEncodedEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Corresponds to accountId in Account entity
+    # @return [String]
+    attr_accessor :account_id
+
+    # Long-term persistent identity of the statement
+    # @return [String]
+    attr_accessor :statement_id
+
+    # Date of the statement
+    # @return [Date]
+    attr_accessor :statement_date
+
+    # Description of statement
+    # @return [String]
+    attr_accessor :description
+
+    # The links to retrieve this account statement, or to invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Availability status of statement
+    # @return [DocumentStatus2]
+    attr_accessor :status
+
+    # File type of the Base64-encoded image, one of the image types
+    # application/pdf, application/zip, image/gif, image/jpeg, image/png,
+    # image/tiff
+    # @return [ContentTypes1]
+    attr_accessor :image_type
+
+    # Base64-encoded image of the account statement, in the given image type. A
+    # file of the given imageType can also be delivered separately via a link
+    # included in the inherited `links` field if the file is too large to
+    # deliver here via base64 encoding
+    # @return [Binary]
+    attr_accessor :image
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['statement_id'] = 'statementId'
+      @_hash['statement_date'] = 'statementDate'
+      @_hash['description'] = 'description'
+      @_hash['links'] = 'links'
+      @_hash['status'] = 'status'
+      @_hash['image_type'] = 'imageType'
+      @_hash['image'] = 'image'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        statement_id
+        statement_date
+        description
+        links
+        status
+        image_type
+        image
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, statement_id: SKIP, statement_date: SKIP,
+                   description: SKIP, links: SKIP, status: SKIP,
+                   image_type: SKIP, image: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id unless account_id == SKIP
+      @statement_id = statement_id unless statement_id == SKIP
+      @statement_date = statement_date unless statement_date == SKIP
+      @description = description unless description == SKIP
+      @links = links unless links == SKIP
+      @status = status unless status == SKIP
+      @image_type = image_type unless image_type == SKIP
+      @image = image unless image == 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.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      statement_id = hash.key?('statementId') ? hash['statementId'] : SKIP
+      statement_date = hash.key?('statementDate') ? hash['statementDate'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # 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')
+      status = hash.key?('status') ? hash['status'] : SKIP
+      image_type = hash.key?('imageType') ? hash['imageType'] : SKIP
+      image = hash.key?('image') ? hash['image'] : 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.
+      StatementEncodedEntity1.new(account_id: account_id,
+                                  statement_id: statement_id,
+                                  statement_date: statement_date,
+                                  description: description,
+                                  links: links,
+                                  status: status,
+                                  image_type: image_type,
+                                  image: image,
+                                  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} account_id: #{@account_id}, statement_id: #{@statement_id}, statement_date:"\
+      " #{@statement_date}, description: #{@description}, links: #{@links}, status: #{@status},"\
+      " image_type: #{@image_type}, image: #{@image}, 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} account_id: #{@account_id.inspect}, statement_id: #{@statement_id.inspect},"\
+      " statement_date: #{@statement_date.inspect}, description: #{@description.inspect}, links:"\
+      " #{@links.inspect}, status: #{@status.inspect}, image_type: #{@image_type.inspect}, image:"\
+      " #{@image.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/statement_entity.rb

@@ -0,0 +1,135 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # An account statement
+  class StatementEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Corresponds to accountId in Account entity
+    # @return [String]
+    attr_accessor :account_id
+
+    # Long-term persistent identity of the statement
+    # @return [String]
+    attr_accessor :statement_id
+
+    # Date of the statement
+    # @return [Date]
+    attr_accessor :statement_date
+
+    # Description of statement
+    # @return [String]
+    attr_accessor :description
+
+    # The links to retrieve this account statement, or to invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Availability status of statement
+    # @return [DocumentStatus2]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['statement_id'] = 'statementId'
+      @_hash['statement_date'] = 'statementDate'
+      @_hash['description'] = 'description'
+      @_hash['links'] = 'links'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        statement_id
+        statement_date
+        description
+        links
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, statement_id: SKIP, statement_date: SKIP,
+                   description: SKIP, links: SKIP, status: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id unless account_id == SKIP
+      @statement_id = statement_id unless statement_id == SKIP
+      @statement_date = statement_date unless statement_date == SKIP
+      @description = description unless description == SKIP
+      @links = links unless links == SKIP
+      @status = status unless status == 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.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      statement_id = hash.key?('statementId') ? hash['statementId'] : SKIP
+      statement_date = hash.key?('statementDate') ? hash['statementDate'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # 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')
+      status = hash.key?('status') ? hash['status'] : 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.
+      StatementEntity.new(account_id: account_id,
+                          statement_id: statement_id,
+                          statement_date: statement_date,
+                          description: description,
+                          links: links,
+                          status: status,
+                          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} account_id: #{@account_id}, statement_id: #{@statement_id}, statement_date:"\
+      " #{@statement_date}, description: #{@description}, links: #{@links}, status: #{@status},"\
+      " 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} account_id: #{@account_id.inspect}, statement_id: #{@statement_id.inspect},"\
+      " statement_date: #{@statement_date.inspect}, description: #{@description.inspect}, links:"\
+      " #{@links.inspect}, status: #{@status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end