stackone_hris_client 1.3.1 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -5
  3. data/README.md +13 -5
  4. data/docs/AccountsApi.md +4 -7
  5. data/docs/CompaniesApi.md +13 -15
  6. data/docs/ConnectSession.md +1 -1
  7. data/docs/ConnectSessionCreate.md +3 -1
  8. data/docs/ConnectSessionToken.md +1 -1
  9. data/docs/ConnectSessionsApi.md +3 -5
  10. data/docs/Employee.md +8 -8
  11. data/docs/EmployeesApi.md +17 -15
  12. data/docs/Employment.md +3 -3
  13. data/docs/EmploymentStatusEnum.md +20 -0
  14. data/docs/EmploymentTypeEnum.md +20 -0
  15. data/docs/EmploymentsApi.md +13 -15
  16. data/docs/EthnicityEnum.md +20 -0
  17. data/docs/GenderEnum.md +20 -0
  18. data/docs/Location.md +1 -1
  19. data/docs/LocationTypeEnum.md +20 -0
  20. data/docs/LocationsApi.md +13 -15
  21. data/docs/MaritalStatusEnum.md +20 -0
  22. data/docs/PayFrequencyEnum.md +20 -0
  23. data/docs/PayPeriodEnum.md +20 -0
  24. data/gem-config.yml +1 -1
  25. data/lib/stackone_hris_client/api/companies_api.rb +12 -12
  26. data/lib/stackone_hris_client/api/employees_api.rb +18 -12
  27. data/lib/stackone_hris_client/api/employments_api.rb +12 -12
  28. data/lib/stackone_hris_client/api/locations_api.rb +12 -12
  29. data/lib/stackone_hris_client/models/connect_session_create.rb +13 -1
  30. data/lib/stackone_hris_client/models/employee.rb +8 -90
  31. data/lib/stackone_hris_client/models/employment.rb +3 -61
  32. data/lib/stackone_hris_client/models/employment_status_enum.rb +270 -0
  33. data/lib/stackone_hris_client/models/employment_type_enum.rb +270 -0
  34. data/lib/stackone_hris_client/models/ethnicity_enum.rb +270 -0
  35. data/lib/stackone_hris_client/models/gender_enum.rb +270 -0
  36. data/lib/stackone_hris_client/models/location.rb +1 -35
  37. data/lib/stackone_hris_client/models/location_type_enum.rb +270 -0
  38. data/lib/stackone_hris_client/models/marital_status_enum.rb +270 -0
  39. data/lib/stackone_hris_client/models/pay_frequency_enum.rb +270 -0
  40. data/lib/stackone_hris_client/models/pay_period_enum.rb +270 -0
  41. data/lib/stackone_hris_client/version.rb +1 -1
  42. data/lib/stackone_hris_client.rb +8 -0
  43. data/spec/configuration_spec.rb +3 -3
  44. data/spec/models/employment_status_enum_spec.rb +44 -0
  45. data/spec/models/employment_type_enum_spec.rb +44 -0
  46. data/spec/models/ethnicity_enum_spec.rb +44 -0
  47. data/spec/models/gender_enum_spec.rb +44 -0
  48. data/spec/models/location_type_enum_spec.rb +44 -0
  49. data/spec/models/marital_status_enum_spec.rb +44 -0
  50. data/spec/models/pay_frequency_enum_spec.rb +44 -0
  51. data/spec/models/pay_period_enum_spec.rb +44 -0
  52. metadata +34 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1f1bac9ffe1525736d5a4ee2b28ee7e86cc2dd02bad121ecca41aa0ab4e63626
4
- data.tar.gz: feabaa81170c42b918e0b38779adc0c3f7880fdd6986af237b3a7b71c553c0d6
3
+ metadata.gz: 845acb267d5359b3b0411e931280dfef500666c6dfba03752b42641508085911
4
+ data.tar.gz: 62184c488d9209a4f1e0abb7dfb3532a545ce0c36fa1b9840324e59aa7c8aaef
5
5
  SHA512:
6
- metadata.gz: ddc9ed201b396bdd1bece98c4a182ce9fa922c613a5559b6e708d15ad271238ae40c8713b29ce8913ce712fb3b9caf5942423ad264b3587dc44fd02a28204117
7
- data.tar.gz: 1e21f2116a2d4808dd455e3b9ea6759c3c12b79a86a6dfede62b10cda78b2927e15c58ba9c893d80dc4f275812ea994522fe64f0455e702770af37ce508a4a23
6
+ metadata.gz: 17d0671c4becc2ef6870acbf341880de8c99e873bb7f0a91a2cb0c0c186a55891a24d073cbabb76294b130219d73ae0b517b7c07af94d5ac1d2ad51f8d01767b
7
+ data.tar.gz: 713def3d66e7e821d37eb5b30c2095bdaa3f8cd9240f3c6f696963289f9a6f6c53a873b9bc5b8599b51c2c8858c1ad5462406d028c71ca79462cee29ad335dfd
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- stackone_hris_client (1.3.1)
4
+ stackone_hris_client (1.4.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -16,8 +16,8 @@ GEM
16
16
  ffi (1.15.5)
17
17
  json (2.6.3)
18
18
  method_source (1.0.0)
19
- parallel (1.22.1)
20
- parser (3.2.1.1)
19
+ parallel (1.23.0)
20
+ parser (3.2.2.1)
21
21
  ast (~> 2.4.1)
22
22
  pry (0.14.2)
23
23
  coderay (~> 1.1)
@@ -27,7 +27,7 @@ GEM
27
27
  pry (>= 0.13, < 0.15)
28
28
  rainbow (3.1.1)
29
29
  rake (13.0.6)
30
- regexp_parser (2.7.0)
30
+ regexp_parser (2.8.0)
31
31
  rexml (3.2.5)
32
32
  rspec (3.12.0)
33
33
  rspec-core (~> 3.12.0)
@@ -52,7 +52,7 @@ GEM
52
52
  rubocop-ast (>= 1.26.0, < 2.0)
53
53
  ruby-progressbar (~> 1.7)
54
54
  unicode-display_width (>= 2.4.0, < 3.0)
55
- rubocop-ast (1.28.0)
55
+ rubocop-ast (1.28.1)
56
56
  parser (>= 3.2.1.0)
57
57
  ruby-progressbar (1.13.0)
58
58
  typhoeus (1.4.0)
data/README.md CHANGED
@@ -7,7 +7,7 @@ The documentation for the StackOne Unified API - HRIS
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 1.0.0
10
- - Package version: 1.3.1
10
+ - Package version: 1.4.0
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,16 +23,16 @@ gem build stackone_hris_client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./stackone_hris_client-1.3.1.gem
26
+ gem install ./stackone_hris_client-1.4.0.gem
27
27
  ```
28
28
 
29
- (for development, run `gem install --dev ./stackone_hris_client-1.3.1.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./stackone_hris_client-1.4.0.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'stackone_hris_client', '~> 1.3.1'
35
+ gem 'stackone_hris_client', '~> 1.4.0'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -85,7 +85,7 @@ end
85
85
 
86
86
  ## Documentation for API Endpoints
87
87
 
88
- All URIs are relative to *http://localhost*
88
+ All URIs are relative to *https://api.stackone.com*
89
89
 
90
90
  Class | Method | HTTP request | Description
91
91
  ------------ | ------------- | ------------- | -------------
@@ -119,10 +119,18 @@ Class | Method | HTTP request | Description
119
119
  - [StackOneHRIS::EmployeesPaginated](docs/EmployeesPaginated.md)
120
120
  - [StackOneHRIS::Employment](docs/Employment.md)
121
121
  - [StackOneHRIS::EmploymentResult](docs/EmploymentResult.md)
122
+ - [StackOneHRIS::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
123
+ - [StackOneHRIS::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
122
124
  - [StackOneHRIS::EmploymentsPaginated](docs/EmploymentsPaginated.md)
125
+ - [StackOneHRIS::EthnicityEnum](docs/EthnicityEnum.md)
126
+ - [StackOneHRIS::GenderEnum](docs/GenderEnum.md)
123
127
  - [StackOneHRIS::Location](docs/Location.md)
124
128
  - [StackOneHRIS::LocationResult](docs/LocationResult.md)
129
+ - [StackOneHRIS::LocationTypeEnum](docs/LocationTypeEnum.md)
125
130
  - [StackOneHRIS::LocationsPaginated](docs/LocationsPaginated.md)
131
+ - [StackOneHRIS::MaritalStatusEnum](docs/MaritalStatusEnum.md)
132
+ - [StackOneHRIS::PayFrequencyEnum](docs/PayFrequencyEnum.md)
133
+ - [StackOneHRIS::PayPeriodEnum](docs/PayPeriodEnum.md)
126
134
 
127
135
 
128
136
  ## Documentation for Authorization
data/docs/AccountsApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # StackOneHRIS::AccountsApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *https://api.stackone.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
@@ -23,8 +23,7 @@ require 'stackone_hris_client'
23
23
  # setup authorization
24
24
  StackOneHRIS.configure do |config|
25
25
  # Configure HTTP basic authorization: basic
26
- config.username = 'YOUR USERNAME'
27
- config.password = 'YOUR PASSWORD'
26
+ config.api_key_token = 'YOUR API KEY'
28
27
  end
29
28
 
30
29
  api_instance = StackOneHRIS::AccountsApi.new
@@ -91,8 +90,7 @@ require 'stackone_hris_client'
91
90
  # setup authorization
92
91
  StackOneHRIS.configure do |config|
93
92
  # Configure HTTP basic authorization: basic
94
- config.username = 'YOUR USERNAME'
95
- config.password = 'YOUR PASSWORD'
93
+ config.api_key_token = 'YOUR API KEY'
96
94
  end
97
95
 
98
96
  api_instance = StackOneHRIS::AccountsApi.new
@@ -159,8 +157,7 @@ require 'stackone_hris_client'
159
157
  # setup authorization
160
158
  StackOneHRIS.configure do |config|
161
159
  # Configure HTTP basic authorization: basic
162
- config.username = 'YOUR USERNAME'
163
- config.password = 'YOUR PASSWORD'
160
+ config.api_key_token = 'YOUR API KEY'
164
161
  end
165
162
 
166
163
  api_instance = StackOneHRIS::AccountsApi.new
data/docs/CompaniesApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # StackOneHRIS::CompaniesApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *https://api.stackone.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
@@ -22,8 +22,7 @@ require 'stackone_hris_client'
22
22
  # setup authorization
23
23
  StackOneHRIS.configure do |config|
24
24
  # Configure HTTP basic authorization: basic
25
- config.username = 'YOUR USERNAME'
26
- config.password = 'YOUR PASSWORD'
25
+ config.api_key_token = 'YOUR API KEY'
27
26
  end
28
27
 
29
28
  api_instance = StackOneHRIS::CompaniesApi.new
@@ -33,9 +32,9 @@ opts = {
33
32
  page: 'page_example', # String | The page number of the results to fetch
34
33
  page_size: 'page_size_example', # String | The number of results per page
35
34
  raw: true, # Boolean | Indicates that the raw request result is returned
36
- fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
37
- expand: ['inner_example'], # Array<String> | The list of fields that will be expanded in the response
38
- sync_token: 'sync_token_example' # String | The sync token to select the only updated results
35
+ fields: 'id,full_name,display_name', # String | The comma separated list of fields to return in the response (if empty, all fields are returned)
36
+ sync_token: 'sync_token_example', # String | The sync token to select the only updated results
37
+ updated_after: 'updated_after_example' # String | Use a string with a date to only select results updated after that given date
39
38
  }
40
39
 
41
40
  begin
@@ -74,9 +73,9 @@ end
74
73
  | **page** | **String** | The page number of the results to fetch | [optional] |
75
74
  | **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
76
75
  | **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
77
- | **fields** | [**Array&lt;String&gt;**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
78
- | **expand** | [**Array&lt;String&gt;**](String.md) | The list of fields that will be expanded in the response | [optional] |
76
+ | **fields** | **String** | The comma separated list of fields to return in the response (if empty, all fields are returned) | [optional][default to &#39;&#39;] |
79
77
  | **sync_token** | **String** | The sync token to select the only updated results | [optional] |
78
+ | **updated_after** | **String** | Use a string with a date to only select results updated after that given date | [optional] |
80
79
 
81
80
  ### Return type
82
81
 
@@ -106,8 +105,7 @@ require 'stackone_hris_client'
106
105
  # setup authorization
107
106
  StackOneHRIS.configure do |config|
108
107
  # Configure HTTP basic authorization: basic
109
- config.username = 'YOUR USERNAME'
110
- config.password = 'YOUR PASSWORD'
108
+ config.api_key_token = 'YOUR API KEY'
111
109
  end
112
110
 
113
111
  api_instance = StackOneHRIS::CompaniesApi.new
@@ -116,9 +114,9 @@ opts = {
116
114
  page: 'page_example', # String | The page number of the results to fetch
117
115
  page_size: 'page_size_example', # String | The number of results per page
118
116
  raw: true, # Boolean | Indicates that the raw request result is returned
119
- fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
120
- expand: ['inner_example'], # Array<String> | The list of fields that will be expanded in the response
121
- sync_token: 'sync_token_example' # String | The sync token to select the only updated results
117
+ fields: 'id,full_name,display_name', # String | The comma separated list of fields to return in the response (if empty, all fields are returned)
118
+ sync_token: 'sync_token_example', # String | The sync token to select the only updated results
119
+ updated_after: 'updated_after_example' # String | Use a string with a date to only select results updated after that given date
122
120
  }
123
121
 
124
122
  begin
@@ -156,9 +154,9 @@ end
156
154
  | **page** | **String** | The page number of the results to fetch | [optional] |
157
155
  | **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
158
156
  | **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
159
- | **fields** | [**Array&lt;String&gt;**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
160
- | **expand** | [**Array&lt;String&gt;**](String.md) | The list of fields that will be expanded in the response | [optional] |
157
+ | **fields** | **String** | The comma separated list of fields to return in the response (if empty, all fields are returned) | [optional][default to &#39;&#39;] |
161
158
  | **sync_token** | **String** | The sync token to select the only updated results | [optional] |
159
+ | **updated_after** | **String** | Use a string with a date to only select results updated after that given date | [optional] |
162
160
 
163
161
  ### Return type
164
162
 
data/docs/ConnectSession.md CHANGED
@@ -23,7 +23,7 @@ instance = StackOneHRIS::ConnectSession.new(
23
23
  id: null,
24
24
  organization_id: null,
25
25
  project_id: null,
26
- categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;],
26
+ categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;,&quot;common&quot;],
27
27
  provider: null,
28
28
  origin_owner_id: null,
29
29
  origin_owner_name: null,
data/docs/ConnectSessionCreate.md CHANGED
@@ -9,6 +9,7 @@
9
9
  | **origin_owner_id** | **String** | The origin owner identifier | |
10
10
  | **origin_owner_name** | **String** | The origin owner name | |
11
11
  | **origin_username** | **String** | The origin username | [optional] |
12
+ | **expires_in** | **Float** | How long the session should be valid for in seconds | [optional][default to 1800] |
12
13
  | **metadata** | **Object** | The metadata for the connection | [optional] |
13
14
 
14
15
  ## Example
@@ -17,11 +18,12 @@
17
18
  require 'stackone_hris_client'
18
19
 
19
20
  instance = StackOneHRIS::ConnectSessionCreate.new(
20
- categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;],
21
+ categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;,&quot;common&quot;],
21
22
  provider: null,
22
23
  origin_owner_id: null,
23
24
  origin_owner_name: null,
24
25
  origin_username: null,
26
+ expires_in: null,
25
27
  metadata: null
26
28
  )
27
29
  ```
data/docs/ConnectSessionToken.md CHANGED
@@ -24,7 +24,7 @@ instance = StackOneHRIS::ConnectSessionToken.new(
24
24
  id: null,
25
25
  organization_id: null,
26
26
  project_id: null,
27
- categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;],
27
+ categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;,&quot;common&quot;],
28
28
  provider: null,
29
29
  origin_owner_id: null,
30
30
  origin_owner_name: null,
data/docs/ConnectSessionsApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # StackOneHRIS::ConnectSessionsApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *https://api.stackone.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
@@ -22,8 +22,7 @@ require 'stackone_hris_client'
22
22
  # setup authorization
23
23
  StackOneHRIS.configure do |config|
24
24
  # Configure HTTP basic authorization: basic
25
- config.username = 'YOUR USERNAME'
26
- config.password = 'YOUR PASSWORD'
25
+ config.api_key_token = 'YOUR API KEY'
27
26
  end
28
27
 
29
28
  api_instance = StackOneHRIS::ConnectSessionsApi.new
@@ -90,8 +89,7 @@ require 'stackone_hris_client'
90
89
  # setup authorization
91
90
  StackOneHRIS.configure do |config|
92
91
  # Configure HTTP basic authorization: basic
93
- config.username = 'YOUR USERNAME'
94
- config.password = 'YOUR PASSWORD'
92
+ config.api_key_token = 'YOUR API KEY'
95
93
  end
96
94
 
97
95
  api_instance = StackOneHRIS::ConnectSessionsApi.new
data/docs/Employee.md CHANGED
@@ -9,11 +9,11 @@
9
9
  | **last_name** | **String** | | |
10
10
  | **name** | **String** | | |
11
11
  | **display_name** | **String** | | |
12
- | **gender** | **String** | | |
13
- | **ethnicity** | **String** | | [optional] |
12
+ | **gender** | [**GenderEnum**](GenderEnum.md) | | |
13
+ | **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | | [optional] |
14
14
  | **date_of_birth** | **Time** | | [optional] |
15
15
  | **birthday** | **Time** | | [optional] |
16
- | **marital_status** | **String** | | [optional] |
16
+ | **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | | [optional] |
17
17
  | **avatar_url** | **String** | | [optional] |
18
18
  | **personal_email** | **String** | | [optional] |
19
19
  | **personal_phone_number** | **String** | | |
@@ -26,16 +26,16 @@
26
26
  | **start_date** | **Time** | | [optional] |
27
27
  | **tenure** | **Float** | | [optional] |
28
28
  | **work_anniversary** | **Time** | | [optional] |
29
- | **employment_type** | **String** | | [optional] |
30
- | **employment_status** | **String** | | [optional] |
29
+ | **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | | [optional] |
30
+ | **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | | [optional] |
31
31
  | **termination_date** | **Time** | | [optional] |
32
32
  | **company_name** | **String** | | [optional] |
33
33
  | **home_country_location** | **String** | | [optional] |
34
34
  | **work_country_location** | **String** | | [optional] |
35
- | **home_location** | **String** | | [optional] |
36
- | **work_location** | **String** | | [optional] |
35
+ | **home_location** | [**Location**](Location.md) | | [optional] |
36
+ | **work_location** | [**Location**](Location.md) | | [optional] |
37
37
  | **company** | **String** | | [optional] |
38
- | **employments** | **Array&lt;String&gt;** | | [optional] |
38
+ | **employments** | [**Array&lt;Employment&gt;**](Employment.md) | | [optional] |
39
39
 
40
40
  ## Example
41
41
 
data/docs/EmployeesApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # StackOneHRIS::EmployeesApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *https://api.stackone.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
@@ -22,8 +22,7 @@ require 'stackone_hris_client'
22
22
  # setup authorization
23
23
  StackOneHRIS.configure do |config|
24
24
  # Configure HTTP basic authorization: basic
25
- config.username = 'YOUR USERNAME'
26
- config.password = 'YOUR PASSWORD'
25
+ config.api_key_token = 'YOUR API KEY'
27
26
  end
28
27
 
29
28
  api_instance = StackOneHRIS::EmployeesApi.new
@@ -33,9 +32,10 @@ opts = {
33
32
  page: 'page_example', # String | The page number of the results to fetch
34
33
  page_size: 'page_size_example', # String | The number of results per page
35
34
  raw: true, # Boolean | Indicates that the raw request result is returned
36
- fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
37
- expand: ['inner_example'], # Array<String> | The list of fields that will be expanded in the response
38
- sync_token: 'sync_token_example' # String | The sync token to select the only updated results
35
+ fields: 'id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,personal_email,personal_phone_number,work_email,work_phone_number,job_title,department,manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_status,termination_date,company_name,home_country_location,work_country_location', # String | The comma separated list of fields to return in the response (if empty, all fields are returned)
36
+ sync_token: 'sync_token_example', # String | The sync token to select the only updated results
37
+ updated_after: 'updated_after_example', # String | Use a string with a date to only select results updated after that given date
38
+ expand: 'work_location,home_location,employments' # String | The comma separated list of fields that will be expanded in the response
39
39
  }
40
40
 
41
41
  begin
@@ -74,9 +74,10 @@ end
74
74
  | **page** | **String** | The page number of the results to fetch | [optional] |
75
75
  | **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
76
76
  | **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
77
- | **fields** | [**Array&lt;String&gt;**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
78
- | **expand** | [**Array&lt;String&gt;**](String.md) | The list of fields that will be expanded in the response | [optional] |
77
+ | **fields** | **String** | The comma separated list of fields to return in the response (if empty, all fields are returned) | [optional][default to &#39;&#39;] |
79
78
  | **sync_token** | **String** | The sync token to select the only updated results | [optional] |
79
+ | **updated_after** | **String** | Use a string with a date to only select results updated after that given date | [optional] |
80
+ | **expand** | **String** | The comma separated list of fields that will be expanded in the response | [optional][default to &#39;&#39;] |
80
81
 
81
82
  ### Return type
82
83
 
@@ -106,8 +107,7 @@ require 'stackone_hris_client'
106
107
  # setup authorization
107
108
  StackOneHRIS.configure do |config|
108
109
  # Configure HTTP basic authorization: basic
109
- config.username = 'YOUR USERNAME'
110
- config.password = 'YOUR PASSWORD'
110
+ config.api_key_token = 'YOUR API KEY'
111
111
  end
112
112
 
113
113
  api_instance = StackOneHRIS::EmployeesApi.new
@@ -116,9 +116,10 @@ opts = {
116
116
  page: 'page_example', # String | The page number of the results to fetch
117
117
  page_size: 'page_size_example', # String | The number of results per page
118
118
  raw: true, # Boolean | Indicates that the raw request result is returned
119
- fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
120
- expand: ['inner_example'], # Array<String> | The list of fields that will be expanded in the response
121
- sync_token: 'sync_token_example' # String | The sync token to select the only updated results
119
+ fields: 'id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,personal_email,personal_phone_number,work_email,work_phone_number,job_title,department,manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_status,termination_date,company_name,home_country_location,work_country_location', # String | The comma separated list of fields to return in the response (if empty, all fields are returned)
120
+ sync_token: 'sync_token_example', # String | The sync token to select the only updated results
121
+ updated_after: 'updated_after_example', # String | Use a string with a date to only select results updated after that given date
122
+ expand: 'work_location,home_location,employments' # String | The comma separated list of fields that will be expanded in the response
122
123
  }
123
124
 
124
125
  begin
@@ -156,9 +157,10 @@ end
156
157
  | **page** | **String** | The page number of the results to fetch | [optional] |
157
158
  | **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
158
159
  | **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
159
- | **fields** | [**Array&lt;String&gt;**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
160
- | **expand** | [**Array&lt;String&gt;**](String.md) | The list of fields that will be expanded in the response | [optional] |
160
+ | **fields** | **String** | The comma separated list of fields to return in the response (if empty, all fields are returned) | [optional][default to &#39;&#39;] |
161
161
  | **sync_token** | **String** | The sync token to select the only updated results | [optional] |
162
+ | **updated_after** | **String** | Use a string with a date to only select results updated after that given date | [optional] |
163
+ | **expand** | **String** | The comma separated list of fields that will be expanded in the response | [optional][default to &#39;&#39;] |
162
164
 
163
165
  ### Return type
164
166
 
data/docs/Employment.md CHANGED
@@ -8,11 +8,11 @@
8
8
  | **employee_id** | **String** | | |
9
9
  | **job_title** | **String** | | [optional] |
10
10
  | **pay_rate** | **String** | | [optional] |
11
- | **pay_period** | **String** | | [optional] |
12
- | **pay_frequency** | **String** | | [optional] |
11
+ | **pay_period** | [**PayPeriodEnum**](PayPeriodEnum.md) | | [optional] |
12
+ | **pay_frequency** | [**PayFrequencyEnum**](PayFrequencyEnum.md) | | [optional] |
13
13
  | **pay_currency** | **String** | | [optional] |
14
14
  | **effective_date** | **Time** | | [optional] |
15
- | **employment_type** | **String** | | [optional] |
15
+ | **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | | [optional] |
16
16
 
17
17
  ## Example
18
18
 
data/docs/EmploymentStatusEnum.md ADDED
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EmploymentStatusEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | |
8
+ | **source_value** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::EmploymentStatusEnum.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
data/docs/EmploymentTypeEnum.md ADDED
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EmploymentTypeEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | |
8
+ | **source_value** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::EmploymentTypeEnum.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
data/docs/EmploymentsApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # StackOneHRIS::EmploymentsApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *https://api.stackone.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
@@ -22,8 +22,7 @@ require 'stackone_hris_client'
22
22
  # setup authorization
23
23
  StackOneHRIS.configure do |config|
24
24
  # Configure HTTP basic authorization: basic
25
- config.username = 'YOUR USERNAME'
26
- config.password = 'YOUR PASSWORD'
25
+ config.api_key_token = 'YOUR API KEY'
27
26
  end
28
27
 
29
28
  api_instance = StackOneHRIS::EmploymentsApi.new
@@ -33,9 +32,9 @@ opts = {
33
32
  page: 'page_example', # String | The page number of the results to fetch
34
33
  page_size: 'page_size_example', # String | The number of results per page
35
34
  raw: true, # Boolean | Indicates that the raw request result is returned
36
- fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
37
- expand: ['inner_example'], # Array<String> | The list of fields that will be expanded in the response
38
- sync_token: 'sync_token_example' # String | The sync token to select the only updated results
35
+ fields: 'id,employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,employment_type', # String | The comma separated list of fields to return in the response (if empty, all fields are returned)
36
+ sync_token: 'sync_token_example', # String | The sync token to select the only updated results
37
+ updated_after: 'updated_after_example' # String | Use a string with a date to only select results updated after that given date
39
38
  }
40
39
 
41
40
  begin
@@ -74,9 +73,9 @@ end
74
73
  | **page** | **String** | The page number of the results to fetch | [optional] |
75
74
  | **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
76
75
  | **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
77
- | **fields** | [**Array&lt;String&gt;**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
78
- | **expand** | [**Array&lt;String&gt;**](String.md) | The list of fields that will be expanded in the response | [optional] |
76
+ | **fields** | **String** | The comma separated list of fields to return in the response (if empty, all fields are returned) | [optional][default to &#39;&#39;] |
79
77
  | **sync_token** | **String** | The sync token to select the only updated results | [optional] |
78
+ | **updated_after** | **String** | Use a string with a date to only select results updated after that given date | [optional] |
80
79
 
81
80
  ### Return type
82
81
 
@@ -106,8 +105,7 @@ require 'stackone_hris_client'
106
105
  # setup authorization
107
106
  StackOneHRIS.configure do |config|
108
107
  # Configure HTTP basic authorization: basic
109
- config.username = 'YOUR USERNAME'
110
- config.password = 'YOUR PASSWORD'
108
+ config.api_key_token = 'YOUR API KEY'
111
109
  end
112
110
 
113
111
  api_instance = StackOneHRIS::EmploymentsApi.new
@@ -116,9 +114,9 @@ opts = {
116
114
  page: 'page_example', # String | The page number of the results to fetch
117
115
  page_size: 'page_size_example', # String | The number of results per page
118
116
  raw: true, # Boolean | Indicates that the raw request result is returned
119
- fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
120
- expand: ['inner_example'], # Array<String> | The list of fields that will be expanded in the response
121
- sync_token: 'sync_token_example' # String | The sync token to select the only updated results
117
+ fields: 'id,employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,employment_type', # String | The comma separated list of fields to return in the response (if empty, all fields are returned)
118
+ sync_token: 'sync_token_example', # String | The sync token to select the only updated results
119
+ updated_after: 'updated_after_example' # String | Use a string with a date to only select results updated after that given date
122
120
  }
123
121
 
124
122
  begin
@@ -156,9 +154,9 @@ end
156
154
  | **page** | **String** | The page number of the results to fetch | [optional] |
157
155
  | **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
158
156
  | **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
159
- | **fields** | [**Array&lt;String&gt;**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
160
- | **expand** | [**Array&lt;String&gt;**](String.md) | The list of fields that will be expanded in the response | [optional] |
157
+ | **fields** | **String** | The comma separated list of fields to return in the response (if empty, all fields are returned) | [optional][default to &#39;&#39;] |
161
158
  | **sync_token** | **String** | The sync token to select the only updated results | [optional] |
159
+ | **updated_after** | **String** | Use a string with a date to only select results updated after that given date | [optional] |
162
160
 
163
161
  ### Return type
164
162
 
data/docs/EthnicityEnum.md ADDED
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EthnicityEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | |
8
+ | **source_value** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::EthnicityEnum.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
data/docs/GenderEnum.md ADDED
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::GenderEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | |
8
+ | **source_value** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::GenderEnum.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
data/docs/Location.md CHANGED
@@ -14,7 +14,7 @@
14
14
  | **state** | **String** | | [optional] |
15
15
  | **zip_code** | **String** | | [optional] |
16
16
  | **country** | **String** | | [optional] |
17
- | **location_type** | **String** | | [optional] |
17
+ | **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) | | [optional] |
18
18
 
19
19
  ## Example
20
20
 
data/docs/LocationTypeEnum.md ADDED
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::LocationTypeEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | |
8
+ | **source_value** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::LocationTypeEnum.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+