xero-ruby 3.1.3 → 3.3.0

data/lib/xero-ruby/models/app_store/subscription_item.rb

@@ -0,0 +1,292 @@
+=begin
+#Xero AppStore API
+
+#These endpoints are for Xero Partners to interact with the App Store Billing platform
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::AppStore
+  require 'bigdecimal'
+
+  class SubscriptionItem
+    # Date when the subscription to this product will end
+    attr_accessor :end_date
+    
+    # The unique identifier of the subscription item.
+    attr_accessor :id
+    
+
+    attr_accessor :price
+    
+
+    attr_accessor :product
+    
+    # Date the subscription started, or will start. Note: this could be in the future for downgrades or reduced number of seats that haven't taken effect yet. 
+    attr_accessor :start_date
+    
+    # If the subscription is a test subscription
+    attr_accessor :test_mode
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'end_date' => :'endDate',
+        :'id' => :'id',
+        :'price' => :'price',
+        :'product' => :'product',
+        :'start_date' => :'startDate',
+        :'test_mode' => :'testMode'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'end_date' => :'DateTime',
+        :'id' => :'String',
+        :'price' => :'Price',
+        :'product' => :'Product',
+        :'start_date' => :'DateTime',
+        :'test_mode' => :'Boolean'
+      }
+    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::AppStore::SubscriptionItem` 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::AppStore::SubscriptionItem`. 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?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      end
+
+      if attributes.key?(:'product')
+        self.product = attributes[:'product']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'test_mode')
+        self.test_mode = attributes[:'test_mode']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @price.nil?
+        invalid_properties.push('invalid value for "price", price cannot be nil.')
+      end
+
+      if @product.nil?
+        invalid_properties.push('invalid value for "product", product cannot be nil.')
+      end
+
+      if @start_date.nil?
+        invalid_properties.push('invalid value for "start_date", start_date 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 @id.nil?
+      return false if @price.nil?
+      return false if @product.nil?
+      return false if @start_date.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 &&
+          end_date == o.end_date &&
+          id == o.id &&
+          price == o.price &&
+          product == o.product &&
+          start_date == o.start_date &&
+          test_mode == o.test_mode
+    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
+      [end_date, id, price, product, start_date, test_mode].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::AppStore.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(downcase: false)
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value, downcase: downcase)
+      end
+      hash
+    end
+
+    # Returns the object in the form of hash with snake_case
+    def to_attributes
+      to_hash(downcase: true)
+    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, downcase: false)
+      if value.is_a?(Array)
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash(downcase: downcase)
+      else
+        value
+      end
+    end
+
+    def parse_date(datestring)
+      if datestring.include?('Date')
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
+        Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
+    end
+  end
+end

data/lib/xero-ruby/models/payroll_au/employee.rb

@@ -83,6 +83,16 @@ module XeroRuby::PayrollAu
     # Employee Termination Date (YYYY-MM-DD)
     attr_accessor :termination_date
     
+    # * `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing necessity or abandonment of employment * `I` Ill health - An employee resignation due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability * `D` Deceased - The death of an employee * `R` Redundancy - An employer-initiated termination of employment due to a genuine redundancy or approved early retirement scheme * `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency * `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required * `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities. 
+    attr_accessor :termination_reason
+    V = "V".freeze
+    # I = "I".freeze
+    D = "D".freeze
+    R = "R".freeze
+    # F = "F".freeze
+    C = "C".freeze
+    T = "T".freeze
+    
 
     attr_accessor :bank_accounts
     
@@ -159,6 +169,7 @@ module XeroRuby::PayrollAu
         :'employee_group_name' => :'EmployeeGroupName',
         :'employee_id' => :'EmployeeID',
         :'termination_date' => :'TerminationDate',
+        :'termination_reason' => :'TerminationReason',
         :'bank_accounts' => :'BankAccounts',
         :'pay_template' => :'PayTemplate',
         :'opening_balances' => :'OpeningBalances',
@@ -196,6 +207,7 @@ module XeroRuby::PayrollAu
         :'employee_group_name' => :'String',
         :'employee_id' => :'String',
         :'termination_date' => :'Date',
+        :'termination_reason' => :'String',
         :'bank_accounts' => :'Array<BankAccount>',
         :'pay_template' => :'PayTemplate',
         :'opening_balances' => :'OpeningBalances',
@@ -308,6 +320,10 @@ module XeroRuby::PayrollAu
         self.termination_date = attributes[:'termination_date']
       end
 
+      if attributes.key?(:'termination_reason')
+        self.termination_reason = attributes[:'termination_reason']
+      end
+
       if attributes.key?(:'bank_accounts')
         if (value = attributes[:'bank_accounts']).is_a?(Array)
           self.bank_accounts = value
@@ -386,6 +402,8 @@ module XeroRuby::PayrollAu
       return false if @date_of_birth.nil?
       gender_validator = EnumAttributeValidator.new('String', ["N", "M", "F", "I"])
       return false unless gender_validator.valid?(@gender)
+      termination_reason_validator = EnumAttributeValidator.new('String', ["V", "I", "D", "R", "F", "C", "T"])
+      return false unless termination_reason_validator.valid?(@termination_reason)
       true
     end
 
@@ -399,6 +417,16 @@ module XeroRuby::PayrollAu
       @gender = gender
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] termination_reason Object to be assigned
+    def termination_reason=(termination_reason)
+      validator = EnumAttributeValidator.new('String', ["V", "I", "D", "R", "F", "C", "T"])
+      unless validator.valid?(termination_reason)
+        fail ArgumentError, "invalid value for \"termination_reason\", must be one of #{validator.allowable_values}."
+      end
+      @termination_reason = termination_reason
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -425,6 +453,7 @@ module XeroRuby::PayrollAu
           employee_group_name == o.employee_group_name &&
           employee_id == o.employee_id &&
           termination_date == o.termination_date &&
+          termination_reason == o.termination_reason &&
           bank_accounts == o.bank_accounts &&
           pay_template == o.pay_template &&
           opening_balances == o.opening_balances &&
@@ -446,7 +475,7 @@ module XeroRuby::PayrollAu
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [first_name, last_name, date_of_birth, home_address, start_date, title, middle_names, email, gender, phone, mobile, twitter_user_name, is_authorised_to_approve_leave, is_authorised_to_approve_timesheets, job_title, classification, ordinary_earnings_rate_id, payroll_calendar_id, employee_group_name, employee_id, termination_date, bank_accounts, pay_template, opening_balances, tax_declaration, leave_balances, leave_lines, super_memberships, status, updated_date_utc, validation_errors].hash
+      [first_name, last_name, date_of_birth, home_address, start_date, title, middle_names, email, gender, phone, mobile, twitter_user_name, is_authorised_to_approve_leave, is_authorised_to_approve_timesheets, job_title, classification, ordinary_earnings_rate_id, payroll_calendar_id, employee_group_name, employee_id, termination_date, termination_reason, bank_accounts, pay_template, opening_balances, tax_declaration, leave_balances, leave_lines, super_memberships, status, updated_date_utc, validation_errors].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_au/payroll_calendar.rb

@@ -34,6 +34,9 @@ module XeroRuby::PayrollAu
     # Last modified timestamp
     attr_accessor :updated_date_utc
     
+    # Reference Date (YYYY-MM-DD)
+    attr_accessor :reference_date
+    
     # Displays array of validation error messages from the API
     attr_accessor :validation_errors
     
@@ -46,6 +49,7 @@ module XeroRuby::PayrollAu
         :'payment_date' => :'PaymentDate',
         :'payroll_calendar_id' => :'PayrollCalendarID',
         :'updated_date_utc' => :'UpdatedDateUTC',
+        :'reference_date' => :'ReferenceDate',
         :'validation_errors' => :'ValidationErrors'
       }
     end
@@ -59,6 +63,7 @@ module XeroRuby::PayrollAu
         :'payment_date' => :'Date',
         :'payroll_calendar_id' => :'String',
         :'updated_date_utc' => :'DateTime',
+        :'reference_date' => :'Date',
         :'validation_errors' => :'Array<ValidationError>'
       }
     end
@@ -102,6 +107,10 @@ module XeroRuby::PayrollAu
         self.updated_date_utc = attributes[:'updated_date_utc']
       end
 
+      if attributes.key?(:'reference_date')
+        self.reference_date = attributes[:'reference_date']
+      end
+
       if attributes.key?(:'validation_errors')
         if (value = attributes[:'validation_errors']).is_a?(Array)
           self.validation_errors = value
@@ -133,6 +142,7 @@ module XeroRuby::PayrollAu
           payment_date == o.payment_date &&
           payroll_calendar_id == o.payroll_calendar_id &&
           updated_date_utc == o.updated_date_utc &&
+          reference_date == o.reference_date &&
           validation_errors == o.validation_errors
     end
 
@@ -145,7 +155,7 @@ module XeroRuby::PayrollAu
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, calendar_type, start_date, payment_date, payroll_calendar_id, updated_date_utc, validation_errors].hash
+      [name, calendar_type, start_date, payment_date, payroll_calendar_id, updated_date_utc, reference_date, validation_errors].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/version.rb

@@ -7,9 +7,9 @@ Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
 
-The version of the XeroOpenAPI document: 2.13.2
+The version of the XeroOpenAPI document: 2.15.0
 =end
 
 module XeroRuby
-  VERSION = '3.1.3'
+  VERSION = '3.3.0'
 end

data/spec/api_client_spec.rb

@@ -47,7 +47,7 @@ describe XeroRuby::ApiClient do
             state: 'i-am-customer-state'
           }
           api_client = XeroRuby::ApiClient.new(credentials: creds)
-          expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https://mydomain.com/callback&scope=openid+profile+email+accounting.transactions+accounting.settings&state=i-am-customer-state')
+          expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https%3A%2F%2Fmydomain.com%2Fcallback&scope=openid+profile+email+accounting.transactions+accounting.settings&state=i-am-customer-state')
         end
 
         it "Does not append state if it is not provided" do
@@ -58,7 +58,7 @@ describe XeroRuby::ApiClient do
             scopes: 'openid profile email accounting.transactions accounting.settings'
           }
           api_client = XeroRuby::ApiClient.new(credentials: creds)
-          expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https://mydomain.com/callback&scope=openid+profile+email+accounting.transactions+accounting.settings')
+          expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https%3A%2F%2Fmydomain.com%2Fcallback&scope=openid+profile+email+accounting.transactions+accounting.settings')
         end
 
         it "Validates state on callback matches @config.state" do
@@ -74,6 +74,29 @@ describe XeroRuby::ApiClient do
           expect{api_client.validate_state(altered_state)}.to raise_error(StandardError, 'WARNING: @config.state: custom-state and OAuth callback state:  do not match!')
         end
       end
+
+      context "Creates a valid client_credentials client" do
+
+        it "But still defaults to grant_type: authorization_code" do
+          creds = {
+            client_id: 'abc',
+            client_secret: '123',
+          }
+          api_client = XeroRuby::ApiClient.new(credentials: creds)
+          expect(api_client.grant_type).to eq('authorization_code')
+        end
+
+        it "Sets grant_type correctly" do
+          creds = {
+            client_id: 'abc',
+            client_secret: '123',
+            grant_type: 'client_credentials'
+          }
+          api_client = XeroRuby::ApiClient.new(credentials: creds)
+          expect(api_client.grant_type).to eq('client_credentials')
+        end
+
+      end
     end
   end