stackone_hris_client 1.1.0 → 1.2.1

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 (83) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +40 -24
  4. data/docs/Account.md +2 -2
  5. data/docs/AccountsApi.md +82 -11
  6. data/docs/CompaniesApi.md +175 -0
  7. data/docs/CompaniesPaginated.md +22 -0
  8. data/docs/Company.md +22 -0
  9. data/docs/CompanyResult.md +20 -0
  10. data/docs/ConnectSession.md +2 -2
  11. data/docs/ConnectSessionAuthenticate.md +2 -2
  12. data/docs/ConnectSessionCreate.md +2 -2
  13. data/docs/ConnectSessionToken.md +2 -2
  14. data/docs/ConnectSessionsApi.md +15 -13
  15. data/docs/Employee.md +44 -12
  16. data/docs/EmployeeResult.md +2 -2
  17. data/docs/EmployeesApi.md +13 -11
  18. data/docs/EmployeesPaginated.md +2 -2
  19. data/docs/Employment.md +34 -0
  20. data/docs/EmploymentResult.md +20 -0
  21. data/docs/EmploymentsApi.md +175 -0
  22. data/docs/EmploymentsPaginated.md +22 -0
  23. data/docs/Location.md +38 -0
  24. data/docs/LocationResult.md +20 -0
  25. data/docs/LocationsApi.md +175 -0
  26. data/docs/LocationsPaginated.md +22 -0
  27. data/gem-config.yml +4 -4
  28. data/lib/stackone_hris_client/api/accounts_api.rb +65 -4
  29. data/lib/stackone_hris_client/api/companies_api.rb +188 -0
  30. data/lib/stackone_hris_client/api/connect_sessions_api.rb +4 -4
  31. data/lib/stackone_hris_client/api/employees_api.rb +4 -4
  32. data/lib/stackone_hris_client/api/employments_api.rb +188 -0
  33. data/lib/stackone_hris_client/api/locations_api.rb +188 -0
  34. data/lib/stackone_hris_client/api_client.rb +5 -5
  35. data/lib/stackone_hris_client/api_error.rb +4 -4
  36. data/lib/stackone_hris_client/configuration.rb +4 -4
  37. data/lib/stackone_hris_client/models/account.rb +7 -7
  38. data/lib/stackone_hris_client/models/companies_paginated.rb +247 -0
  39. data/lib/stackone_hris_client/models/company.rb +235 -0
  40. data/lib/stackone_hris_client/models/company_result.rb +231 -0
  41. data/lib/stackone_hris_client/models/connect_session.rb +7 -7
  42. data/lib/stackone_hris_client/models/connect_session_authenticate.rb +7 -7
  43. data/lib/stackone_hris_client/models/connect_session_create.rb +7 -7
  44. data/lib/stackone_hris_client/models/connect_session_token.rb +7 -7
  45. data/lib/stackone_hris_client/models/employee.rb +181 -60
  46. data/lib/stackone_hris_client/models/employee_result.rb +7 -7
  47. data/lib/stackone_hris_client/models/employees_paginated.rb +7 -7
  48. data/lib/stackone_hris_client/models/employment.rb +294 -0
  49. data/lib/stackone_hris_client/models/employment_result.rb +231 -0
  50. data/lib/stackone_hris_client/models/employments_paginated.rb +247 -0
  51. data/lib/stackone_hris_client/models/location.rb +312 -0
  52. data/lib/stackone_hris_client/models/location_result.rb +231 -0
  53. data/lib/stackone_hris_client/models/locations_paginated.rb +247 -0
  54. data/lib/stackone_hris_client/version.rb +5 -5
  55. data/lib/stackone_hris_client.rb +17 -5
  56. data/spec/api/accounts_api_spec.rb +3 -3
  57. data/spec/api/companies_api_spec.rb +70 -0
  58. data/spec/api/connect_sessions_api_spec.rb +3 -3
  59. data/spec/api/employees_api_spec.rb +3 -3
  60. data/spec/api/employments_api_spec.rb +70 -0
  61. data/spec/api/locations_api_spec.rb +70 -0
  62. data/spec/api_client_spec.rb +32 -32
  63. data/spec/configuration_spec.rb +6 -6
  64. data/spec/models/account_spec.rb +4 -4
  65. data/spec/models/companies_paginated_spec.rb +46 -0
  66. data/spec/models/company_result_spec.rb +40 -0
  67. data/spec/models/company_spec.rb +46 -0
  68. data/spec/models/connect_session_authenticate_spec.rb +4 -4
  69. data/spec/models/connect_session_create_spec.rb +4 -4
  70. data/spec/models/connect_session_spec.rb +4 -4
  71. data/spec/models/connect_session_token_spec.rb +4 -4
  72. data/spec/models/employee_result_spec.rb +4 -4
  73. data/spec/models/employee_spec.rb +4 -4
  74. data/spec/models/employees_paginated_spec.rb +4 -4
  75. data/spec/models/employment_result_spec.rb +40 -0
  76. data/spec/models/employment_spec.rb +82 -0
  77. data/spec/models/employments_paginated_spec.rb +46 -0
  78. data/spec/models/location_result_spec.rb +40 -0
  79. data/spec/models/location_spec.rb +94 -0
  80. data/spec/models/locations_paginated_spec.rb +46 -0
  81. data/spec/spec_helper.rb +3 -3
  82. data/stackone_hris_client.gemspec +5 -5
  83. metadata +51 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1e3fcb0d1dde740779af40d971309c57e698435f3cf1204cfa64a70c5aab1003
4
- data.tar.gz: 3357889e461742ed18574323cc7525054afc452a394e8f0d603495818dc6f1de
3
+ metadata.gz: 55b88dd425f0a32c6b26daaf93d226c318b77eb629d592622b2bb6d26850ae7d
4
+ data.tar.gz: 723d2deabbc5a0a6aa99ef35d36c4c36bcaabd8a4e1c1e70623220e16ab32e91
5
5
  SHA512:
6
- metadata.gz: aa13bc5f05a3f1ea7446c02e51c39752e2f19107a3251d8de90274ee1c7d20dbab7e297138822339ad19e79f52f74d966ca0e9b03c2dd949e48a122951cc4712
7
- data.tar.gz: de6d30d22dd7b25fd5b81de49e4cd6a391e323b95d3950126df96652e58e29c39f19d451fdddaf992fa54abe227f948f87961d49a54e8cdf5d3431c6e5929a01
6
+ metadata.gz: 43f98f045b9fe50181c28572d60027b648cc8b52bd377cd3caffe8ec167a9142cfadc6a0377494a9d342c900fcd8fd03e33ff5f328bec7287d4c06e188f9d348
7
+ data.tar.gz: 9049523c053ef62d74be3afe16535bfd6f9fe00d9a632e1bc2e52b842a3674e3e82206eb8a4150b84c85d737e3771fa6005200922afb725318d41616bfba5b27
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- stackone_hris_client (1.1.0)
4
+ stackone_hris_client (1.2.1)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -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.27.0)
55
+ rubocop-ast (1.28.0)
56
56
  parser (>= 3.2.1.0)
57
57
  ruby-progressbar (1.13.0)
58
58
  typhoeus (1.4.0)
data/README.md CHANGED
@@ -1,13 +1,13 @@
1
1
  # stackone_hris_client
2
2
 
3
- StackOneHrisClient - the Ruby gem for the StackOne Unified API
3
+ StackOneHRIS - the Ruby gem for the StackOne Unified API - HRIS
4
4
 
5
- The documentation for the StackOne Unified API
5
+ The documentation for the StackOne Unified API - HRIS
6
6
 
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
- - API version: 1.0
10
- - Package version: 1.1.0
9
+ - API version: 1.0.0
10
+ - Package version: 1.2.1
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.1.0.gem
26
+ gem install ./stackone_hris_client-1.2.1.gem
27
27
  ```
28
28
 
29
- (for development, run `gem install --dev ./stackone_hris_client-1.1.0.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./stackone_hris_client-1.2.1.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.1.0'
35
+ gem 'stackone_hris_client', '~> 1.2.1'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -57,12 +57,12 @@ Please follow the [installation](#installation) procedure and then run the follo
57
57
  require 'stackone_hris_client'
58
58
 
59
59
  # Setup authorization
60
- StackOneHrisClient.configure do |config|
60
+ StackOneHRIS.configure do |config|
61
61
  # Configure HTTP basic authorization: basic
62
62
  config.api_key_token = 'YOUR API KEY'
63
63
  end
64
64
 
65
- api_instance = StackOneHrisClient::EmployeesApi.new
65
+ api_instance = StackOneHRIS::EmployeesApi.new
66
66
  id = 'id_example' # String |
67
67
  x_account_id = 'x_account_id_example' # String | The account identifier
68
68
  opts = {
@@ -77,7 +77,7 @@ begin
77
77
  #
78
78
  result = api_instance.employees_get(id, x_account_id, opts)
79
79
  p result
80
- rescue StackOneHrisClient::ApiError => e
80
+ rescue StackOneHRIS::ApiError => e
81
81
  puts "Exception when calling EmployeesApi->employees_get: #{e}"
82
82
  end
83
83
 
@@ -89,24 +89,40 @@ All URIs are relative to *http://localhost*
89
89
 
90
90
  Class | Method | HTTP request | Description
91
91
  ------------ | ------------- | ------------- | -------------
92
- *StackOneHrisClient::AccountsApi* | [**accounts_get**](docs/AccountsApi.md#accounts_get) | **GET** /accounts/{id} |
93
- *StackOneHrisClient::AccountsApi* | [**accounts_list**](docs/AccountsApi.md#accounts_list) | **GET** /accounts |
94
- *StackOneHrisClient::ConnectSessionsApi* | [**connect_sessions_authenticate**](docs/ConnectSessionsApi.md#connect_sessions_authenticate) | **POST** /connect_sessions/authenticate |
95
- *StackOneHrisClient::ConnectSessionsApi* | [**connect_sessions_create**](docs/ConnectSessionsApi.md#connect_sessions_create) | **POST** /connect_sessions |
96
- *StackOneHrisClient::EmployeesApi* | [**employees_get**](docs/EmployeesApi.md#employees_get) | **GET** /unified/hris/employees/{id} |
97
- *StackOneHrisClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /unified/hris/employees |
92
+ *StackOneHRIS::AccountsApi* | [**accounts_delete**](docs/AccountsApi.md#accounts_delete) | **DELETE** /accounts/{id} |
93
+ *StackOneHRIS::AccountsApi* | [**accounts_get**](docs/AccountsApi.md#accounts_get) | **GET** /accounts/{id} |
94
+ *StackOneHRIS::AccountsApi* | [**accounts_list**](docs/AccountsApi.md#accounts_list) | **GET** /accounts |
95
+ *StackOneHRIS::CompaniesApi* | [**companies_get**](docs/CompaniesApi.md#companies_get) | **GET** /unified/hris/companies/{id} |
96
+ *StackOneHRIS::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /unified/hris/companies |
97
+ *StackOneHRIS::ConnectSessionsApi* | [**connect_sessions_authenticate**](docs/ConnectSessionsApi.md#connect_sessions_authenticate) | **POST** /connect_sessions/authenticate |
98
+ *StackOneHRIS::ConnectSessionsApi* | [**connect_sessions_create**](docs/ConnectSessionsApi.md#connect_sessions_create) | **POST** /connect_sessions |
99
+ *StackOneHRIS::EmployeesApi* | [**employees_get**](docs/EmployeesApi.md#employees_get) | **GET** /unified/hris/employees/{id} |
100
+ *StackOneHRIS::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /unified/hris/employees |
101
+ *StackOneHRIS::EmploymentsApi* | [**employments_get**](docs/EmploymentsApi.md#employments_get) | **GET** /unified/hris/employments/{id} |
102
+ *StackOneHRIS::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /unified/hris/employments |
103
+ *StackOneHRIS::LocationsApi* | [**hris_locations_get**](docs/LocationsApi.md#hris_locations_get) | **GET** /unified/hris/locations/{id} |
104
+ *StackOneHRIS::LocationsApi* | [**hris_locations_list**](docs/LocationsApi.md#hris_locations_list) | **GET** /unified/hris/locations |
98
105
 
99
106
 
100
107
  ## Documentation for Models
101
108
 
102
- - [StackOneHrisClient::Account](docs/Account.md)
103
- - [StackOneHrisClient::ConnectSession](docs/ConnectSession.md)
104
- - [StackOneHrisClient::ConnectSessionAuthenticate](docs/ConnectSessionAuthenticate.md)
105
- - [StackOneHrisClient::ConnectSessionCreate](docs/ConnectSessionCreate.md)
106
- - [StackOneHrisClient::ConnectSessionToken](docs/ConnectSessionToken.md)
107
- - [StackOneHrisClient::Employee](docs/Employee.md)
108
- - [StackOneHrisClient::EmployeeResult](docs/EmployeeResult.md)
109
- - [StackOneHrisClient::EmployeesPaginated](docs/EmployeesPaginated.md)
109
+ - [StackOneHRIS::Account](docs/Account.md)
110
+ - [StackOneHRIS::CompaniesPaginated](docs/CompaniesPaginated.md)
111
+ - [StackOneHRIS::Company](docs/Company.md)
112
+ - [StackOneHRIS::CompanyResult](docs/CompanyResult.md)
113
+ - [StackOneHRIS::ConnectSession](docs/ConnectSession.md)
114
+ - [StackOneHRIS::ConnectSessionAuthenticate](docs/ConnectSessionAuthenticate.md)
115
+ - [StackOneHRIS::ConnectSessionCreate](docs/ConnectSessionCreate.md)
116
+ - [StackOneHRIS::ConnectSessionToken](docs/ConnectSessionToken.md)
117
+ - [StackOneHRIS::Employee](docs/Employee.md)
118
+ - [StackOneHRIS::EmployeeResult](docs/EmployeeResult.md)
119
+ - [StackOneHRIS::EmployeesPaginated](docs/EmployeesPaginated.md)
120
+ - [StackOneHRIS::Employment](docs/Employment.md)
121
+ - [StackOneHRIS::EmploymentResult](docs/EmploymentResult.md)
122
+ - [StackOneHRIS::EmploymentsPaginated](docs/EmploymentsPaginated.md)
123
+ - [StackOneHRIS::Location](docs/Location.md)
124
+ - [StackOneHRIS::LocationResult](docs/LocationResult.md)
125
+ - [StackOneHRIS::LocationsPaginated](docs/LocationsPaginated.md)
110
126
 
111
127
 
112
128
  ## Documentation for Authorization
data/docs/Account.md CHANGED
@@ -1,4 +1,4 @@
1
- # StackOneHrisClient::Account
1
+ # StackOneHRIS::Account
2
2
 
3
3
  ## Properties
4
4
 
@@ -18,7 +18,7 @@
18
18
  ```ruby
19
19
  require 'stackone_hris_client'
20
20
 
21
- instance = StackOneHrisClient::Account.new(
21
+ instance = StackOneHRIS::Account.new(
22
22
  id: null,
23
23
  provider: null,
24
24
  origin_owner_id: null,
data/docs/AccountsApi.md CHANGED
@@ -1,13 +1,82 @@
1
- # StackOneHrisClient::AccountsApi
1
+ # StackOneHRIS::AccountsApi
2
2
 
3
3
  All URIs are relative to *http://localhost*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**accounts_delete**](AccountsApi.md#accounts_delete) | **DELETE** /accounts/{id} | |
7
8
  | [**accounts_get**](AccountsApi.md#accounts_get) | **GET** /accounts/{id} | |
8
9
  | [**accounts_list**](AccountsApi.md#accounts_list) | **GET** /accounts | |
9
10
 
10
11
 
12
+ ## accounts_delete
13
+
14
+ > <Account> accounts_delete(id)
15
+
16
+
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'stackone_hris_client'
23
+ # setup authorization
24
+ StackOneHRIS.configure do |config|
25
+ # Configure HTTP basic authorization: basic
26
+ config.username = 'YOUR USERNAME'
27
+ config.password = 'YOUR PASSWORD'
28
+ end
29
+
30
+ api_instance = StackOneHRIS::AccountsApi.new
31
+ id = 'id_example' # String |
32
+
33
+ begin
34
+ #
35
+ result = api_instance.accounts_delete(id)
36
+ p result
37
+ rescue StackOneHRIS::ApiError => e
38
+ puts "Error when calling AccountsApi->accounts_delete: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the accounts_delete_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<Account>, Integer, Hash)> accounts_delete_with_http_info(id)
47
+
48
+ ```ruby
49
+ begin
50
+ #
51
+ data, status_code, headers = api_instance.accounts_delete_with_http_info(id)
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <Account>
55
+ rescue StackOneHRIS::ApiError => e
56
+ puts "Error when calling AccountsApi->accounts_delete_with_http_info: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ | Name | Type | Description | Notes |
63
+ | ---- | ---- | ----------- | ----- |
64
+ | **id** | **String** | | |
65
+
66
+ ### Return type
67
+
68
+ [**Account**](Account.md)
69
+
70
+ ### Authorization
71
+
72
+ [basic](../README.md#basic)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: Not defined
77
+ - **Accept**: application/json
78
+
79
+
11
80
  ## accounts_get
12
81
 
13
82
  > <Account> accounts_get(id)
@@ -20,19 +89,20 @@ All URIs are relative to *http://localhost*
20
89
  require 'time'
21
90
  require 'stackone_hris_client'
22
91
  # setup authorization
23
- StackOneHrisClient.configure do |config|
92
+ StackOneHRIS.configure do |config|
24
93
  # Configure HTTP basic authorization: basic
25
- config.api_key_token = 'YOUR API KEY'
94
+ config.username = 'YOUR USERNAME'
95
+ config.password = 'YOUR PASSWORD'
26
96
  end
27
97
 
28
- api_instance = StackOneHrisClient::AccountsApi.new
98
+ api_instance = StackOneHRIS::AccountsApi.new
29
99
  id = 'id_example' # String |
30
100
 
31
101
  begin
32
102
  #
33
103
  result = api_instance.accounts_get(id)
34
104
  p result
35
- rescue StackOneHrisClient::ApiError => e
105
+ rescue StackOneHRIS::ApiError => e
36
106
  puts "Error when calling AccountsApi->accounts_get: #{e}"
37
107
  end
38
108
  ```
@@ -50,7 +120,7 @@ begin
50
120
  p status_code # => 2xx
51
121
  p headers # => { ... }
52
122
  p data # => <Account>
53
- rescue StackOneHrisClient::ApiError => e
123
+ rescue StackOneHRIS::ApiError => e
54
124
  puts "Error when calling AccountsApi->accounts_get_with_http_info: #{e}"
55
125
  end
56
126
  ```
@@ -87,12 +157,13 @@ end
87
157
  require 'time'
88
158
  require 'stackone_hris_client'
89
159
  # setup authorization
90
- StackOneHrisClient.configure do |config|
160
+ StackOneHRIS.configure do |config|
91
161
  # Configure HTTP basic authorization: basic
92
- config.api_key_token = 'YOUR API KEY'
162
+ config.username = 'YOUR USERNAME'
163
+ config.password = 'YOUR PASSWORD'
93
164
  end
94
165
 
95
- api_instance = StackOneHrisClient::AccountsApi.new
166
+ api_instance = StackOneHRIS::AccountsApi.new
96
167
  opts = {
97
168
  provider: 'provider_example', # String | The provider of the results to fetch
98
169
  origin_owner_id: 'origin_owner_id_example' # String | The origin owner identifier of the results to fetch
@@ -102,7 +173,7 @@ begin
102
173
  #
103
174
  result = api_instance.accounts_list(opts)
104
175
  p result
105
- rescue StackOneHrisClient::ApiError => e
176
+ rescue StackOneHRIS::ApiError => e
106
177
  puts "Error when calling AccountsApi->accounts_list: #{e}"
107
178
  end
108
179
  ```
@@ -120,7 +191,7 @@ begin
120
191
  p status_code # => 2xx
121
192
  p headers # => { ... }
122
193
  p data # => <Array<Account>>
123
- rescue StackOneHrisClient::ApiError => e
194
+ rescue StackOneHRIS::ApiError => e
124
195
  puts "Error when calling AccountsApi->accounts_list_with_http_info: #{e}"
125
196
  end
126
197
  ```
@@ -0,0 +1,175 @@
1
+ # StackOneHRIS::CompaniesApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**companies_get**](CompaniesApi.md#companies_get) | **GET** /unified/hris/companies/{id} | |
8
+ | [**companies_list**](CompaniesApi.md#companies_list) | **GET** /unified/hris/companies | |
9
+
10
+
11
+ ## companies_get
12
+
13
+ > <CompanyResult> companies_get(id, x_account_id, opts)
14
+
15
+
16
+
17
+ ### Examples
18
+
19
+ ```ruby
20
+ require 'time'
21
+ require 'stackone_hris_client'
22
+ # setup authorization
23
+ StackOneHRIS.configure do |config|
24
+ # Configure HTTP basic authorization: basic
25
+ config.username = 'YOUR USERNAME'
26
+ config.password = 'YOUR PASSWORD'
27
+ end
28
+
29
+ api_instance = StackOneHRIS::CompaniesApi.new
30
+ id = 'id_example' # String |
31
+ x_account_id = 'x_account_id_example' # String | The account identifier
32
+ opts = {
33
+ page: 'page_example', # String | The page number of the results to fetch
34
+ page_size: 'page_size_example', # String | The number of results per page
35
+ 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
39
+ }
40
+
41
+ begin
42
+ #
43
+ result = api_instance.companies_get(id, x_account_id, opts)
44
+ p result
45
+ rescue StackOneHRIS::ApiError => e
46
+ puts "Error when calling CompaniesApi->companies_get: #{e}"
47
+ end
48
+ ```
49
+
50
+ #### Using the companies_get_with_http_info variant
51
+
52
+ This returns an Array which contains the response data, status code and headers.
53
+
54
+ > <Array(<CompanyResult>, Integer, Hash)> companies_get_with_http_info(id, x_account_id, opts)
55
+
56
+ ```ruby
57
+ begin
58
+ #
59
+ data, status_code, headers = api_instance.companies_get_with_http_info(id, x_account_id, opts)
60
+ p status_code # => 2xx
61
+ p headers # => { ... }
62
+ p data # => <CompanyResult>
63
+ rescue StackOneHRIS::ApiError => e
64
+ puts "Error when calling CompaniesApi->companies_get_with_http_info: #{e}"
65
+ end
66
+ ```
67
+
68
+ ### Parameters
69
+
70
+ | Name | Type | Description | Notes |
71
+ | ---- | ---- | ----------- | ----- |
72
+ | **id** | **String** | | |
73
+ | **x_account_id** | **String** | The account identifier | |
74
+ | **page** | **String** | The page number of the results to fetch | [optional] |
75
+ | **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
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] |
79
+ | **sync_token** | **String** | The sync token to select the only updated results | [optional] |
80
+
81
+ ### Return type
82
+
83
+ [**CompanyResult**](CompanyResult.md)
84
+
85
+ ### Authorization
86
+
87
+ [basic](../README.md#basic)
88
+
89
+ ### HTTP request headers
90
+
91
+ - **Content-Type**: Not defined
92
+ - **Accept**: application/json
93
+
94
+
95
+ ## companies_list
96
+
97
+ > <CompaniesPaginated> companies_list(x_account_id, opts)
98
+
99
+
100
+
101
+ ### Examples
102
+
103
+ ```ruby
104
+ require 'time'
105
+ require 'stackone_hris_client'
106
+ # setup authorization
107
+ StackOneHRIS.configure do |config|
108
+ # Configure HTTP basic authorization: basic
109
+ config.username = 'YOUR USERNAME'
110
+ config.password = 'YOUR PASSWORD'
111
+ end
112
+
113
+ api_instance = StackOneHRIS::CompaniesApi.new
114
+ x_account_id = 'x_account_id_example' # String | The account identifier
115
+ opts = {
116
+ page: 'page_example', # String | The page number of the results to fetch
117
+ page_size: 'page_size_example', # String | The number of results per page
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
122
+ }
123
+
124
+ begin
125
+ #
126
+ result = api_instance.companies_list(x_account_id, opts)
127
+ p result
128
+ rescue StackOneHRIS::ApiError => e
129
+ puts "Error when calling CompaniesApi->companies_list: #{e}"
130
+ end
131
+ ```
132
+
133
+ #### Using the companies_list_with_http_info variant
134
+
135
+ This returns an Array which contains the response data, status code and headers.
136
+
137
+ > <Array(<CompaniesPaginated>, Integer, Hash)> companies_list_with_http_info(x_account_id, opts)
138
+
139
+ ```ruby
140
+ begin
141
+ #
142
+ data, status_code, headers = api_instance.companies_list_with_http_info(x_account_id, opts)
143
+ p status_code # => 2xx
144
+ p headers # => { ... }
145
+ p data # => <CompaniesPaginated>
146
+ rescue StackOneHRIS::ApiError => e
147
+ puts "Error when calling CompaniesApi->companies_list_with_http_info: #{e}"
148
+ end
149
+ ```
150
+
151
+ ### Parameters
152
+
153
+ | Name | Type | Description | Notes |
154
+ | ---- | ---- | ----------- | ----- |
155
+ | **x_account_id** | **String** | The account identifier | |
156
+ | **page** | **String** | The page number of the results to fetch | [optional] |
157
+ | **page_size** | **String** | The number of results per page | [optional][default to &#39;25&#39;] |
158
+ | **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] |
161
+ | **sync_token** | **String** | The sync token to select the only updated results | [optional] |
162
+
163
+ ### Return type
164
+
165
+ [**CompaniesPaginated**](CompaniesPaginated.md)
166
+
167
+ ### Authorization
168
+
169
+ [basic](../README.md#basic)
170
+
171
+ ### HTTP request headers
172
+
173
+ - **Content-Type**: Not defined
174
+ - **Accept**: application/json
175
+
@@ -0,0 +1,22 @@
1
+ # StackOneHRIS::CompaniesPaginated
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **next_page** | **String** | | |
8
+ | **data** | [**Array&lt;Company&gt;**](Company.md) | | |
9
+ | **raw** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'stackone_hris_client'
15
+
16
+ instance = StackOneHRIS::CompaniesPaginated.new(
17
+ next_page: null,
18
+ data: null,
19
+ raw: null
20
+ )
21
+ ```
22
+
data/docs/Company.md ADDED
@@ -0,0 +1,22 @@
1
+ # StackOneHRIS::Company
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **name** | **String** | | [optional] |
9
+ | **display_name** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'stackone_hris_client'
15
+
16
+ instance = StackOneHRIS::Company.new(
17
+ id: null,
18
+ name: null,
19
+ display_name: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::CompanyResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Company**](Company.md) | | |
8
+ | **raw** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::CompanyResult.new(
16
+ data: null,
17
+ raw: null
18
+ )
19
+ ```
20
+
@@ -1,4 +1,4 @@
1
- # StackOneHrisClient::ConnectSession
1
+ # StackOneHRIS::ConnectSession
2
2
 
3
3
  ## Properties
4
4
 
@@ -19,7 +19,7 @@
19
19
  ```ruby
20
20
  require 'stackone_hris_client'
21
21
 
22
- instance = StackOneHrisClient::ConnectSession.new(
22
+ instance = StackOneHRIS::ConnectSession.new(
23
23
  id: null,
24
24
  organization_id: null,
25
25
  project_id: null,
@@ -1,4 +1,4 @@
1
- # StackOneHrisClient::ConnectSessionAuthenticate
1
+ # StackOneHRIS::ConnectSessionAuthenticate
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,7 +11,7 @@
11
11
  ```ruby
12
12
  require 'stackone_hris_client'
13
13
 
14
- instance = StackOneHrisClient::ConnectSessionAuthenticate.new(
14
+ instance = StackOneHRIS::ConnectSessionAuthenticate.new(
15
15
  token: null
16
16
  )
17
17
  ```
@@ -1,4 +1,4 @@
1
- # StackOneHrisClient::ConnectSessionCreate
1
+ # StackOneHRIS::ConnectSessionCreate
2
2
 
3
3
  ## Properties
4
4
 
@@ -16,7 +16,7 @@
16
16
  ```ruby
17
17
  require 'stackone_hris_client'
18
18
 
19
- instance = StackOneHrisClient::ConnectSessionCreate.new(
19
+ instance = StackOneHRIS::ConnectSessionCreate.new(
20
20
  categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;],
21
21
  provider: null,
22
22
  origin_owner_id: null,
@@ -1,4 +1,4 @@
1
- # StackOneHrisClient::ConnectSessionToken
1
+ # StackOneHRIS::ConnectSessionToken
2
2
 
3
3
  ## Properties
4
4
 
@@ -20,7 +20,7 @@
20
20
  ```ruby
21
21
  require 'stackone_hris_client'
22
22
 
23
- instance = StackOneHrisClient::ConnectSessionToken.new(
23
+ instance = StackOneHRIS::ConnectSessionToken.new(
24
24
  id: null,
25
25
  organization_id: null,
26
26
  project_id: null,