xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/start_balance.rb

@@ -0,0 +1,88 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The starting balance of the statement
+  class StartBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # decimal(19,4) unsigned Opening/closing balance amount.
+    # @return [Float]
+    attr_accessor :amount
+
+    # If the statement balances are credit or debit, the CreditDebitIndicator
+    # should be specified from the perspective of the Customer.
+    # @return [CreditDebitIndicator]
+    attr_accessor :credit_debit_indicator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['credit_debit_indicator'] = 'creditDebitIndicator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        credit_debit_indicator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, credit_debit_indicator: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount unless amount == SKIP
+      @credit_debit_indicator = credit_debit_indicator unless credit_debit_indicator == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      credit_debit_indicator =
+        hash.key?('creditDebitIndicator') ? hash['creditDebitIndicator'] : 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.
+      StartBalance.new(amount: amount,
+                       credit_debit_indicator: credit_debit_indicator,
+                       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} amount: #{@amount}, credit_debit_indicator: #{@credit_debit_indicator},"\
+      " 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} amount: #{@amount.inspect}, credit_debit_indicator:"\
+      " #{@credit_debit_indicator.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/statement.rb

@@ -0,0 +1,194 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Statement Model.
+  class Statement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # GUID used to identify the Statement.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # The Xero generated feed connection Id that identifies the Xero Bank
+    # Account Container into which the statement should be delivered. This is
+    # obtained by calling GET FeedConnections.
+    # @return [UUID | String]
+    attr_accessor :feed_connection_id
+
+    # Current status of statements
+    # @return [Status110]
+    attr_accessor :status
+
+    # Opening balance date (can be no older than one year from the current date)
+    # ISO-8601 YYYY-MM-DD
+    # @return [Date]
+    attr_accessor :start_date
+
+    # Closing balance date ISO-8601 YYYY-MM-DD
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The starting balance of the statement
+    # @return [StartBalance]
+    attr_accessor :start_balance
+
+    # The StartBalance plus all the Statement Line Amounts should be equal to
+    # the EndBalance Amount.
+    # @return [EndBalance]
+    attr_accessor :end_balance
+
+    # The StartBalance plus all the Statement Line Amounts should be equal to
+    # the EndBalance Amount.
+    # @return [Array[StatementLine]]
+    attr_accessor :statement_lines
+
+    # The StartBalance plus all the Statement Line Amounts should be equal to
+    # the EndBalance Amount.
+    # @return [Array[Error2]]
+    attr_accessor :errors
+
+    # The StartBalance plus all the Statement Line Amounts should be equal to
+    # the EndBalance Amount.
+    # @return [Integer]
+    attr_accessor :statement_line_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['feed_connection_id'] = 'feedConnectionId'
+      @_hash['status'] = 'status'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['start_balance'] = 'startBalance'
+      @_hash['end_balance'] = 'endBalance'
+      @_hash['statement_lines'] = 'statementLines'
+      @_hash['errors'] = 'errors'
+      @_hash['statement_line_count'] = 'statementLineCount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        feed_connection_id
+        status
+        start_date
+        end_date
+        start_balance
+        end_balance
+        statement_lines
+        errors
+        statement_line_count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, feed_connection_id: SKIP, status: SKIP,
+                   start_date: SKIP, end_date: SKIP, start_balance: SKIP,
+                   end_balance: SKIP, statement_lines: SKIP, errors: SKIP,
+                   statement_line_count: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @feed_connection_id = feed_connection_id unless feed_connection_id == SKIP
+      @status = status unless status == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @start_balance = start_balance unless start_balance == SKIP
+      @end_balance = end_balance unless end_balance == SKIP
+      @statement_lines = statement_lines unless statement_lines == SKIP
+      @errors = errors unless errors == SKIP
+      @statement_line_count = statement_line_count unless statement_line_count == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      feed_connection_id =
+        hash.key?('feedConnectionId') ? hash['feedConnectionId'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      start_date = hash.key?('startDate') ? hash['startDate'] : SKIP
+      end_date = hash.key?('endDate') ? hash['endDate'] : SKIP
+      start_balance = StartBalance.from_hash(hash['startBalance']) if hash['startBalance']
+      end_balance = EndBalance.from_hash(hash['endBalance']) if hash['endBalance']
+      # Parameter is an array, so we need to iterate through it
+      statement_lines = nil
+      unless hash['statementLines'].nil?
+        statement_lines = []
+        hash['statementLines'].each do |structure|
+          statement_lines << (StatementLine.from_hash(structure) if structure)
+        end
+      end
+
+      statement_lines = SKIP unless hash.key?('statementLines')
+      # Parameter is an array, so we need to iterate through it
+      errors = nil
+      unless hash['errors'].nil?
+        errors = []
+        hash['errors'].each do |structure|
+          errors << (Error2.from_hash(structure) if structure)
+        end
+      end
+
+      errors = SKIP unless hash.key?('errors')
+      statement_line_count =
+        hash.key?('statementLineCount') ? hash['statementLineCount'] : 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.
+      Statement.new(id: id,
+                    feed_connection_id: feed_connection_id,
+                    status: status,
+                    start_date: start_date,
+                    end_date: end_date,
+                    start_balance: start_balance,
+                    end_balance: end_balance,
+                    statement_lines: statement_lines,
+                    errors: errors,
+                    statement_line_count: statement_line_count,
+                    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} id: #{@id}, feed_connection_id: #{@feed_connection_id}, status: #{@status},"\
+      " start_date: #{@start_date}, end_date: #{@end_date}, start_balance: #{@start_balance},"\
+      " end_balance: #{@end_balance}, statement_lines: #{@statement_lines}, errors: #{@errors},"\
+      " statement_line_count: #{@statement_line_count}, 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} id: #{@id.inspect}, feed_connection_id: #{@feed_connection_id.inspect},"\
+      " status: #{@status.inspect}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, start_balance: #{@start_balance.inspect}, end_balance:"\
+      " #{@end_balance.inspect}, statement_lines: #{@statement_lines.inspect}, errors:"\
+      " #{@errors.inspect}, statement_line_count: #{@statement_line_count.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/statement_line.rb

@@ -0,0 +1,162 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # the lines details for a statement
+  class StatementLine < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date that the transaction was processed or cleared as seen in internet
+    # banking ISO-8601 YYYY-MM-DD
+    # @return [Date]
+    attr_accessor :posted_date
+
+    # Transaction description
+    # @return [String]
+    attr_accessor :description
+
+    # Transaction amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # If the statement balances are credit or debit, the CreditDebitIndicator
+    # should be specified from the perspective of the Customer.
+    # @return [CreditDebitIndicator]
+    attr_accessor :credit_debit_indicator
+
+    # Financial institute's internal transaction identifier. If provided this
+    # field is factored into duplicate detection.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Typically the merchant or payee name
+    # @return [String]
+    attr_accessor :payee_name
+
+    # Optional field to enhance the Description
+    # @return [String]
+    attr_accessor :reference
+
+    # The cheque/check number
+    # @return [String]
+    attr_accessor :cheque_number
+
+    # Descriptive transaction type
+    # @return [String]
+    attr_accessor :transaction_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['posted_date'] = 'postedDate'
+      @_hash['description'] = 'description'
+      @_hash['amount'] = 'amount'
+      @_hash['credit_debit_indicator'] = 'creditDebitIndicator'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['payee_name'] = 'payeeName'
+      @_hash['reference'] = 'reference'
+      @_hash['cheque_number'] = 'chequeNumber'
+      @_hash['transaction_type'] = 'transactionType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        posted_date
+        description
+        amount
+        credit_debit_indicator
+        transaction_id
+        payee_name
+        reference
+        cheque_number
+        transaction_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(posted_date: SKIP, description: SKIP, amount: SKIP,
+                   credit_debit_indicator: SKIP, transaction_id: SKIP,
+                   payee_name: SKIP, reference: SKIP, cheque_number: SKIP,
+                   transaction_type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @posted_date = posted_date unless posted_date == SKIP
+      @description = description unless description == SKIP
+      @amount = amount unless amount == SKIP
+      @credit_debit_indicator = credit_debit_indicator unless credit_debit_indicator == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @payee_name = payee_name unless payee_name == SKIP
+      @reference = reference unless reference == SKIP
+      @cheque_number = cheque_number unless cheque_number == SKIP
+      @transaction_type = transaction_type unless transaction_type == 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.
+      posted_date = hash.key?('postedDate') ? hash['postedDate'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      credit_debit_indicator =
+        hash.key?('creditDebitIndicator') ? hash['creditDebitIndicator'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      payee_name = hash.key?('payeeName') ? hash['payeeName'] : SKIP
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      cheque_number = hash.key?('chequeNumber') ? hash['chequeNumber'] : SKIP
+      transaction_type =
+        hash.key?('transactionType') ? hash['transactionType'] : 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.
+      StatementLine.new(posted_date: posted_date,
+                        description: description,
+                        amount: amount,
+                        credit_debit_indicator: credit_debit_indicator,
+                        transaction_id: transaction_id,
+                        payee_name: payee_name,
+                        reference: reference,
+                        cheque_number: cheque_number,
+                        transaction_type: transaction_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} posted_date: #{@posted_date}, description: #{@description}, amount:"\
+      " #{@amount}, credit_debit_indicator: #{@credit_debit_indicator}, transaction_id:"\
+      " #{@transaction_id}, payee_name: #{@payee_name}, reference: #{@reference}, cheque_number:"\
+      " #{@cheque_number}, transaction_type: #{@transaction_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} posted_date: #{@posted_date.inspect}, description: #{@description.inspect},"\
+      " amount: #{@amount.inspect}, credit_debit_indicator: #{@credit_debit_indicator.inspect},"\
+      " transaction_id: #{@transaction_id.inspect}, payee_name: #{@payee_name.inspect}, reference:"\
+      " #{@reference.inspect}, cheque_number: #{@cheque_number.inspect}, transaction_type:"\
+      " #{@transaction_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/statements.rb

@@ -0,0 +1,94 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Statements Model.
+  class Statements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Pagination]
+    attr_accessor :pagination
+
+    # TODO: Write general description for this method
+    # @return [Array[Statement]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination'] = 'pagination'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination
+        items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pagination: SKIP, items: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @pagination = pagination unless pagination == SKIP
+      @items = items unless items == 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.
+      pagination = Pagination.from_hash(hash['pagination']) if hash['pagination']
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (Statement.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+
+      # 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.
+      Statements.new(pagination: pagination,
+                     items: items,
+                     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} pagination: #{@pagination}, items: #{@items}, 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} pagination: #{@pagination.inspect}, items: #{@items.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/status.rb

@@ -0,0 +1,41 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account
+  # Status Codes
+  class Status
+    STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for ARCHIVED
+      ARCHIVED = 'ARCHIVED'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'archived' then ARCHIVED
+      when 'deleted' then DELETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/status1.rb

@@ -0,0 +1,38 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The Status of a contact group. To delete a contact group update the status
+  # to DELETED. Only contact groups with a status of ACTIVE are returned on
+  # GETs.
+  class Status1
+    STATUS1 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS1.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'deleted' then DELETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/status10.rb

@@ -0,0 +1,40 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The status of a tracking option
+  class Status10
+    STATUS10 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for ARCHIVED
+      ARCHIVED = 'ARCHIVED'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS10.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'archived' then ARCHIVED
+      when 'deleted' then DELETED
+      else
+        default_value
+      end
+    end
+  end
+end