xero-ruby 0.2.4 → 2.0.0

data/lib/xero-ruby/models/projects/time_entry_create_or_update.rb

@@ -0,0 +1,268 @@
+=begin
+#Xero Projects API
+
+#This is the Xero Projects API
+
+The version of the OpenAPI document: 2.2.11
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::Projects
+  require 'bigdecimal'
+
+  class TimeEntryCreateOrUpdate
+    # The xero user identifier of the person logging the time.
+    attr_accessor :user_id
+    
+    # Identifier of the task that time entry is logged against.
+    attr_accessor :task_id
+    
+    # Date time entry is logged on. UTC Date Time in ISO-8601 format.
+    attr_accessor :date_utc
+    
+    # Number of minutes to be logged. Duration is between 1 and 59940 inclusively.
+    attr_accessor :duration
+    
+    # An optional description of the time entry, will be set to null if not provided during update.
+    attr_accessor :description
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'user_id' => :'userId',
+        :'task_id' => :'taskId',
+        :'date_utc' => :'dateUtc',
+        :'duration' => :'duration',
+        :'description' => :'description'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'user_id' => :'String',
+        :'task_id' => :'String',
+        :'date_utc' => :'DateTime',
+        :'duration' => :'Integer',
+        :'description' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Projects::TimeEntryCreateOrUpdate` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Projects::TimeEntryCreateOrUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
+      if attributes.key?(:'task_id')
+        self.task_id = attributes[:'task_id']
+      end
+
+      if attributes.key?(:'date_utc')
+        self.date_utc = attributes[:'date_utc']
+      end
+
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      end
+
+      if @task_id.nil?
+        invalid_properties.push('invalid value for "task_id", task_id cannot be nil.')
+      end
+
+      if @date_utc.nil?
+        invalid_properties.push('invalid value for "date_utc", date_utc cannot be nil.')
+      end
+
+      if @duration.nil?
+        invalid_properties.push('invalid value for "duration", duration cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @user_id.nil?
+      return false if @task_id.nil?
+      return false if @date_utc.nil?
+      return false if @duration.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          user_id == o.user_id &&
+          task_id == o.task_id &&
+          date_utc == o.date_utc &&
+          duration == o.duration &&
+          description == o.description
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [user_id, task_id, date_utc, duration, description].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(parse_date(value))
+      when :Date
+        Date.parse(parse_date(value))
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BigDecimal
+        BigDecimal(value.to_s)
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        XeroRuby::Projects.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+    # customized data_parser
+    def parse_date(datestring)
+      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+      return Time.at(seconds_since_epoch).to_s
+    end
+  end
+end

data/lib/xero-ruby/version.rb

@@ -3,13 +3,13 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.0.7
+The version of the OpenAPI document: 2.2.11
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
 module XeroRuby
-  VERSION = '0.2.4'
+  VERSION = '2.0.0'
 end

data/spec/{api → accounting/api}/accounting_api_spec.rb

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.0.7
+The version of the OpenAPI document: 2.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.0
+OpenAPI Generator version: 4.3.0
 
 =end
 
@@ -257,9 +257,9 @@ describe 'AccountingApi' do
   # @param xero_tenant_id Xero identifier for Tenant
   # @param credit_note_id Unique identifier for a Credit Note
   # @param file_name Name of the file you are attaching to Credit Note
-  # @param include_online Set an attachment to be included with the invoice when viewed online (through Xero)
   # @param body Byte array of file in body of request
   # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :include_online Allows an attachment to be seen by the end customer within their online invoice
   # @return [Attachments]
   describe 'create_credit_note_attachment_by_file_name test' do
     it 'should work' do
@@ -348,9 +348,9 @@ describe 'AccountingApi' do
   # @param xero_tenant_id Xero identifier for Tenant
   # @param invoice_id Unique identifier for an Invoice
   # @param file_name Name of the file you are attaching
-  # @param include_online Set an attachment to be included with the invoice when viewed online (through Xero)
   # @param body Byte array of file in body of request
   # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :include_online Allows an attachment to be seen by the end customer within their online invoice
   # @return [Attachments]
   describe 'create_invoice_attachment_by_file_name test' do
     it 'should work' do
@@ -520,6 +520,7 @@ describe 'AccountingApi' do
   # @param xero_tenant_id Xero identifier for Tenant
   # @param payments Payments array with Payment object in body of request
   # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created obejcts and any with validation errors
   # @return [Payments]
   describe 'create_payments test' do
     it 'should work' do
@@ -1123,7 +1124,7 @@ describe 'AccountingApi' do
   end
 
   # unit tests for get_contact
-  # Allows you to retrieve, add and update contacts in a Xero organisation
+  # Allows you to retrieve a single contacts in a Xero organisation
   # @param xero_tenant_id Xero identifier for Tenant
   # @param contact_id Unique identifier for a Contact
   # @param [Hash] opts the optional parameters
@@ -1224,7 +1225,7 @@ describe 'AccountingApi' do
   end
 
   # unit tests for get_contacts
-  # Allows you to retrieve, add and update contacts in a Xero organisation
+  # Allows you to retrieve all contacts in a Xero organisation
   # @param xero_tenant_id Xero identifier for Tenant
   # @param [Hash] opts the optional parameters
   # @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -1818,6 +1819,18 @@ describe 'AccountingApi' do
     end
   end
 
+  # unit tests for get_prepayment_as_pdf
+  # Allows you to retrieve prepayments as PDF files
+  # @param xero_tenant_id Xero identifier for Tenant
+  # @param prepayment_id Unique identifier for a PrePayment
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'get_prepayment_as_pdf test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_prepayment_history
   # Allows you to retrieve a history records of an Prepayment
   # @param xero_tenant_id Xero identifier for Tenant
@@ -1858,6 +1871,18 @@ describe 'AccountingApi' do
     end
   end
 
+  # unit tests for get_purchase_order_as_pdf
+  # Allows you to retrieve purchase orders as PDF files
+  # @param xero_tenant_id Xero identifier for Tenant
+  # @param purchase_order_id Unique identifier for an Purchase Order
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'get_purchase_order_as_pdf test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_purchase_order_by_number
   # Allows you to retrieve a specified purchase orders
   # @param xero_tenant_id Xero identifier for Tenant

data/spec/{models → accounting/models}/account_spec.rb

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.0.7
+The version of the OpenAPI document: 2.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.0
+OpenAPI Generator version: 4.3.0
 
 =end
 
@@ -14,13 +14,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for XeroRuby::Account
+# Unit tests for XeroRuby::Accounting::Account
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'Account' do
   before do
     # run before each test
-    @instance = XeroRuby::Account.new
+    @instance = XeroRuby::Accounting::Account.new
   end
 
   after do
@@ -29,7 +29,7 @@ describe 'Account' do
 
   describe 'test an instance of Account' do
     it 'should create an instance of Account' do
-      expect(@instance).to be_instance_of(XeroRuby::Account)
+      expect(@instance).to be_instance_of(XeroRuby::Accounting::Account)
     end
   end
   describe 'test attribute "code"' do

data/spec/{models → accounting/models}/account_type_spec.rb

@@ -3,10 +3,10 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.0.7
+The version of the OpenAPI document: 2.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.0
+OpenAPI Generator version: 4.3.0
 
 =end
 
@@ -14,13 +14,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for XeroRuby::AccountType
+# Unit tests for XeroRuby::Accounting::AccountType
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'AccountType' do
   before do
     # run before each test
-    @instance = XeroRuby::AccountType.new
+    @instance = XeroRuby::Accounting::AccountType.new
   end
 
   after do
@@ -29,7 +29,7 @@ describe 'AccountType' do
 
   describe 'test an instance of AccountType' do
     it 'should create an instance of AccountType' do
-      expect(@instance).to be_instance_of(XeroRuby::AccountType)
+      expect(@instance).to be_instance_of(XeroRuby::Accounting::AccountType)
     end
   end
 end