affixapi 1.1.59 → 1.1.62

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38acff549d23c32bf0ea9e6504535fab01b839f1659b3c867bb269c81a3d9acc
-  data.tar.gz: ab2d9fb64498736f6487328c46f9e4919d18b8dc943e18de8e917e9172feb079
+  metadata.gz: 58895b146e59798b8d0cf9b68be490bda1612804db6ed02aa410973741046e1f
+  data.tar.gz: 5e913bcd3c7073d0b6150e0e6c13c42f2815f69fb5d5b49f91cf48aea2bd5060
 SHA512:
-  metadata.gz: 848c3766898d50acac3e28a9c486bab13a3c291472b8bac5638be62f6e718f0327d2e0ac3615c184e88494eac9ab7e377c3de86c24dc3787c0036ae80b391f3b
-  data.tar.gz: 5106125edd8b05e4e63a21c0e21c6d472cb2009bb09bbaa29861159c62cfe33f5a52a7680ac348e5f826e6dcc9d5ebdbf04b52196a17a6786eef39646284b080
+  metadata.gz: 2fc93c9dfe174b5664d3fee39779f78ef6c51a08d75a62d5bb65e359ec877f0f69ab769aca33829507bbdca5c464a26be51a045e352bd70bf56a8e372b0037af
+  data.tar.gz: 2d356bb1c1c5e5b52eb518603ad0f70a4a6eb369eba6b7dd75efa5407e503e62b9748aa0a13c76da63c00bc0417c18c4be9e9adbdae40a48305f31ef9e7835a6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    affixapi (1.1.59)
+    affixapi (1.1.62)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -326,6 +326,8 @@ Class | Method | HTTP request | Description
  - [OpenapiClient::CompanyResponse](docs/CompanyResponse.md)
  - [OpenapiClient::CreateEmployeeRequest](docs/CreateEmployeeRequest.md)
  - [OpenapiClient::CreateEmployeeRequestBankAccount](docs/CreateEmployeeRequestBankAccount.md)
+ - [OpenapiClient::CreateEmployeeRequestDependents](docs/CreateEmployeeRequestDependents.md)
+ - [OpenapiClient::CreateEmployeeRequestEmergencyContacts](docs/CreateEmployeeRequestEmergencyContacts.md)
  - [OpenapiClient::CreateEmployeeRequestManager](docs/CreateEmployeeRequestManager.md)
  - [OpenapiClient::CurrencyNotNullRequest](docs/CurrencyNotNullRequest.md)
  - [OpenapiClient::CurrencyResponse](docs/CurrencyResponse.md)
@@ -334,6 +336,10 @@ Class | Method | HTTP request | Description
  - [OpenapiClient::EmployeeResponseManager](docs/EmployeeResponseManager.md)
  - [OpenapiClient::EmploymentNoNullEnumRequest](docs/EmploymentNoNullEnumRequest.md)
  - [OpenapiClient::EmploymentResponse](docs/EmploymentResponse.md)
+ - [OpenapiClient::EmploymentStatus](docs/EmploymentStatus.md)
+ - [OpenapiClient::EmploymentStatusNotNull](docs/EmploymentStatusNotNull.md)
+ - [OpenapiClient::EmploymentStatusNotNullRequest](docs/EmploymentStatusNotNullRequest.md)
+ - [OpenapiClient::EmploymentStatusResponse](docs/EmploymentStatusResponse.md)
  - [OpenapiClient::GroupNoNullEnumRequest](docs/GroupNoNullEnumRequest.md)
  - [OpenapiClient::GroupResponse](docs/GroupResponse.md)
  - [OpenapiClient::IdAndMessageResponse](docs/IdAndMessageResponse.md)

data/docs/Class20230301Api.md

@@ -86,7 +86,7 @@ This endpoint does not need any parameter.
 
 ## xhr_employees20230301
 
-> <Array<EmployeeResponse>> xhr_employees20230301
+> <Array<EmployeeResponse>> xhr_employees20230301(opts)
 
 Employees
 
@@ -106,10 +106,13 @@ OpenapiClient.configure do |config|
 end
 
 api_instance = OpenapiClient::Class20230301Api.new
+opts = {
+  employment_status: OpenapiClient::EmploymentStatusNotNull::ACTIVE # EmploymentStatusNotNull | Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set) 
+}
 
 begin
   # Employees
-  result = api_instance.xhr_employees20230301
+  result = api_instance.xhr_employees20230301(opts)
   p result
 rescue OpenapiClient::ApiError => e
   puts "Error when calling Class20230301Api->xhr_employees20230301: #{e}"
@@ -120,12 +123,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<EmployeeResponse>>, Integer, Hash)> xhr_employees20230301_with_http_info
+> <Array(<Array<EmployeeResponse>>, Integer, Hash)> xhr_employees20230301_with_http_info(opts)
 
 ```ruby
 begin
   # Employees
-  data, status_code, headers = api_instance.xhr_employees20230301_with_http_info
+  data, status_code, headers = api_instance.xhr_employees20230301_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<EmployeeResponse>>
@@ -136,7 +139,9 @@ end
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **employment_status** | [**EmploymentStatusNotNull**](.md) | Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)  | [optional] |
 
 ### Return type
 

data/docs/CreateEmployeeRequest.md

@@ -18,7 +18,7 @@
 | **ethnicity** | **String** |  | [optional] |
 | **marital_status** | **String** |  | [optional] |
 | **date_of_birth** | **Date** |  | [optional] |
-| **employment_status** | **String** |  | [optional] |
+| **employment_status** | [**EmploymentStatusNotNullRequest**](EmploymentStatusNotNullRequest.md) |  | [optional] |
 | **employment_type** | **String** |  | [optional] |
 | **start_date** | **Date** |  | [optional] |
 | **termination_date** | **Date** |  | [optional] |
@@ -30,6 +30,8 @@
 | **employments** | [**Array<EmploymentNoNullEnumRequest>**](EmploymentNoNullEnumRequest.md) |  | [optional] |
 | **custom_fields** | **Object** |  | [optional] |
 | **groups** | [**Array<GroupNoNullEnumRequest>**](GroupNoNullEnumRequest.md) |  | [optional] |
+| **dependents** | [**Array<CreateEmployeeRequestDependents>**](CreateEmployeeRequestDependents.md) |  | [optional] |
+| **emergency_contacts** | [**Array<CreateEmployeeRequestEmergencyContacts>**](CreateEmployeeRequestEmergencyContacts.md) |  | [optional] |
 
 ## Example
 
@@ -51,7 +53,7 @@ instance = OpenapiClient::CreateEmployeeRequest.new(
   ethnicity: white,
   marital_status: single,
   date_of_birth: Sat Nov 10 00:00:00 UTC 1990,
-  employment_status: active,
+  employment_status: null,
   employment_type: full_time,
   start_date: Sun Oct 11 00:00:00 UTC 2020,
   termination_date: Tue Oct 12 00:00:00 UTC 2021,
@@ -62,7 +64,9 @@ instance = OpenapiClient::CreateEmployeeRequest.new(
   bank_account: null,
   employments: null,
   custom_fields: {"t_shirt_size":"medium"},
-  groups: [{"id":"4B9bKBpX5tnwjiG93TAqF7ci","remote_id":"df6c28e8","name":"backend","type":"team"},{"id":"132Xpnw2a38aaQG93TAqF7ci","remote_id":"355c65922637","name":"engineering","type":"department"}]
+  groups: [{"id":"4B9bKBpX5tnwjiG93TAqF7ci","remote_id":"df6c28e8","name":"backend","type":"team"},{"id":"132Xpnw2a38aaQG93TAqF7ci","remote_id":"355c65922637","name":"engineering","type":"department"}],
+  dependents: null,
+  emergency_contacts: null
 )
 ```
 

data/docs/CreateEmployeeRequestDependents.md

@@ -0,0 +1,20 @@
+# OpenapiClient::CreateEmployeeRequestDependents
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **relationship** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::CreateEmployeeRequestDependents.new(
+  name: null,
+  relationship: null
+)
+```
+

data/docs/CreateEmployeeRequestEmergencyContacts.md

@@ -0,0 +1,26 @@
+# OpenapiClient::CreateEmployeeRequestEmergencyContacts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+| **relationship** | **String** |  |  |
+| **mobile_phone_number** | **String** |  |  |
+| **primary_contact** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::CreateEmployeeRequestEmergencyContacts.new(
+  first_name: null,
+  last_name: null,
+  relationship: null,
+  mobile_phone_number: null,
+  primary_contact: null
+)
+```
+

data/docs/EmployeeResponse.md

@@ -20,7 +20,7 @@
 | **ethnicity** | **String** |  |  |
 | **marital_status** | **String** | `other` option can include co-habitating, civil partnership, separated, divorced, widowed, etc  |  |
 | **date_of_birth** | **Date** |  |  |
-| **employment_status** | **String** |  |  |
+| **employment_status** | [**EmploymentStatusResponse**](EmploymentStatusResponse.md) |  |  |
 | **employment_type** | **String** |  |  |
 | **start_date** | **Date** |  |  |
 | **remote_created_at** | **Date** |  | [readonly] |
@@ -33,6 +33,8 @@
 | **employments** | [**Array<EmploymentResponse>**](EmploymentResponse.md) |  |  |
 | **custom_fields** | **Object** |  |  |
 | **groups** | [**Array<GroupResponse>**](GroupResponse.md) |  |  |
+| **dependents** | [**Array<CreateEmployeeRequestDependents>**](CreateEmployeeRequestDependents.md) |  |  |
+| **emergency_contacts** | [**Array<CreateEmployeeRequestEmergencyContacts>**](CreateEmployeeRequestEmergencyContacts.md) |  |  |
 
 ## Example
 
@@ -56,7 +58,7 @@ instance = OpenapiClient::EmployeeResponse.new(
   ethnicity: white,
   marital_status: single,
   date_of_birth: Sat Nov 10 00:00:00 UTC 1990,
-  employment_status: active,
+  employment_status: null,
   employment_type: full_time,
   start_date: Sun Oct 11 00:00:00 UTC 2020,
   remote_created_at: Sun Oct 11 00:00:00 UTC 2020,
@@ -68,7 +70,9 @@ instance = OpenapiClient::EmployeeResponse.new(
   bank_account: null,
   employments: null,
   custom_fields: {"t_shirt_size":"medium"},
-  groups: [{"id":"4B9bKBpX5tnwjiG93TAqF7ci","remote_id":"df6c28e8","name":"backend","type":"team"},{"id":"132Xpnw2a38aaQG93TAqF7ci","remote_id":"355c65922637","name":"engineering","type":"department"}]
+  groups: [{"id":"4B9bKBpX5tnwjiG93TAqF7ci","remote_id":"df6c28e8","name":"backend","type":"team"},{"id":"132Xpnw2a38aaQG93TAqF7ci","remote_id":"355c65922637","name":"engineering","type":"department"}],
+  dependents: null,
+  emergency_contacts: null
 )
 ```
 

data/docs/EmploymentStatus.md

@@ -0,0 +1,15 @@
+# OpenapiClient::EmploymentStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::EmploymentStatus.new()
+```
+

data/docs/EmploymentStatusNotNull.md

@@ -0,0 +1,15 @@
+# OpenapiClient::EmploymentStatusNotNull
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::EmploymentStatusNotNull.new()
+```
+

data/docs/EmploymentStatusNotNullRequest.md

@@ -0,0 +1,15 @@
+# OpenapiClient::EmploymentStatusNotNullRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::EmploymentStatusNotNullRequest.new()
+```
+

data/docs/EmploymentStatusResponse.md

@@ -0,0 +1,15 @@
+# OpenapiClient::EmploymentStatusResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::EmploymentStatusResponse.new()
+```
+

data/docs/XHRVerticallyIntegratedApi.md

@@ -86,7 +86,7 @@ This endpoint does not need any parameter.
 
 ## xhr_employees20230301
 
-> <Array<EmployeeResponse>> xhr_employees20230301
+> <Array<EmployeeResponse>> xhr_employees20230301(opts)
 
 Employees
 
@@ -106,10 +106,13 @@ OpenapiClient.configure do |config|
 end
 
 api_instance = OpenapiClient::XHRVerticallyIntegratedApi.new
+opts = {
+  employment_status: OpenapiClient::EmploymentStatusNotNull::ACTIVE # EmploymentStatusNotNull | Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set) 
+}
 
 begin
   # Employees
-  result = api_instance.xhr_employees20230301
+  result = api_instance.xhr_employees20230301(opts)
   p result
 rescue OpenapiClient::ApiError => e
   puts "Error when calling XHRVerticallyIntegratedApi->xhr_employees20230301: #{e}"
@@ -120,12 +123,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<EmployeeResponse>>, Integer, Hash)> xhr_employees20230301_with_http_info
+> <Array(<Array<EmployeeResponse>>, Integer, Hash)> xhr_employees20230301_with_http_info(opts)
 
 ```ruby
 begin
   # Employees
-  data, status_code, headers = api_instance.xhr_employees20230301_with_http_info
+  data, status_code, headers = api_instance.xhr_employees20230301_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<EmployeeResponse>>
@@ -136,7 +139,9 @@ end
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **employment_status** | [**EmploymentStatusNotNull**](.md) | Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set)  | [optional] |
 
 ### Return type
 

data/lib/openapi_client/api/class20230301_api.rb

@@ -79,6 +79,7 @@ module OpenapiClient
     # Employees
     # List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software 
     # @param [Hash] opts the optional parameters
+    # @option opts [EmploymentStatusNotNull] :employment_status Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set) 
     # @return [Array<EmployeeResponse>]
     def xhr_employees20230301(opts = {})
       data, _status_code, _headers = xhr_employees20230301_with_http_info(opts)
@@ -88,6 +89,7 @@ module OpenapiClient
     # Employees
     # List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software 
     # @param [Hash] opts the optional parameters
+    # @option opts [EmploymentStatusNotNull] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set) 
     # @return [Array<(Array<EmployeeResponse>, Integer, Hash)>] Array<EmployeeResponse> data, response status code and response headers
     def xhr_employees20230301_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -98,6 +100,7 @@ module OpenapiClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'employment_status'] = opts[:'employment_status'] if !opts[:'employment_status'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/openapi_client/api/xhr_vertically_integrated_api.rb

@@ -79,6 +79,7 @@ module OpenapiClient
     # Employees
     # List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software 
     # @param [Hash] opts the optional parameters
+    # @option opts [EmploymentStatusNotNull] :employment_status Enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set) 
     # @return [Array<EmployeeResponse>]
     def xhr_employees20230301(opts = {})
       data, _status_code, _headers = xhr_employees20230301_with_http_info(opts)
@@ -88,6 +89,7 @@ module OpenapiClient
     # Employees
     # List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software 
     # @param [Hash] opts the optional parameters
+    # @option opts [EmploymentStatusNotNull] :employment_status Enable server-side filtering of the &#x60;employment_status&#x60; attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a &#x60;null&#x60;, it will not be returned if this parameter is set) 
     # @return [Array<(Array<EmployeeResponse>, Integer, Hash)>] Array<EmployeeResponse> data, response status code and response headers
     def xhr_employees20230301_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -98,6 +100,7 @@ module OpenapiClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'employment_status'] = opts[:'employment_status'] if !opts[:'employment_status'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/openapi_client/models/create_employee_request.rb

@@ -72,6 +72,10 @@ module OpenapiClient
 
     attr_accessor :groups
 
+    attr_accessor :dependents
+
+    attr_accessor :emergency_contacts
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -122,7 +126,9 @@ module OpenapiClient
         :'bank_account' => :'bank_account',
         :'employments' => :'employments',
         :'custom_fields' => :'custom_fields',
-        :'groups' => :'groups'
+        :'groups' => :'groups',
+        :'dependents' => :'dependents',
+        :'emergency_contacts' => :'emergency_contacts'
       }
     end
 
@@ -148,7 +154,7 @@ module OpenapiClient
         :'ethnicity' => :'String',
         :'marital_status' => :'String',
         :'date_of_birth' => :'Date',
-        :'employment_status' => :'String',
+        :'employment_status' => :'EmploymentStatusNotNullRequest',
         :'employment_type' => :'String',
         :'start_date' => :'Date',
         :'termination_date' => :'Date',
@@ -159,7 +165,9 @@ module OpenapiClient
         :'bank_account' => :'CreateEmployeeRequestBankAccount',
         :'employments' => :'Array<EmploymentNoNullEnumRequest>',
         :'custom_fields' => :'Object',
-        :'groups' => :'Array<GroupNoNullEnumRequest>'
+        :'groups' => :'Array<GroupNoNullEnumRequest>',
+        :'dependents' => :'Array<CreateEmployeeRequestDependents>',
+        :'emergency_contacts' => :'Array<CreateEmployeeRequestEmergencyContacts>'
       }
     end
 
@@ -189,7 +197,9 @@ module OpenapiClient
         :'bank_account',
         :'employments',
         :'custom_fields',
-        :'groups'
+        :'groups',
+        :'dependents',
+        :'emergency_contacts'
       ])
     end
 
@@ -315,6 +325,18 @@ module OpenapiClient
           self.groups = value
         end
       end
+
+      if attributes.key?(:'dependents')
+        if (value = attributes[:'dependents']).is_a?(Array)
+          self.dependents = value
+        end
+      end
+
+      if attributes.key?(:'emergency_contacts')
+        if (value = attributes[:'emergency_contacts']).is_a?(Array)
+          self.emergency_contacts = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -343,8 +365,6 @@ module OpenapiClient
       return false unless ethnicity_validator.valid?(@ethnicity)
       marital_status_validator = EnumAttributeValidator.new('String', ["single", "married", "not_specified"])
       return false unless marital_status_validator.valid?(@marital_status)
-      employment_status_validator = EnumAttributeValidator.new('String', ["active", "inactive", "pending", "leave"])
-      return false unless employment_status_validator.valid?(@employment_status)
       employment_type_validator = EnumAttributeValidator.new('String', ["full_time", "part_time", "contractor", "other"])
       return false unless employment_type_validator.valid?(@employment_type)
       true
@@ -380,16 +400,6 @@ module OpenapiClient
       @marital_status = marital_status
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] employment_status Object to be assigned
-    def employment_status=(employment_status)
-      validator = EnumAttributeValidator.new('String', ["active", "inactive", "pending", "leave"])
-      unless validator.valid?(employment_status)
-        fail ArgumentError, "invalid value for \"employment_status\", must be one of #{validator.allowable_values}."
-      end
-      @employment_status = employment_status
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] employment_type Object to be assigned
     def employment_type=(employment_type)
@@ -430,7 +440,9 @@ module OpenapiClient
           bank_account == o.bank_account &&
           employments == o.employments &&
           custom_fields == o.custom_fields &&
-          groups == o.groups
+          groups == o.groups &&
+          dependents == o.dependents &&
+          emergency_contacts == o.emergency_contacts
     end
 
     # @see the `==` method
@@ -442,7 +454,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [employee_number, first_name, last_name, display_full_name, nationality, job_title, work_email, personal_email, mobile_phone_number, tax_id, gender, ethnicity, marital_status, date_of_birth, employment_status, employment_type, start_date, termination_date, avatar, home_location, work_location, manager, bank_account, employments, custom_fields, groups].hash
+      [employee_number, first_name, last_name, display_full_name, nationality, job_title, work_email, personal_email, mobile_phone_number, tax_id, gender, ethnicity, marital_status, date_of_birth, employment_status, employment_type, start_date, termination_date, avatar, home_location, work_location, manager, bank_account, employments, custom_fields, groups, dependents, emergency_contacts].hash
     end
 
     # Builds the object from hash