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.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +42 -15
- data/docs/Account.md +32 -0
- data/docs/AccountsApi.md +218 -0
- data/docs/CompaniesApi.md +175 -0
- data/docs/CompaniesPaginated.md +22 -0
- data/docs/Company.md +22 -0
- data/docs/CompanyResult.md +20 -0
- data/docs/ConnectSession.md +34 -0
- data/docs/ConnectSessionAuthenticate.md +18 -0
- data/docs/ConnectSessionCreate.md +28 -0
- data/docs/ConnectSessionToken.md +36 -0
- data/docs/ConnectSessionsApi.md +145 -0
- data/docs/Employee.md +36 -12
- data/docs/EmployeeResult.md +2 -2
- data/docs/EmployeesApi.md +19 -13
- data/docs/EmployeesPaginated.md +2 -2
- data/docs/Employment.md +34 -0
- data/docs/EmploymentResult.md +20 -0
- data/docs/EmploymentsApi.md +175 -0
- data/docs/EmploymentsPaginated.md +22 -0
- data/docs/Location.md +38 -0
- data/docs/LocationResult.md +20 -0
- data/docs/LocationsApi.md +175 -0
- data/docs/LocationsPaginated.md +22 -0
- data/gem-config.yml +4 -4
- data/lib/stackone_hris_client/api/accounts_api.rb +205 -0
- data/lib/stackone_hris_client/api/companies_api.rb +188 -0
- data/lib/stackone_hris_client/api/connect_sessions_api.rb +154 -0
- data/lib/stackone_hris_client/api/employees_api.rb +10 -4
- data/lib/stackone_hris_client/api/employments_api.rb +188 -0
- data/lib/stackone_hris_client/api/locations_api.rb +188 -0
- data/lib/stackone_hris_client/api_client.rb +5 -5
- data/lib/stackone_hris_client/api_error.rb +4 -4
- data/lib/stackone_hris_client/configuration.rb +13 -12
- data/lib/stackone_hris_client/models/account.rb +322 -0
- data/lib/stackone_hris_client/models/companies_paginated.rb +249 -0
- data/lib/stackone_hris_client/models/company.rb +237 -0
- data/lib/stackone_hris_client/models/company_result.rb +233 -0
- data/lib/stackone_hris_client/models/connect_session.rb +350 -0
- data/lib/stackone_hris_client/models/connect_session_authenticate.rb +225 -0
- data/lib/stackone_hris_client/models/connect_session_create.rb +304 -0
- data/lib/stackone_hris_client/models/connect_session_token.rb +364 -0
- data/lib/stackone_hris_client/models/employee.rb +145 -60
- data/lib/stackone_hris_client/models/employee_result.rb +9 -7
- data/lib/stackone_hris_client/models/employees_paginated.rb +9 -7
- data/lib/stackone_hris_client/models/employment.rb +296 -0
- data/lib/stackone_hris_client/models/employment_result.rb +233 -0
- data/lib/stackone_hris_client/models/employments_paginated.rb +249 -0
- data/lib/stackone_hris_client/models/location.rb +314 -0
- data/lib/stackone_hris_client/models/location_result.rb +233 -0
- data/lib/stackone_hris_client/models/locations_paginated.rb +249 -0
- data/lib/stackone_hris_client/version.rb +5 -5
- data/lib/stackone_hris_client.rb +23 -4
- data/spec/api/accounts_api_spec.rb +58 -0
- data/spec/api/companies_api_spec.rb +70 -0
- data/spec/api/connect_sessions_api_spec.rb +57 -0
- data/spec/api/employments_api_spec.rb +70 -0
- data/spec/api/locations_api_spec.rb +70 -0
- data/spec/api_client_spec.rb +32 -32
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/account_spec.rb +76 -0
- data/spec/models/companies_paginated_spec.rb +46 -0
- data/spec/models/company_result_spec.rb +40 -0
- data/spec/models/company_spec.rb +46 -0
- data/spec/models/connect_session_authenticate_spec.rb +34 -0
- data/spec/models/connect_session_create_spec.rb +68 -0
- data/spec/models/connect_session_spec.rb +86 -0
- data/spec/models/connect_session_token_spec.rb +92 -0
- data/spec/models/employment_result_spec.rb +40 -0
- data/spec/models/employment_spec.rb +82 -0
- data/spec/models/employments_paginated_spec.rb +46 -0
- data/spec/models/location_result_spec.rb +40 -0
- data/spec/models/location_spec.rb +94 -0
- data/spec/models/locations_paginated_spec.rb +46 -0
- data/spec/spec_helper.rb +3 -3
- data/stackone_hris_client.gemspec +5 -5
- metadata +79 -3
@@ -0,0 +1,28 @@
|
|
1
|
+
# StackOneHRIS::ConnectSessionCreate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **categories** | **Array<String>** | The categories of the provider to connect to | [optional] |
|
8
|
+
| **provider** | **String** | The provider to connect to | [optional] |
|
9
|
+
| **origin_owner_id** | **String** | The origin owner identifier | |
|
10
|
+
| **origin_owner_name** | **String** | The origin owner name | |
|
11
|
+
| **origin_username** | **String** | The origin username | [optional] |
|
12
|
+
| **metadata** | **Object** | The metadata for the connection | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'stackone_hris_client'
|
18
|
+
|
19
|
+
instance = StackOneHRIS::ConnectSessionCreate.new(
|
20
|
+
categories: ["ats","hris","crm"],
|
21
|
+
provider: null,
|
22
|
+
origin_owner_id: null,
|
23
|
+
origin_owner_name: null,
|
24
|
+
origin_username: null,
|
25
|
+
metadata: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# StackOneHRIS::ConnectSessionToken
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **organization_id** | **String** | | |
|
9
|
+
| **project_id** | **String** | | |
|
10
|
+
| **categories** | **Array<String>** | | [optional] |
|
11
|
+
| **provider** | **String** | | |
|
12
|
+
| **origin_owner_id** | **String** | | |
|
13
|
+
| **origin_owner_name** | **String** | | |
|
14
|
+
| **origin_username** | **String** | | [optional] |
|
15
|
+
| **created_at** | **Time** | | |
|
16
|
+
| **token** | **String** | | |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'stackone_hris_client'
|
22
|
+
|
23
|
+
instance = StackOneHRIS::ConnectSessionToken.new(
|
24
|
+
id: null,
|
25
|
+
organization_id: null,
|
26
|
+
project_id: null,
|
27
|
+
categories: ["ats","hris","crm"],
|
28
|
+
provider: null,
|
29
|
+
origin_owner_id: null,
|
30
|
+
origin_owner_name: null,
|
31
|
+
origin_username: null,
|
32
|
+
created_at: null,
|
33
|
+
token: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
@@ -0,0 +1,145 @@
|
|
1
|
+
# StackOneHRIS::ConnectSessionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**connect_sessions_authenticate**](ConnectSessionsApi.md#connect_sessions_authenticate) | **POST** /connect_sessions/authenticate | |
|
8
|
+
| [**connect_sessions_create**](ConnectSessionsApi.md#connect_sessions_create) | **POST** /connect_sessions | |
|
9
|
+
|
10
|
+
|
11
|
+
## connect_sessions_authenticate
|
12
|
+
|
13
|
+
> <ConnectSession> connect_sessions_authenticate(connect_session_authenticate)
|
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::ConnectSessionsApi.new
|
30
|
+
connect_session_authenticate = StackOneHRIS::ConnectSessionAuthenticate.new({token: 'token_example'}) # ConnectSessionAuthenticate | The parameters to authenticate
|
31
|
+
|
32
|
+
begin
|
33
|
+
#
|
34
|
+
result = api_instance.connect_sessions_authenticate(connect_session_authenticate)
|
35
|
+
p result
|
36
|
+
rescue StackOneHRIS::ApiError => e
|
37
|
+
puts "Error when calling ConnectSessionsApi->connect_sessions_authenticate: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
#### Using the connect_sessions_authenticate_with_http_info variant
|
42
|
+
|
43
|
+
This returns an Array which contains the response data, status code and headers.
|
44
|
+
|
45
|
+
> <Array(<ConnectSession>, Integer, Hash)> connect_sessions_authenticate_with_http_info(connect_session_authenticate)
|
46
|
+
|
47
|
+
```ruby
|
48
|
+
begin
|
49
|
+
#
|
50
|
+
data, status_code, headers = api_instance.connect_sessions_authenticate_with_http_info(connect_session_authenticate)
|
51
|
+
p status_code # => 2xx
|
52
|
+
p headers # => { ... }
|
53
|
+
p data # => <ConnectSession>
|
54
|
+
rescue StackOneHRIS::ApiError => e
|
55
|
+
puts "Error when calling ConnectSessionsApi->connect_sessions_authenticate_with_http_info: #{e}"
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
### Parameters
|
60
|
+
|
61
|
+
| Name | Type | Description | Notes |
|
62
|
+
| ---- | ---- | ----------- | ----- |
|
63
|
+
| **connect_session_authenticate** | [**ConnectSessionAuthenticate**](ConnectSessionAuthenticate.md) | The parameters to authenticate | |
|
64
|
+
|
65
|
+
### Return type
|
66
|
+
|
67
|
+
[**ConnectSession**](ConnectSession.md)
|
68
|
+
|
69
|
+
### Authorization
|
70
|
+
|
71
|
+
[basic](../README.md#basic)
|
72
|
+
|
73
|
+
### HTTP request headers
|
74
|
+
|
75
|
+
- **Content-Type**: application/json
|
76
|
+
- **Accept**: application/json
|
77
|
+
|
78
|
+
|
79
|
+
## connect_sessions_create
|
80
|
+
|
81
|
+
> <ConnectSessionToken> connect_sessions_create(connect_session_create)
|
82
|
+
|
83
|
+
|
84
|
+
|
85
|
+
### Examples
|
86
|
+
|
87
|
+
```ruby
|
88
|
+
require 'time'
|
89
|
+
require 'stackone_hris_client'
|
90
|
+
# setup authorization
|
91
|
+
StackOneHRIS.configure do |config|
|
92
|
+
# Configure HTTP basic authorization: basic
|
93
|
+
config.username = 'YOUR USERNAME'
|
94
|
+
config.password = 'YOUR PASSWORD'
|
95
|
+
end
|
96
|
+
|
97
|
+
api_instance = StackOneHRIS::ConnectSessionsApi.new
|
98
|
+
connect_session_create = StackOneHRIS::ConnectSessionCreate.new({origin_owner_id: 'origin_owner_id_example', origin_owner_name: 'origin_owner_name_example'}) # ConnectSessionCreate |
|
99
|
+
|
100
|
+
begin
|
101
|
+
#
|
102
|
+
result = api_instance.connect_sessions_create(connect_session_create)
|
103
|
+
p result
|
104
|
+
rescue StackOneHRIS::ApiError => e
|
105
|
+
puts "Error when calling ConnectSessionsApi->connect_sessions_create: #{e}"
|
106
|
+
end
|
107
|
+
```
|
108
|
+
|
109
|
+
#### Using the connect_sessions_create_with_http_info variant
|
110
|
+
|
111
|
+
This returns an Array which contains the response data, status code and headers.
|
112
|
+
|
113
|
+
> <Array(<ConnectSessionToken>, Integer, Hash)> connect_sessions_create_with_http_info(connect_session_create)
|
114
|
+
|
115
|
+
```ruby
|
116
|
+
begin
|
117
|
+
#
|
118
|
+
data, status_code, headers = api_instance.connect_sessions_create_with_http_info(connect_session_create)
|
119
|
+
p status_code # => 2xx
|
120
|
+
p headers # => { ... }
|
121
|
+
p data # => <ConnectSessionToken>
|
122
|
+
rescue StackOneHRIS::ApiError => e
|
123
|
+
puts "Error when calling ConnectSessionsApi->connect_sessions_create_with_http_info: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
### Parameters
|
128
|
+
|
129
|
+
| Name | Type | Description | Notes |
|
130
|
+
| ---- | ---- | ----------- | ----- |
|
131
|
+
| **connect_session_create** | [**ConnectSessionCreate**](ConnectSessionCreate.md) | | |
|
132
|
+
|
133
|
+
### Return type
|
134
|
+
|
135
|
+
[**ConnectSessionToken**](ConnectSessionToken.md)
|
136
|
+
|
137
|
+
### Authorization
|
138
|
+
|
139
|
+
[basic](../README.md#basic)
|
140
|
+
|
141
|
+
### HTTP request headers
|
142
|
+
|
143
|
+
- **Content-Type**: application/json
|
144
|
+
- **Accept**: application/json
|
145
|
+
|
data/docs/Employee.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# StackOneHRIS::Employee
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -9,40 +9,64 @@
|
|
9
9
|
| **last_name** | **String** | | |
|
10
10
|
| **name** | **String** | | |
|
11
11
|
| **display_name** | **String** | | |
|
12
|
+
| **gender** | **String** | | |
|
13
|
+
| **ethnicity** | **String** | | [optional] |
|
14
|
+
| **date_of_birth** | **Time** | | [optional] |
|
15
|
+
| **birthday** | **Time** | | [optional] |
|
16
|
+
| **marital_status** | **String** | | [optional] |
|
12
17
|
| **avatar_url** | **String** | | [optional] |
|
13
|
-
| **personal_email** | **String** | |
|
18
|
+
| **personal_email** | **String** | | [optional] |
|
14
19
|
| **personal_phone_number** | **String** | | |
|
15
|
-
| **gender** | **String** | | |
|
16
20
|
| **work_email** | **String** | | |
|
17
21
|
| **work_phone_number** | **String** | | |
|
18
|
-
| **
|
22
|
+
| **job_title** | **String** | | [optional] |
|
19
23
|
| **department** | **String** | | |
|
20
|
-
| **manager_id** | **String** | |
|
21
|
-
| **
|
22
|
-
| **start_date** | **Time** | |
|
24
|
+
| **manager_id** | **String** | | [optional] |
|
25
|
+
| **hire_date** | **Time** | | [optional] |
|
26
|
+
| **start_date** | **Time** | | [optional] |
|
27
|
+
| **tenure** | **Float** | | [optional] |
|
28
|
+
| **work_anniversary** | **Time** | | [optional] |
|
29
|
+
| **employment_type** | **String** | | [optional] |
|
30
|
+
| **employment_status** | **String** | | [optional] |
|
31
|
+
| **termination_date** | **Time** | | [optional] |
|
32
|
+
| **company_name** | **String** | | [optional] |
|
33
|
+
| **home_country_location** | **String** | | [optional] |
|
34
|
+
| **work_country_location** | **String** | | [optional] |
|
23
35
|
|
24
36
|
## Example
|
25
37
|
|
26
38
|
```ruby
|
27
39
|
require 'stackone_hris_client'
|
28
40
|
|
29
|
-
instance =
|
41
|
+
instance = StackOneHRIS::Employee.new(
|
30
42
|
id: null,
|
31
43
|
first_name: null,
|
32
44
|
last_name: null,
|
33
45
|
name: null,
|
34
46
|
display_name: null,
|
47
|
+
gender: null,
|
48
|
+
ethnicity: null,
|
49
|
+
date_of_birth: null,
|
50
|
+
birthday: null,
|
51
|
+
marital_status: null,
|
35
52
|
avatar_url: null,
|
36
53
|
personal_email: null,
|
37
54
|
personal_phone_number: null,
|
38
|
-
gender: null,
|
39
55
|
work_email: null,
|
40
56
|
work_phone_number: null,
|
41
|
-
|
57
|
+
job_title: null,
|
42
58
|
department: null,
|
43
59
|
manager_id: null,
|
44
|
-
|
45
|
-
start_date: null
|
60
|
+
hire_date: null,
|
61
|
+
start_date: null,
|
62
|
+
tenure: null,
|
63
|
+
work_anniversary: null,
|
64
|
+
employment_type: null,
|
65
|
+
employment_status: null,
|
66
|
+
termination_date: null,
|
67
|
+
company_name: null,
|
68
|
+
home_country_location: null,
|
69
|
+
work_country_location: null
|
46
70
|
)
|
47
71
|
```
|
48
72
|
|
data/docs/EmployeeResult.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# StackOneHRIS::EmployeeResult
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -12,7 +12,7 @@
|
|
12
12
|
```ruby
|
13
13
|
require 'stackone_hris_client'
|
14
14
|
|
15
|
-
instance =
|
15
|
+
instance = StackOneHRIS::EmployeeResult.new(
|
16
16
|
data: null,
|
17
17
|
raw: null
|
18
18
|
)
|
data/docs/EmployeesApi.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# StackOneHRIS::EmployeesApi
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost*
|
4
4
|
|
@@ -20,12 +20,13 @@ All URIs are relative to *http://localhost*
|
|
20
20
|
require 'time'
|
21
21
|
require 'stackone_hris_client'
|
22
22
|
# setup authorization
|
23
|
-
|
23
|
+
StackOneHRIS.configure do |config|
|
24
24
|
# Configure HTTP basic authorization: basic
|
25
|
-
config.
|
25
|
+
config.username = 'YOUR USERNAME'
|
26
|
+
config.password = 'YOUR PASSWORD'
|
26
27
|
end
|
27
28
|
|
28
|
-
api_instance =
|
29
|
+
api_instance = StackOneHRIS::EmployeesApi.new
|
29
30
|
id = 'id_example' # String |
|
30
31
|
x_account_id = 'x_account_id_example' # String | The account identifier
|
31
32
|
opts = {
|
@@ -33,14 +34,15 @@ opts = {
|
|
33
34
|
page_size: 'page_size_example', # String | The number of results per page
|
34
35
|
raw: true, # Boolean | Indicates that the raw request result is returned
|
35
36
|
fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
|
36
|
-
expand: ['inner_example'] # Array<String> | The list of fields that will be expanded in the response
|
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
|
37
39
|
}
|
38
40
|
|
39
41
|
begin
|
40
42
|
#
|
41
43
|
result = api_instance.employees_get(id, x_account_id, opts)
|
42
44
|
p result
|
43
|
-
rescue
|
45
|
+
rescue StackOneHRIS::ApiError => e
|
44
46
|
puts "Error when calling EmployeesApi->employees_get: #{e}"
|
45
47
|
end
|
46
48
|
```
|
@@ -58,7 +60,7 @@ begin
|
|
58
60
|
p status_code # => 2xx
|
59
61
|
p headers # => { ... }
|
60
62
|
p data # => <EmployeeResult>
|
61
|
-
rescue
|
63
|
+
rescue StackOneHRIS::ApiError => e
|
62
64
|
puts "Error when calling EmployeesApi->employees_get_with_http_info: #{e}"
|
63
65
|
end
|
64
66
|
```
|
@@ -74,6 +76,7 @@ end
|
|
74
76
|
| **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
|
75
77
|
| **fields** | [**Array<String>**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
|
76
78
|
| **expand** | [**Array<String>**](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] |
|
77
80
|
|
78
81
|
### Return type
|
79
82
|
|
@@ -101,26 +104,28 @@ end
|
|
101
104
|
require 'time'
|
102
105
|
require 'stackone_hris_client'
|
103
106
|
# setup authorization
|
104
|
-
|
107
|
+
StackOneHRIS.configure do |config|
|
105
108
|
# Configure HTTP basic authorization: basic
|
106
|
-
config.
|
109
|
+
config.username = 'YOUR USERNAME'
|
110
|
+
config.password = 'YOUR PASSWORD'
|
107
111
|
end
|
108
112
|
|
109
|
-
api_instance =
|
113
|
+
api_instance = StackOneHRIS::EmployeesApi.new
|
110
114
|
x_account_id = 'x_account_id_example' # String | The account identifier
|
111
115
|
opts = {
|
112
116
|
page: 'page_example', # String | The page number of the results to fetch
|
113
117
|
page_size: 'page_size_example', # String | The number of results per page
|
114
118
|
raw: true, # Boolean | Indicates that the raw request result is returned
|
115
119
|
fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
|
116
|
-
expand: ['inner_example'] # Array<String> | The list of fields that will be expanded in the response
|
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
122
|
}
|
118
123
|
|
119
124
|
begin
|
120
125
|
#
|
121
126
|
result = api_instance.employees_list(x_account_id, opts)
|
122
127
|
p result
|
123
|
-
rescue
|
128
|
+
rescue StackOneHRIS::ApiError => e
|
124
129
|
puts "Error when calling EmployeesApi->employees_list: #{e}"
|
125
130
|
end
|
126
131
|
```
|
@@ -138,7 +143,7 @@ begin
|
|
138
143
|
p status_code # => 2xx
|
139
144
|
p headers # => { ... }
|
140
145
|
p data # => <EmployeesPaginated>
|
141
|
-
rescue
|
146
|
+
rescue StackOneHRIS::ApiError => e
|
142
147
|
puts "Error when calling EmployeesApi->employees_list_with_http_info: #{e}"
|
143
148
|
end
|
144
149
|
```
|
@@ -153,6 +158,7 @@ end
|
|
153
158
|
| **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
|
154
159
|
| **fields** | [**Array<String>**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
|
155
160
|
| **expand** | [**Array<String>**](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] |
|
156
162
|
|
157
163
|
### Return type
|
158
164
|
|
data/docs/EmployeesPaginated.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# StackOneHRIS::EmployeesPaginated
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -13,7 +13,7 @@
|
|
13
13
|
```ruby
|
14
14
|
require 'stackone_hris_client'
|
15
15
|
|
16
|
-
instance =
|
16
|
+
instance = StackOneHRIS::EmployeesPaginated.new(
|
17
17
|
next_page: null,
|
18
18
|
data: null,
|
19
19
|
raw: null
|
data/docs/Employment.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# StackOneHRIS::Employment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional] |
|
8
|
+
| **employee_id** | **String** | | |
|
9
|
+
| **job_title** | **String** | | [optional] |
|
10
|
+
| **pay_rate** | **String** | | [optional] |
|
11
|
+
| **pay_period** | **String** | | [optional] |
|
12
|
+
| **pay_frequency** | **String** | | [optional] |
|
13
|
+
| **pay_currency** | **String** | | [optional] |
|
14
|
+
| **effective_date** | **Time** | | [optional] |
|
15
|
+
| **employment_type** | **String** | | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'stackone_hris_client'
|
21
|
+
|
22
|
+
instance = StackOneHRIS::Employment.new(
|
23
|
+
id: null,
|
24
|
+
employee_id: null,
|
25
|
+
job_title: null,
|
26
|
+
pay_rate: null,
|
27
|
+
pay_period: null,
|
28
|
+
pay_frequency: null,
|
29
|
+
pay_currency: null,
|
30
|
+
effective_date: null,
|
31
|
+
employment_type: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# StackOneHRIS::EmploymentResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Employment**](Employment.md) | | |
|
8
|
+
| **raw** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'stackone_hris_client'
|
14
|
+
|
15
|
+
instance = StackOneHRIS::EmploymentResult.new(
|
16
|
+
data: null,
|
17
|
+
raw: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,175 @@
|
|
1
|
+
# StackOneHRIS::EmploymentsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**employments_get**](EmploymentsApi.md#employments_get) | **GET** /unified/hris/employments/{id} | |
|
8
|
+
| [**employments_list**](EmploymentsApi.md#employments_list) | **GET** /unified/hris/employments | |
|
9
|
+
|
10
|
+
|
11
|
+
## employments_get
|
12
|
+
|
13
|
+
> <EmploymentResult> employments_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::EmploymentsApi.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.employments_get(id, x_account_id, opts)
|
44
|
+
p result
|
45
|
+
rescue StackOneHRIS::ApiError => e
|
46
|
+
puts "Error when calling EmploymentsApi->employments_get: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
#### Using the employments_get_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
53
|
+
|
54
|
+
> <Array(<EmploymentResult>, Integer, Hash)> employments_get_with_http_info(id, x_account_id, opts)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
#
|
59
|
+
data, status_code, headers = api_instance.employments_get_with_http_info(id, x_account_id, opts)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => <EmploymentResult>
|
63
|
+
rescue StackOneHRIS::ApiError => e
|
64
|
+
puts "Error when calling EmploymentsApi->employments_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 '25'] |
|
76
|
+
| **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
|
77
|
+
| **fields** | [**Array<String>**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
|
78
|
+
| **expand** | [**Array<String>**](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
|
+
[**EmploymentResult**](EmploymentResult.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
|
+
## employments_list
|
96
|
+
|
97
|
+
> <EmploymentsPaginated> employments_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::EmploymentsApi.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.employments_list(x_account_id, opts)
|
127
|
+
p result
|
128
|
+
rescue StackOneHRIS::ApiError => e
|
129
|
+
puts "Error when calling EmploymentsApi->employments_list: #{e}"
|
130
|
+
end
|
131
|
+
```
|
132
|
+
|
133
|
+
#### Using the employments_list_with_http_info variant
|
134
|
+
|
135
|
+
This returns an Array which contains the response data, status code and headers.
|
136
|
+
|
137
|
+
> <Array(<EmploymentsPaginated>, Integer, Hash)> employments_list_with_http_info(x_account_id, opts)
|
138
|
+
|
139
|
+
```ruby
|
140
|
+
begin
|
141
|
+
#
|
142
|
+
data, status_code, headers = api_instance.employments_list_with_http_info(x_account_id, opts)
|
143
|
+
p status_code # => 2xx
|
144
|
+
p headers # => { ... }
|
145
|
+
p data # => <EmploymentsPaginated>
|
146
|
+
rescue StackOneHRIS::ApiError => e
|
147
|
+
puts "Error when calling EmploymentsApi->employments_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 '25'] |
|
158
|
+
| **raw** | **Boolean** | Indicates that the raw request result is returned | [optional][default to false] |
|
159
|
+
| **fields** | [**Array<String>**](String.md) | The list of fields to return in the response (if empty, all fields are returned) | [optional] |
|
160
|
+
| **expand** | [**Array<String>**](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
|
+
[**EmploymentsPaginated**](EmploymentsPaginated.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::EmploymentsPaginated
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **next_page** | **String** | | |
|
8
|
+
| **data** | [**Array<Employment>**](Employment.md) | | |
|
9
|
+
| **raw** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'stackone_hris_client'
|
15
|
+
|
16
|
+
instance = StackOneHRIS::EmploymentsPaginated.new(
|
17
|
+
next_page: null,
|
18
|
+
data: null,
|
19
|
+
raw: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|