stackone_hris_client 1.0.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (79) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +42 -15
  4. data/docs/Account.md +32 -0
  5. data/docs/AccountsApi.md +218 -0
  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 +34 -0
  11. data/docs/ConnectSessionAuthenticate.md +18 -0
  12. data/docs/ConnectSessionCreate.md +28 -0
  13. data/docs/ConnectSessionToken.md +36 -0
  14. data/docs/ConnectSessionsApi.md +145 -0
  15. data/docs/Employee.md +36 -12
  16. data/docs/EmployeeResult.md +2 -2
  17. data/docs/EmployeesApi.md +19 -13
  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 +205 -0
  29. data/lib/stackone_hris_client/api/companies_api.rb +188 -0
  30. data/lib/stackone_hris_client/api/connect_sessions_api.rb +154 -0
  31. data/lib/stackone_hris_client/api/employees_api.rb +10 -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 +13 -12
  37. data/lib/stackone_hris_client/models/account.rb +322 -0
  38. data/lib/stackone_hris_client/models/companies_paginated.rb +249 -0
  39. data/lib/stackone_hris_client/models/company.rb +237 -0
  40. data/lib/stackone_hris_client/models/company_result.rb +233 -0
  41. data/lib/stackone_hris_client/models/connect_session.rb +350 -0
  42. data/lib/stackone_hris_client/models/connect_session_authenticate.rb +225 -0
  43. data/lib/stackone_hris_client/models/connect_session_create.rb +304 -0
  44. data/lib/stackone_hris_client/models/connect_session_token.rb +364 -0
  45. data/lib/stackone_hris_client/models/employee.rb +145 -60
  46. data/lib/stackone_hris_client/models/employee_result.rb +9 -7
  47. data/lib/stackone_hris_client/models/employees_paginated.rb +9 -7
  48. data/lib/stackone_hris_client/models/employment.rb +296 -0
  49. data/lib/stackone_hris_client/models/employment_result.rb +233 -0
  50. data/lib/stackone_hris_client/models/employments_paginated.rb +249 -0
  51. data/lib/stackone_hris_client/models/location.rb +314 -0
  52. data/lib/stackone_hris_client/models/location_result.rb +233 -0
  53. data/lib/stackone_hris_client/models/locations_paginated.rb +249 -0
  54. data/lib/stackone_hris_client/version.rb +5 -5
  55. data/lib/stackone_hris_client.rb +23 -4
  56. data/spec/api/accounts_api_spec.rb +58 -0
  57. data/spec/api/companies_api_spec.rb +70 -0
  58. data/spec/api/connect_sessions_api_spec.rb +57 -0
  59. data/spec/api/employments_api_spec.rb +70 -0
  60. data/spec/api/locations_api_spec.rb +70 -0
  61. data/spec/api_client_spec.rb +32 -32
  62. data/spec/configuration_spec.rb +6 -6
  63. data/spec/models/account_spec.rb +76 -0
  64. data/spec/models/companies_paginated_spec.rb +46 -0
  65. data/spec/models/company_result_spec.rb +40 -0
  66. data/spec/models/company_spec.rb +46 -0
  67. data/spec/models/connect_session_authenticate_spec.rb +34 -0
  68. data/spec/models/connect_session_create_spec.rb +68 -0
  69. data/spec/models/connect_session_spec.rb +86 -0
  70. data/spec/models/connect_session_token_spec.rb +92 -0
  71. data/spec/models/employment_result_spec.rb +40 -0
  72. data/spec/models/employment_spec.rb +82 -0
  73. data/spec/models/employments_paginated_spec.rb +46 -0
  74. data/spec/models/location_result_spec.rb +40 -0
  75. data/spec/models/location_spec.rb +94 -0
  76. data/spec/models/locations_paginated_spec.rb +46 -0
  77. data/spec/spec_helper.rb +3 -3
  78. data/stackone_hris_client.gemspec +5 -5
  79. metadata +79 -3
data/docs/Location.md ADDED
@@ -0,0 +1,38 @@
1
+ # StackOneHRIS::Location
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **employee_id** | **String** | | |
9
+ | **name** | **String** | | [optional] |
10
+ | **phone_number** | **String** | | [optional] |
11
+ | **street_1** | **String** | | [optional] |
12
+ | **street_2** | **String** | | [optional] |
13
+ | **city** | **String** | | [optional] |
14
+ | **state** | **String** | | [optional] |
15
+ | **zip_code** | **String** | | [optional] |
16
+ | **country** | **String** | | [optional] |
17
+ | **location_type** | **String** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'stackone_hris_client'
23
+
24
+ instance = StackOneHRIS::Location.new(
25
+ id: null,
26
+ employee_id: null,
27
+ name: null,
28
+ phone_number: null,
29
+ street_1: null,
30
+ street_2: null,
31
+ city: null,
32
+ state: null,
33
+ zip_code: null,
34
+ country: null,
35
+ location_type: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::LocationResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Location**](Location.md) | | |
8
+ | **raw** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::LocationResult.new(
16
+ data: null,
17
+ raw: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,175 @@
1
+ # StackOneHRIS::LocationsApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**hris_locations_get**](LocationsApi.md#hris_locations_get) | **GET** /unified/hris/locations/{id} | |
8
+ | [**hris_locations_list**](LocationsApi.md#hris_locations_list) | **GET** /unified/hris/locations | |
9
+
10
+
11
+ ## hris_locations_get
12
+
13
+ > <LocationResult> hris_locations_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::LocationsApi.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.hris_locations_get(id, x_account_id, opts)
44
+ p result
45
+ rescue StackOneHRIS::ApiError => e
46
+ puts "Error when calling LocationsApi->hris_locations_get: #{e}"
47
+ end
48
+ ```
49
+
50
+ #### Using the hris_locations_get_with_http_info variant
51
+
52
+ This returns an Array which contains the response data, status code and headers.
53
+
54
+ > <Array(<LocationResult>, Integer, Hash)> hris_locations_get_with_http_info(id, x_account_id, opts)
55
+
56
+ ```ruby
57
+ begin
58
+ #
59
+ data, status_code, headers = api_instance.hris_locations_get_with_http_info(id, x_account_id, opts)
60
+ p status_code # => 2xx
61
+ p headers # => { ... }
62
+ p data # => <LocationResult>
63
+ rescue StackOneHRIS::ApiError => e
64
+ puts "Error when calling LocationsApi->hris_locations_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
+ [**LocationResult**](LocationResult.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
+ ## hris_locations_list
96
+
97
+ > <LocationsPaginated> hris_locations_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::LocationsApi.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.hris_locations_list(x_account_id, opts)
127
+ p result
128
+ rescue StackOneHRIS::ApiError => e
129
+ puts "Error when calling LocationsApi->hris_locations_list: #{e}"
130
+ end
131
+ ```
132
+
133
+ #### Using the hris_locations_list_with_http_info variant
134
+
135
+ This returns an Array which contains the response data, status code and headers.
136
+
137
+ > <Array(<LocationsPaginated>, Integer, Hash)> hris_locations_list_with_http_info(x_account_id, opts)
138
+
139
+ ```ruby
140
+ begin
141
+ #
142
+ data, status_code, headers = api_instance.hris_locations_list_with_http_info(x_account_id, opts)
143
+ p status_code # => 2xx
144
+ p headers # => { ... }
145
+ p data # => <LocationsPaginated>
146
+ rescue StackOneHRIS::ApiError => e
147
+ puts "Error when calling LocationsApi->hris_locations_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
+ [**LocationsPaginated**](LocationsPaginated.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::LocationsPaginated
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **next_page** | **String** | | |
8
+ | **data** | [**Array&lt;Location&gt;**](Location.md) | | |
9
+ | **raw** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'stackone_hris_client'
15
+
16
+ instance = StackOneHRIS::LocationsPaginated.new(
17
+ next_page: null,
18
+ data: null,
19
+ raw: null
20
+ )
21
+ ```
22
+
data/gem-config.yml CHANGED
@@ -1,14 +1,14 @@
1
1
  generatorName: ruby
2
- inputSpec: https://api.eu1.stackone.com/documentation-yaml
2
+ inputSpec: https://api.eu1.stackone.com/documentation-hris-yaml
3
3
  additionalProperties:
4
- moduleName: "StackOneHrisClient"
4
+ moduleName: "StackOneHRIS"
5
5
  gemAuthor: "StackOne"
6
- gemAuthorEmail: "developer-support@stackone.comm"
6
+ gemAuthorEmail: "developer-support@stackone.com"
7
7
  gemDescription: "StackOne Unified API client for enhanced integrations with HRIS systems"
8
8
  gemHomepage: "https://stackone.com"
9
9
  gemLicense: "MIT"
10
10
  gemName: "stackone_hris_client"
11
11
  gemRequiredRubyVersion: ">= 2.7"
12
12
  gemSummary: "StackOne HRIS client gem"
13
- gemVersion: "1.0.0"
13
+ gemVersion: "1.2.0"
14
14
  library: "typhoeus"
@@ -0,0 +1,205 @@
1
+ =begin
2
+ #StackOne Unified API - HRIS
3
+
4
+ #The documentation for the StackOne Unified API - HRIS
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.4.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module StackOneHRIS
16
+ class AccountsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ #
23
+ # @param id [String]
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [Account]
26
+ def accounts_delete(id, opts = {})
27
+ data, _status_code, _headers = accounts_delete_with_http_info(id, opts)
28
+ data
29
+ end
30
+
31
+ #
32
+ # @param id [String]
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(Account, Integer, Hash)>] Account data, response status code and response headers
35
+ def accounts_delete_with_http_info(id, opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: AccountsApi.accounts_delete ...'
38
+ end
39
+ # verify the required parameter 'id' is set
40
+ if @api_client.config.client_side_validation && id.nil?
41
+ fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.accounts_delete"
42
+ end
43
+ # resource path
44
+ local_var_path = '/accounts/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
45
+
46
+ # query parameters
47
+ query_params = opts[:query_params] || {}
48
+
49
+ # header parameters
50
+ header_params = opts[:header_params] || {}
51
+ # HTTP header 'Accept' (if needed)
52
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
53
+
54
+ # form parameters
55
+ form_params = opts[:form_params] || {}
56
+
57
+ # http body (model)
58
+ post_body = opts[:debug_body]
59
+
60
+ # return_type
61
+ return_type = opts[:debug_return_type] || 'Account'
62
+
63
+ # auth_names
64
+ auth_names = opts[:debug_auth_names] || ['basic']
65
+
66
+ new_options = opts.merge(
67
+ :operation => :"AccountsApi.accounts_delete",
68
+ :header_params => header_params,
69
+ :query_params => query_params,
70
+ :form_params => form_params,
71
+ :body => post_body,
72
+ :auth_names => auth_names,
73
+ :return_type => return_type
74
+ )
75
+
76
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
77
+ if @api_client.config.debugging
78
+ @api_client.config.logger.debug "API called: AccountsApi#accounts_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
+ end
80
+ return data, status_code, headers
81
+ end
82
+
83
+ #
84
+ # @param id [String]
85
+ # @param [Hash] opts the optional parameters
86
+ # @return [Account]
87
+ def accounts_get(id, opts = {})
88
+ data, _status_code, _headers = accounts_get_with_http_info(id, opts)
89
+ data
90
+ end
91
+
92
+ #
93
+ # @param id [String]
94
+ # @param [Hash] opts the optional parameters
95
+ # @return [Array<(Account, Integer, Hash)>] Account data, response status code and response headers
96
+ def accounts_get_with_http_info(id, opts = {})
97
+ if @api_client.config.debugging
98
+ @api_client.config.logger.debug 'Calling API: AccountsApi.accounts_get ...'
99
+ end
100
+ # verify the required parameter 'id' is set
101
+ if @api_client.config.client_side_validation && id.nil?
102
+ fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.accounts_get"
103
+ end
104
+ # resource path
105
+ local_var_path = '/accounts/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
106
+
107
+ # query parameters
108
+ query_params = opts[:query_params] || {}
109
+
110
+ # header parameters
111
+ header_params = opts[:header_params] || {}
112
+ # HTTP header 'Accept' (if needed)
113
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
114
+
115
+ # form parameters
116
+ form_params = opts[:form_params] || {}
117
+
118
+ # http body (model)
119
+ post_body = opts[:debug_body]
120
+
121
+ # return_type
122
+ return_type = opts[:debug_return_type] || 'Account'
123
+
124
+ # auth_names
125
+ auth_names = opts[:debug_auth_names] || ['basic']
126
+
127
+ new_options = opts.merge(
128
+ :operation => :"AccountsApi.accounts_get",
129
+ :header_params => header_params,
130
+ :query_params => query_params,
131
+ :form_params => form_params,
132
+ :body => post_body,
133
+ :auth_names => auth_names,
134
+ :return_type => return_type
135
+ )
136
+
137
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
138
+ if @api_client.config.debugging
139
+ @api_client.config.logger.debug "API called: AccountsApi#accounts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
140
+ end
141
+ return data, status_code, headers
142
+ end
143
+
144
+ #
145
+ # @param [Hash] opts the optional parameters
146
+ # @option opts [String] :provider The provider of the results to fetch
147
+ # @option opts [String] :origin_owner_id The origin owner identifier of the results to fetch
148
+ # @return [Array<Account>]
149
+ def accounts_list(opts = {})
150
+ data, _status_code, _headers = accounts_list_with_http_info(opts)
151
+ data
152
+ end
153
+
154
+ #
155
+ # @param [Hash] opts the optional parameters
156
+ # @option opts [String] :provider The provider of the results to fetch
157
+ # @option opts [String] :origin_owner_id The origin owner identifier of the results to fetch
158
+ # @return [Array<(Array<Account>, Integer, Hash)>] Array<Account> data, response status code and response headers
159
+ def accounts_list_with_http_info(opts = {})
160
+ if @api_client.config.debugging
161
+ @api_client.config.logger.debug 'Calling API: AccountsApi.accounts_list ...'
162
+ end
163
+ # resource path
164
+ local_var_path = '/accounts'
165
+
166
+ # query parameters
167
+ query_params = opts[:query_params] || {}
168
+ query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].nil?
169
+ query_params[:'origin_owner_id'] = opts[:'origin_owner_id'] if !opts[:'origin_owner_id'].nil?
170
+
171
+ # header parameters
172
+ header_params = opts[:header_params] || {}
173
+ # HTTP header 'Accept' (if needed)
174
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
175
+
176
+ # form parameters
177
+ form_params = opts[:form_params] || {}
178
+
179
+ # http body (model)
180
+ post_body = opts[:debug_body]
181
+
182
+ # return_type
183
+ return_type = opts[:debug_return_type] || 'Array<Account>'
184
+
185
+ # auth_names
186
+ auth_names = opts[:debug_auth_names] || ['basic']
187
+
188
+ new_options = opts.merge(
189
+ :operation => :"AccountsApi.accounts_list",
190
+ :header_params => header_params,
191
+ :query_params => query_params,
192
+ :form_params => form_params,
193
+ :body => post_body,
194
+ :auth_names => auth_names,
195
+ :return_type => return_type
196
+ )
197
+
198
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
199
+ if @api_client.config.debugging
200
+ @api_client.config.logger.debug "API called: AccountsApi#accounts_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
201
+ end
202
+ return data, status_code, headers
203
+ end
204
+ end
205
+ end
@@ -0,0 +1,188 @@
1
+ =begin
2
+ #StackOne Unified API - HRIS
3
+
4
+ #The documentation for the StackOne Unified API - HRIS
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.4.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module StackOneHRIS
16
+ class CompaniesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ #
23
+ # @param id [String]
24
+ # @param x_account_id [String] The account identifier
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :page The page number of the results to fetch
27
+ # @option opts [String] :page_size The number of results per page (default to '25')
28
+ # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
29
+ # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
30
+ # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
31
+ # @option opts [String] :sync_token The sync token to select the only updated results
32
+ # @return [CompanyResult]
33
+ def companies_get(id, x_account_id, opts = {})
34
+ data, _status_code, _headers = companies_get_with_http_info(id, x_account_id, opts)
35
+ data
36
+ end
37
+
38
+ #
39
+ # @param id [String]
40
+ # @param x_account_id [String] The account identifier
41
+ # @param [Hash] opts the optional parameters
42
+ # @option opts [String] :page The page number of the results to fetch
43
+ # @option opts [String] :page_size The number of results per page (default to '25')
44
+ # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
45
+ # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
46
+ # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
47
+ # @option opts [String] :sync_token The sync token to select the only updated results
48
+ # @return [Array<(CompanyResult, Integer, Hash)>] CompanyResult data, response status code and response headers
49
+ def companies_get_with_http_info(id, x_account_id, opts = {})
50
+ if @api_client.config.debugging
51
+ @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_get ...'
52
+ end
53
+ # verify the required parameter 'id' is set
54
+ if @api_client.config.client_side_validation && id.nil?
55
+ fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesApi.companies_get"
56
+ end
57
+ # verify the required parameter 'x_account_id' is set
58
+ if @api_client.config.client_side_validation && x_account_id.nil?
59
+ fail ArgumentError, "Missing the required parameter 'x_account_id' when calling CompaniesApi.companies_get"
60
+ end
61
+ # resource path
62
+ local_var_path = '/unified/hris/companies/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
63
+
64
+ # query parameters
65
+ query_params = opts[:query_params] || {}
66
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
67
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
68
+ query_params[:'raw'] = opts[:'raw'] if !opts[:'raw'].nil?
69
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
70
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
71
+ query_params[:'sync_token'] = opts[:'sync_token'] if !opts[:'sync_token'].nil?
72
+
73
+ # header parameters
74
+ header_params = opts[:header_params] || {}
75
+ # HTTP header 'Accept' (if needed)
76
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
77
+ header_params[:'x-account-id'] = x_account_id
78
+
79
+ # form parameters
80
+ form_params = opts[:form_params] || {}
81
+
82
+ # http body (model)
83
+ post_body = opts[:debug_body]
84
+
85
+ # return_type
86
+ return_type = opts[:debug_return_type] || 'CompanyResult'
87
+
88
+ # auth_names
89
+ auth_names = opts[:debug_auth_names] || ['basic']
90
+
91
+ new_options = opts.merge(
92
+ :operation => :"CompaniesApi.companies_get",
93
+ :header_params => header_params,
94
+ :query_params => query_params,
95
+ :form_params => form_params,
96
+ :body => post_body,
97
+ :auth_names => auth_names,
98
+ :return_type => return_type
99
+ )
100
+
101
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug "API called: CompaniesApi#companies_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
104
+ end
105
+ return data, status_code, headers
106
+ end
107
+
108
+ #
109
+ # @param x_account_id [String] The account identifier
110
+ # @param [Hash] opts the optional parameters
111
+ # @option opts [String] :page The page number of the results to fetch
112
+ # @option opts [String] :page_size The number of results per page (default to '25')
113
+ # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
114
+ # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
115
+ # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
116
+ # @option opts [String] :sync_token The sync token to select the only updated results
117
+ # @return [CompaniesPaginated]
118
+ def companies_list(x_account_id, opts = {})
119
+ data, _status_code, _headers = companies_list_with_http_info(x_account_id, opts)
120
+ data
121
+ end
122
+
123
+ #
124
+ # @param x_account_id [String] The account identifier
125
+ # @param [Hash] opts the optional parameters
126
+ # @option opts [String] :page The page number of the results to fetch
127
+ # @option opts [String] :page_size The number of results per page (default to '25')
128
+ # @option opts [Boolean] :raw Indicates that the raw request result is returned (default to false)
129
+ # @option opts [Array<String>] :fields The list of fields to return in the response (if empty, all fields are returned)
130
+ # @option opts [Array<String>] :expand The list of fields that will be expanded in the response
131
+ # @option opts [String] :sync_token The sync token to select the only updated results
132
+ # @return [Array<(CompaniesPaginated, Integer, Hash)>] CompaniesPaginated data, response status code and response headers
133
+ def companies_list_with_http_info(x_account_id, opts = {})
134
+ if @api_client.config.debugging
135
+ @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_list ...'
136
+ end
137
+ # verify the required parameter 'x_account_id' is set
138
+ if @api_client.config.client_side_validation && x_account_id.nil?
139
+ fail ArgumentError, "Missing the required parameter 'x_account_id' when calling CompaniesApi.companies_list"
140
+ end
141
+ # resource path
142
+ local_var_path = '/unified/hris/companies'
143
+
144
+ # query parameters
145
+ query_params = opts[:query_params] || {}
146
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
147
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
148
+ query_params[:'raw'] = opts[:'raw'] if !opts[:'raw'].nil?
149
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
150
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
151
+ query_params[:'sync_token'] = opts[:'sync_token'] if !opts[:'sync_token'].nil?
152
+
153
+ # header parameters
154
+ header_params = opts[:header_params] || {}
155
+ # HTTP header 'Accept' (if needed)
156
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
157
+ header_params[:'x-account-id'] = x_account_id
158
+
159
+ # form parameters
160
+ form_params = opts[:form_params] || {}
161
+
162
+ # http body (model)
163
+ post_body = opts[:debug_body]
164
+
165
+ # return_type
166
+ return_type = opts[:debug_return_type] || 'CompaniesPaginated'
167
+
168
+ # auth_names
169
+ auth_names = opts[:debug_auth_names] || ['basic']
170
+
171
+ new_options = opts.merge(
172
+ :operation => :"CompaniesApi.companies_list",
173
+ :header_params => header_params,
174
+ :query_params => query_params,
175
+ :form_params => form_params,
176
+ :body => post_body,
177
+ :auth_names => auth_names,
178
+ :return_type => return_type
179
+ )
180
+
181
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
182
+ if @api_client.config.debugging
183
+ @api_client.config.logger.debug "API called: CompaniesApi#companies_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
184
+ end
185
+ return data, status_code, headers
186
+ end
187
+ end
188
+ end