stackone_hris_client 1.5.1 → 1.6.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 +23 -29
- data/docs/Account.md +2 -0
- data/docs/AccountsApi.md +12 -12
- data/docs/CompaniesApi.md +24 -24
- data/docs/ConnectSession.md +1 -1
- data/docs/ConnectSessionCreate.md +1 -1
- data/docs/ConnectSessionToken.md +1 -1
- data/docs/ConnectSessionsApi.md +8 -8
- data/docs/Employee.md +2 -0
- data/docs/EmployeesApi.md +26 -26
- data/docs/EmploymentsApi.md +24 -24
- data/docs/Image.md +20 -0
- data/docs/LocationsApi.md +8 -8
- data/gem-config.yml +2 -2
- data/lib/stackone_hris_client/api/accounts_api.rb +7 -7
- data/lib/stackone_hris_client/api/companies_api.rb +20 -20
- data/lib/stackone_hris_client/api/connect_sessions_api.rb +5 -5
- data/lib/stackone_hris_client/api/employees_api.rb +20 -20
- data/lib/stackone_hris_client/api/employments_api.rb +20 -20
- data/lib/stackone_hris_client/api/locations_api.rb +5 -5
- data/lib/stackone_hris_client/api_client.rb +1 -1
- data/lib/stackone_hris_client/api_error.rb +1 -1
- data/lib/stackone_hris_client/configuration.rb +2 -2
- data/lib/stackone_hris_client/models/account.rb +16 -2
- data/lib/stackone_hris_client/models/companies_paginated.rb +1 -1
- data/lib/stackone_hris_client/models/company.rb +1 -1
- data/lib/stackone_hris_client/models/company_result.rb +1 -1
- data/lib/stackone_hris_client/models/connect_session.rb +1 -1
- data/lib/stackone_hris_client/models/connect_session_authenticate.rb +1 -1
- data/lib/stackone_hris_client/models/connect_session_create.rb +1 -1
- data/lib/stackone_hris_client/models/connect_session_token.rb +1 -1
- data/lib/stackone_hris_client/models/country_code_enum.rb +1 -1
- data/lib/stackone_hris_client/models/employee.rb +11 -2
- data/lib/stackone_hris_client/models/employee_result.rb +1 -1
- data/lib/stackone_hris_client/models/employees_paginated.rb +1 -1
- data/lib/stackone_hris_client/models/employment.rb +1 -1
- data/lib/stackone_hris_client/models/employment_result.rb +1 -1
- data/lib/stackone_hris_client/models/employment_status_enum.rb +3 -3
- data/lib/stackone_hris_client/models/employment_type_enum.rb +3 -3
- data/lib/stackone_hris_client/models/employments_paginated.rb +1 -1
- data/lib/stackone_hris_client/models/ethnicity_enum.rb +3 -3
- data/lib/stackone_hris_client/models/gender_enum.rb +3 -3
- data/lib/stackone_hris_client/models/image.rb +226 -0
- data/lib/stackone_hris_client/models/location.rb +1 -1
- data/lib/stackone_hris_client/models/location_result.rb +1 -1
- data/lib/stackone_hris_client/models/location_type_enum.rb +1 -1
- data/lib/stackone_hris_client/models/locations_paginated.rb +1 -1
- data/lib/stackone_hris_client/models/marital_status_enum.rb +3 -3
- data/lib/stackone_hris_client/models/pay_frequency_enum.rb +3 -3
- data/lib/stackone_hris_client/models/pay_period_enum.rb +1 -1
- data/lib/stackone_hris_client/version.rb +2 -2
- data/lib/stackone_hris_client.rb +2 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/image_spec.rb +40 -0
- data/spec/spec_helper.rb +1 -1
- data/stackone_hris_client.gemspec +1 -1
- metadata +6 -3
- data/stackone_hris_client-1.5.0.gem +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d4431aca0c3b558fa76dd1202e71afc8ae4dc23f2511435accc4eb13a892d161
|
4
|
+
data.tar.gz: 1cbd10f52dadc7f6d8252ff1ff6eaca859371dc639d0b966beaf0d4ff196a97f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b02d3957a16fb71c2f8d591fa3300a6726c6d81738fc47f5e31ba7ed4bbcf92cb27df018ff20f574cb632b084c95e08e60dd39e3655bd962317bbad105e2ec36
|
7
|
+
data.tar.gz: e483898527db7c1d5cb66e30105a08ac21d289e9ace5b9fa4192d34348340f2995244284d02e1012b264659ce545cc60c56d29cf7267c55048d058844e3da5b5
|
data/Gemfile.lock
CHANGED
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.
|
10
|
+
- Package version: 1.6.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.
|
26
|
+
gem install ./stackone_hris_client-1.6.0.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./stackone_hris_client-1.
|
29
|
+
(for development, run `gem install --dev ./stackone_hris_client-1.6.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.
|
35
|
+
gem 'stackone_hris_client', '~> 1.6.0'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -62,23 +62,15 @@ StackOneHRIS.configure do |config|
|
|
62
62
|
config.api_key_token = 'YOUR API KEY'
|
63
63
|
end
|
64
64
|
|
65
|
-
api_instance = StackOneHRIS::
|
65
|
+
api_instance = StackOneHRIS::AccountsApi.new
|
66
66
|
id = 'id_example' # String |
|
67
|
-
x_account_id = 'x_account_id_example' # String | The account identifier
|
68
|
-
opts = {
|
69
|
-
page: 'page_example', # String | The page number of the results to fetch
|
70
|
-
page_size: 'page_size_example', # String | The number of results per page
|
71
|
-
raw: true, # Boolean | Indicates that the raw request result is returned
|
72
|
-
fields: ['inner_example'], # Array<String> | The list of fields to return in the response (if empty, all fields are returned)
|
73
|
-
expand: ['inner_example'] # Array<String> | The list of fields that will be expanded in the response
|
74
|
-
}
|
75
67
|
|
76
68
|
begin
|
77
|
-
#
|
78
|
-
result = api_instance.
|
69
|
+
#Delete Account
|
70
|
+
result = api_instance.accounts_delete(id)
|
79
71
|
p result
|
80
72
|
rescue StackOneHRIS::ApiError => e
|
81
|
-
puts "Exception when calling
|
73
|
+
puts "Exception when calling AccountsApi->accounts_delete: #{e}"
|
82
74
|
end
|
83
75
|
|
84
76
|
```
|
@@ -89,19 +81,19 @@ All URIs are relative to *https://api.stackone.com*
|
|
89
81
|
|
90
82
|
Class | Method | HTTP request | Description
|
91
83
|
------------ | ------------- | ------------- | -------------
|
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* | [**
|
96
|
-
*StackOneHRIS::CompaniesApi* | [**
|
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* | [**
|
100
|
-
*StackOneHRIS::EmployeesApi* | [**
|
101
|
-
*StackOneHRIS::EmploymentsApi* | [**
|
102
|
-
*StackOneHRIS::EmploymentsApi* | [**
|
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 |
|
84
|
+
*StackOneHRIS::AccountsApi* | [**accounts_delete**](docs/AccountsApi.md#accounts_delete) | **DELETE** /accounts/{id} | Delete Account
|
85
|
+
*StackOneHRIS::AccountsApi* | [**accounts_get**](docs/AccountsApi.md#accounts_get) | **GET** /accounts/{id} | Get Account
|
86
|
+
*StackOneHRIS::AccountsApi* | [**accounts_list**](docs/AccountsApi.md#accounts_list) | **GET** /accounts | List Accounts
|
87
|
+
*StackOneHRIS::CompaniesApi* | [**hris_companies_get**](docs/CompaniesApi.md#hris_companies_get) | **GET** /unified/hris/companies/{id} | Get Company
|
88
|
+
*StackOneHRIS::CompaniesApi* | [**hris_companies_list**](docs/CompaniesApi.md#hris_companies_list) | **GET** /unified/hris/companies | List Companies
|
89
|
+
*StackOneHRIS::ConnectSessionsApi* | [**connect_sessions_authenticate**](docs/ConnectSessionsApi.md#connect_sessions_authenticate) | **POST** /connect_sessions/authenticate | Authenticate Session
|
90
|
+
*StackOneHRIS::ConnectSessionsApi* | [**connect_sessions_create**](docs/ConnectSessionsApi.md#connect_sessions_create) | **POST** /connect_sessions | Create Session
|
91
|
+
*StackOneHRIS::EmployeesApi* | [**hris_employees_get**](docs/EmployeesApi.md#hris_employees_get) | **GET** /unified/hris/employees/{id} | Get Employee
|
92
|
+
*StackOneHRIS::EmployeesApi* | [**hris_employees_list**](docs/EmployeesApi.md#hris_employees_list) | **GET** /unified/hris/employees | List Employees
|
93
|
+
*StackOneHRIS::EmploymentsApi* | [**hris_employments_get**](docs/EmploymentsApi.md#hris_employments_get) | **GET** /unified/hris/employments/{id} | Get Employment
|
94
|
+
*StackOneHRIS::EmploymentsApi* | [**hris_employments_list**](docs/EmploymentsApi.md#hris_employments_list) | **GET** /unified/hris/employments | List Employments
|
95
|
+
*StackOneHRIS::LocationsApi* | [**hris_locations_get**](docs/LocationsApi.md#hris_locations_get) | **GET** /unified/hris/locations/{id} | Get location
|
96
|
+
*StackOneHRIS::LocationsApi* | [**hris_locations_list**](docs/LocationsApi.md#hris_locations_list) | **GET** /unified/hris/locations | List locations
|
105
97
|
|
106
98
|
|
107
99
|
## Documentation for Models
|
@@ -125,6 +117,7 @@ Class | Method | HTTP request | Description
|
|
125
117
|
- [StackOneHRIS::EmploymentsPaginated](docs/EmploymentsPaginated.md)
|
126
118
|
- [StackOneHRIS::EthnicityEnum](docs/EthnicityEnum.md)
|
127
119
|
- [StackOneHRIS::GenderEnum](docs/GenderEnum.md)
|
120
|
+
- [StackOneHRIS::Image](docs/Image.md)
|
128
121
|
- [StackOneHRIS::Location](docs/Location.md)
|
129
122
|
- [StackOneHRIS::LocationResult](docs/LocationResult.md)
|
130
123
|
- [StackOneHRIS::LocationTypeEnum](docs/LocationTypeEnum.md)
|
@@ -137,6 +130,7 @@ Class | Method | HTTP request | Description
|
|
137
130
|
## Documentation for Authorization
|
138
131
|
|
139
132
|
|
133
|
+
Authentication schemes defined for the API:
|
140
134
|
### basic
|
141
135
|
|
142
136
|
- **Type**: HTTP basic authentication
|
data/docs/Account.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | |
|
8
8
|
| **provider** | **String** | | |
|
9
|
+
| **active** | **Boolean** | | |
|
9
10
|
| **origin_owner_id** | **String** | | |
|
10
11
|
| **origin_owner_name** | **String** | | |
|
11
12
|
| **origin_username** | **String** | | |
|
@@ -21,6 +22,7 @@ require 'stackone_hris_client'
|
|
21
22
|
instance = StackOneHRIS::Account.new(
|
22
23
|
id: null,
|
23
24
|
provider: null,
|
25
|
+
active: null,
|
24
26
|
origin_owner_id: null,
|
25
27
|
origin_owner_name: null,
|
26
28
|
origin_username: null,
|
data/docs/AccountsApi.md
CHANGED
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.stackone.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**accounts_delete**](AccountsApi.md#accounts_delete) | **DELETE** /accounts/{id} |
|
8
|
-
| [**accounts_get**](AccountsApi.md#accounts_get) | **GET** /accounts/{id} |
|
9
|
-
| [**accounts_list**](AccountsApi.md#accounts_list) | **GET** /accounts |
|
7
|
+
| [**accounts_delete**](AccountsApi.md#accounts_delete) | **DELETE** /accounts/{id} | Delete Account |
|
8
|
+
| [**accounts_get**](AccountsApi.md#accounts_get) | **GET** /accounts/{id} | Get Account |
|
9
|
+
| [**accounts_list**](AccountsApi.md#accounts_list) | **GET** /accounts | List Accounts |
|
10
10
|
|
11
11
|
|
12
12
|
## accounts_delete
|
13
13
|
|
14
14
|
> <Account> accounts_delete(id)
|
15
15
|
|
16
|
-
|
16
|
+
Delete Account
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
@@ -30,7 +30,7 @@ api_instance = StackOneHRIS::AccountsApi.new
|
|
30
30
|
id = 'id_example' # String |
|
31
31
|
|
32
32
|
begin
|
33
|
-
#
|
33
|
+
# Delete Account
|
34
34
|
result = api_instance.accounts_delete(id)
|
35
35
|
p result
|
36
36
|
rescue StackOneHRIS::ApiError => e
|
@@ -46,7 +46,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
46
46
|
|
47
47
|
```ruby
|
48
48
|
begin
|
49
|
-
#
|
49
|
+
# Delete Account
|
50
50
|
data, status_code, headers = api_instance.accounts_delete_with_http_info(id)
|
51
51
|
p status_code # => 2xx
|
52
52
|
p headers # => { ... }
|
@@ -80,7 +80,7 @@ end
|
|
80
80
|
|
81
81
|
> <Account> accounts_get(id)
|
82
82
|
|
83
|
-
|
83
|
+
Get Account
|
84
84
|
|
85
85
|
### Examples
|
86
86
|
|
@@ -97,7 +97,7 @@ api_instance = StackOneHRIS::AccountsApi.new
|
|
97
97
|
id = 'id_example' # String |
|
98
98
|
|
99
99
|
begin
|
100
|
-
#
|
100
|
+
# Get Account
|
101
101
|
result = api_instance.accounts_get(id)
|
102
102
|
p result
|
103
103
|
rescue StackOneHRIS::ApiError => e
|
@@ -113,7 +113,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
113
113
|
|
114
114
|
```ruby
|
115
115
|
begin
|
116
|
-
#
|
116
|
+
# Get Account
|
117
117
|
data, status_code, headers = api_instance.accounts_get_with_http_info(id)
|
118
118
|
p status_code # => 2xx
|
119
119
|
p headers # => { ... }
|
@@ -147,7 +147,7 @@ end
|
|
147
147
|
|
148
148
|
> <Array<Account>> accounts_list(opts)
|
149
149
|
|
150
|
-
|
150
|
+
List Accounts
|
151
151
|
|
152
152
|
### Examples
|
153
153
|
|
@@ -167,7 +167,7 @@ opts = {
|
|
167
167
|
}
|
168
168
|
|
169
169
|
begin
|
170
|
-
#
|
170
|
+
# List Accounts
|
171
171
|
result = api_instance.accounts_list(opts)
|
172
172
|
p result
|
173
173
|
rescue StackOneHRIS::ApiError => e
|
@@ -183,7 +183,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
183
183
|
|
184
184
|
```ruby
|
185
185
|
begin
|
186
|
-
#
|
186
|
+
# List Accounts
|
187
187
|
data, status_code, headers = api_instance.accounts_list_with_http_info(opts)
|
188
188
|
p status_code # => 2xx
|
189
189
|
p headers # => { ... }
|
data/docs/CompaniesApi.md
CHANGED
@@ -4,15 +4,15 @@ All URIs are relative to *https://api.stackone.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
8
|
-
| [**
|
7
|
+
| [**hris_companies_get**](CompaniesApi.md#hris_companies_get) | **GET** /unified/hris/companies/{id} | Get Company |
|
8
|
+
| [**hris_companies_list**](CompaniesApi.md#hris_companies_list) | **GET** /unified/hris/companies | List Companies |
|
9
9
|
|
10
10
|
|
11
|
-
##
|
12
|
-
|
13
|
-
> <CompanyResult> companies_get(id, x_account_id, opts)
|
11
|
+
## hris_companies_get
|
14
12
|
|
13
|
+
> <CompanyResult> hris_companies_get(id, x_account_id, opts)
|
15
14
|
|
15
|
+
Get Company
|
16
16
|
|
17
17
|
### Examples
|
18
18
|
|
@@ -38,29 +38,29 @@ opts = {
|
|
38
38
|
}
|
39
39
|
|
40
40
|
begin
|
41
|
-
#
|
42
|
-
result = api_instance.
|
41
|
+
# Get Company
|
42
|
+
result = api_instance.hris_companies_get(id, x_account_id, opts)
|
43
43
|
p result
|
44
44
|
rescue StackOneHRIS::ApiError => e
|
45
|
-
puts "Error when calling CompaniesApi->
|
45
|
+
puts "Error when calling CompaniesApi->hris_companies_get: #{e}"
|
46
46
|
end
|
47
47
|
```
|
48
48
|
|
49
|
-
#### Using the
|
49
|
+
#### Using the hris_companies_get_with_http_info variant
|
50
50
|
|
51
51
|
This returns an Array which contains the response data, status code and headers.
|
52
52
|
|
53
|
-
> <Array(<CompanyResult>, Integer, Hash)>
|
53
|
+
> <Array(<CompanyResult>, Integer, Hash)> hris_companies_get_with_http_info(id, x_account_id, opts)
|
54
54
|
|
55
55
|
```ruby
|
56
56
|
begin
|
57
|
-
#
|
58
|
-
data, status_code, headers = api_instance.
|
57
|
+
# Get Company
|
58
|
+
data, status_code, headers = api_instance.hris_companies_get_with_http_info(id, x_account_id, opts)
|
59
59
|
p status_code # => 2xx
|
60
60
|
p headers # => { ... }
|
61
61
|
p data # => <CompanyResult>
|
62
62
|
rescue StackOneHRIS::ApiError => e
|
63
|
-
puts "Error when calling CompaniesApi->
|
63
|
+
puts "Error when calling CompaniesApi->hris_companies_get_with_http_info: #{e}"
|
64
64
|
end
|
65
65
|
```
|
66
66
|
|
@@ -91,11 +91,11 @@ end
|
|
91
91
|
- **Accept**: application/json
|
92
92
|
|
93
93
|
|
94
|
-
##
|
95
|
-
|
96
|
-
> <CompaniesPaginated> companies_list(x_account_id, opts)
|
94
|
+
## hris_companies_list
|
97
95
|
|
96
|
+
> <CompaniesPaginated> hris_companies_list(x_account_id, opts)
|
98
97
|
|
98
|
+
List Companies
|
99
99
|
|
100
100
|
### Examples
|
101
101
|
|
@@ -120,29 +120,29 @@ opts = {
|
|
120
120
|
}
|
121
121
|
|
122
122
|
begin
|
123
|
-
#
|
124
|
-
result = api_instance.
|
123
|
+
# List Companies
|
124
|
+
result = api_instance.hris_companies_list(x_account_id, opts)
|
125
125
|
p result
|
126
126
|
rescue StackOneHRIS::ApiError => e
|
127
|
-
puts "Error when calling CompaniesApi->
|
127
|
+
puts "Error when calling CompaniesApi->hris_companies_list: #{e}"
|
128
128
|
end
|
129
129
|
```
|
130
130
|
|
131
|
-
#### Using the
|
131
|
+
#### Using the hris_companies_list_with_http_info variant
|
132
132
|
|
133
133
|
This returns an Array which contains the response data, status code and headers.
|
134
134
|
|
135
|
-
> <Array(<CompaniesPaginated>, Integer, Hash)>
|
135
|
+
> <Array(<CompaniesPaginated>, Integer, Hash)> hris_companies_list_with_http_info(x_account_id, opts)
|
136
136
|
|
137
137
|
```ruby
|
138
138
|
begin
|
139
|
-
#
|
140
|
-
data, status_code, headers = api_instance.
|
139
|
+
# List Companies
|
140
|
+
data, status_code, headers = api_instance.hris_companies_list_with_http_info(x_account_id, opts)
|
141
141
|
p status_code # => 2xx
|
142
142
|
p headers # => { ... }
|
143
143
|
p data # => <CompaniesPaginated>
|
144
144
|
rescue StackOneHRIS::ApiError => e
|
145
|
-
puts "Error when calling CompaniesApi->
|
145
|
+
puts "Error when calling CompaniesApi->hris_companies_list_with_http_info: #{e}"
|
146
146
|
end
|
147
147
|
```
|
148
148
|
|
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: ["ats","hris","crm","common"],
|
26
|
+
categories: ["ats","hris","crm","marketing","common"],
|
27
27
|
provider: null,
|
28
28
|
origin_owner_id: null,
|
29
29
|
origin_owner_name: null,
|
@@ -18,7 +18,7 @@
|
|
18
18
|
require 'stackone_hris_client'
|
19
19
|
|
20
20
|
instance = StackOneHRIS::ConnectSessionCreate.new(
|
21
|
-
categories: ["ats","hris","crm","common"],
|
21
|
+
categories: ["ats","hris","crm","marketing","common"],
|
22
22
|
provider: null,
|
23
23
|
origin_owner_id: null,
|
24
24
|
origin_owner_name: null,
|
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: ["ats","hris","crm","common"],
|
27
|
+
categories: ["ats","hris","crm","marketing","common"],
|
28
28
|
provider: null,
|
29
29
|
origin_owner_id: null,
|
30
30
|
origin_owner_name: null,
|
data/docs/ConnectSessionsApi.md
CHANGED
@@ -4,15 +4,15 @@ All URIs are relative to *https://api.stackone.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
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 |
|
7
|
+
| [**connect_sessions_authenticate**](ConnectSessionsApi.md#connect_sessions_authenticate) | **POST** /connect_sessions/authenticate | Authenticate Session |
|
8
|
+
| [**connect_sessions_create**](ConnectSessionsApi.md#connect_sessions_create) | **POST** /connect_sessions | Create Session |
|
9
9
|
|
10
10
|
|
11
11
|
## connect_sessions_authenticate
|
12
12
|
|
13
13
|
> <ConnectSession> connect_sessions_authenticate(connect_session_authenticate)
|
14
14
|
|
15
|
-
|
15
|
+
Authenticate Session
|
16
16
|
|
17
17
|
### Examples
|
18
18
|
|
@@ -29,7 +29,7 @@ api_instance = StackOneHRIS::ConnectSessionsApi.new
|
|
29
29
|
connect_session_authenticate = StackOneHRIS::ConnectSessionAuthenticate.new({token: 'token_example'}) # ConnectSessionAuthenticate | The parameters to authenticate
|
30
30
|
|
31
31
|
begin
|
32
|
-
#
|
32
|
+
# Authenticate Session
|
33
33
|
result = api_instance.connect_sessions_authenticate(connect_session_authenticate)
|
34
34
|
p result
|
35
35
|
rescue StackOneHRIS::ApiError => e
|
@@ -45,7 +45,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
45
45
|
|
46
46
|
```ruby
|
47
47
|
begin
|
48
|
-
#
|
48
|
+
# Authenticate Session
|
49
49
|
data, status_code, headers = api_instance.connect_sessions_authenticate_with_http_info(connect_session_authenticate)
|
50
50
|
p status_code # => 2xx
|
51
51
|
p headers # => { ... }
|
@@ -79,7 +79,7 @@ end
|
|
79
79
|
|
80
80
|
> <ConnectSessionToken> connect_sessions_create(connect_session_create)
|
81
81
|
|
82
|
-
|
82
|
+
Create Session
|
83
83
|
|
84
84
|
### Examples
|
85
85
|
|
@@ -96,7 +96,7 @@ api_instance = StackOneHRIS::ConnectSessionsApi.new
|
|
96
96
|
connect_session_create = StackOneHRIS::ConnectSessionCreate.new({origin_owner_id: 'origin_owner_id_example', origin_owner_name: 'origin_owner_name_example'}) # ConnectSessionCreate |
|
97
97
|
|
98
98
|
begin
|
99
|
-
#
|
99
|
+
# Create Session
|
100
100
|
result = api_instance.connect_sessions_create(connect_session_create)
|
101
101
|
p result
|
102
102
|
rescue StackOneHRIS::ApiError => e
|
@@ -112,7 +112,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
112
112
|
|
113
113
|
```ruby
|
114
114
|
begin
|
115
|
-
#
|
115
|
+
# Create Session
|
116
116
|
data, status_code, headers = api_instance.connect_sessions_create_with_http_info(connect_session_create)
|
117
117
|
p status_code # => 2xx
|
118
118
|
p headers # => { ... }
|
data/docs/Employee.md
CHANGED
@@ -14,6 +14,7 @@
|
|
14
14
|
| **date_of_birth** | **Time** | | [optional] |
|
15
15
|
| **birthday** | **Time** | | [optional] |
|
16
16
|
| **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | | [optional] |
|
17
|
+
| **avatar** | [**Image**](Image.md) | | [optional] |
|
17
18
|
| **avatar_url** | **String** | | [optional] |
|
18
19
|
| **personal_email** | **String** | | [optional] |
|
19
20
|
| **personal_phone_number** | **String** | | |
|
@@ -51,6 +52,7 @@ instance = StackOneHRIS::Employee.new(
|
|
51
52
|
date_of_birth: null,
|
52
53
|
birthday: null,
|
53
54
|
marital_status: null,
|
55
|
+
avatar: null,
|
54
56
|
avatar_url: null,
|
55
57
|
personal_email: null,
|
56
58
|
personal_phone_number: null,
|
data/docs/EmployeesApi.md
CHANGED
@@ -4,15 +4,15 @@ All URIs are relative to *https://api.stackone.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
8
|
-
| [**
|
7
|
+
| [**hris_employees_get**](EmployeesApi.md#hris_employees_get) | **GET** /unified/hris/employees/{id} | Get Employee |
|
8
|
+
| [**hris_employees_list**](EmployeesApi.md#hris_employees_list) | **GET** /unified/hris/employees | List Employees |
|
9
9
|
|
10
10
|
|
11
|
-
##
|
12
|
-
|
13
|
-
> <EmployeeResult> employees_get(id, x_account_id, opts)
|
11
|
+
## hris_employees_get
|
14
12
|
|
13
|
+
> <EmployeeResult> hris_employees_get(id, x_account_id, opts)
|
15
14
|
|
15
|
+
Get Employee
|
16
16
|
|
17
17
|
### Examples
|
18
18
|
|
@@ -32,36 +32,36 @@ opts = {
|
|
32
32
|
page: 'page_example', # String | The page number of the results to fetch
|
33
33
|
page_size: 'page_size_example', # String | The number of results per page
|
34
34
|
raw: true, # Boolean | Indicates that the raw request result is returned
|
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', # String | The comma separated list of fields to return in the response (if empty, all fields are returned)
|
35
|
+
fields: 'id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,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', # String | The comma separated list of fields to return in the response (if empty, all fields are returned)
|
36
36
|
sync_token: 'sync_token_example', # String | The sync token to select the only updated results
|
37
37
|
updated_after: 'updated_after_example', # String | Use a string with a date to only select results updated after that given date
|
38
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
|
42
|
-
#
|
43
|
-
result = api_instance.
|
42
|
+
# Get Employee
|
43
|
+
result = api_instance.hris_employees_get(id, x_account_id, opts)
|
44
44
|
p result
|
45
45
|
rescue StackOneHRIS::ApiError => e
|
46
|
-
puts "Error when calling EmployeesApi->
|
46
|
+
puts "Error when calling EmployeesApi->hris_employees_get: #{e}"
|
47
47
|
end
|
48
48
|
```
|
49
49
|
|
50
|
-
#### Using the
|
50
|
+
#### Using the hris_employees_get_with_http_info variant
|
51
51
|
|
52
52
|
This returns an Array which contains the response data, status code and headers.
|
53
53
|
|
54
|
-
> <Array(<EmployeeResult>, Integer, Hash)>
|
54
|
+
> <Array(<EmployeeResult>, Integer, Hash)> hris_employees_get_with_http_info(id, x_account_id, opts)
|
55
55
|
|
56
56
|
```ruby
|
57
57
|
begin
|
58
|
-
#
|
59
|
-
data, status_code, headers = api_instance.
|
58
|
+
# Get Employee
|
59
|
+
data, status_code, headers = api_instance.hris_employees_get_with_http_info(id, x_account_id, opts)
|
60
60
|
p status_code # => 2xx
|
61
61
|
p headers # => { ... }
|
62
62
|
p data # => <EmployeeResult>
|
63
63
|
rescue StackOneHRIS::ApiError => e
|
64
|
-
puts "Error when calling EmployeesApi->
|
64
|
+
puts "Error when calling EmployeesApi->hris_employees_get_with_http_info: #{e}"
|
65
65
|
end
|
66
66
|
```
|
67
67
|
|
@@ -93,11 +93,11 @@ end
|
|
93
93
|
- **Accept**: application/json
|
94
94
|
|
95
95
|
|
96
|
-
##
|
97
|
-
|
98
|
-
> <EmployeesPaginated> employees_list(x_account_id, opts)
|
96
|
+
## hris_employees_list
|
99
97
|
|
98
|
+
> <EmployeesPaginated> hris_employees_list(x_account_id, opts)
|
100
99
|
|
100
|
+
List Employees
|
101
101
|
|
102
102
|
### Examples
|
103
103
|
|
@@ -116,36 +116,36 @@ 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: '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', # String | The comma separated list of fields to return in the response (if empty, all fields are returned)
|
119
|
+
fields: 'id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,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', # String | The comma separated list of fields to return in the response (if empty, all fields are returned)
|
120
120
|
sync_token: 'sync_token_example', # String | The sync token to select the only updated results
|
121
121
|
updated_after: 'updated_after_example', # String | Use a string with a date to only select results updated after that given date
|
122
122
|
expand: 'work_location,home_location,employments' # String | The comma separated list of fields that will be expanded in the response
|
123
123
|
}
|
124
124
|
|
125
125
|
begin
|
126
|
-
#
|
127
|
-
result = api_instance.
|
126
|
+
# List Employees
|
127
|
+
result = api_instance.hris_employees_list(x_account_id, opts)
|
128
128
|
p result
|
129
129
|
rescue StackOneHRIS::ApiError => e
|
130
|
-
puts "Error when calling EmployeesApi->
|
130
|
+
puts "Error when calling EmployeesApi->hris_employees_list: #{e}"
|
131
131
|
end
|
132
132
|
```
|
133
133
|
|
134
|
-
#### Using the
|
134
|
+
#### Using the hris_employees_list_with_http_info variant
|
135
135
|
|
136
136
|
This returns an Array which contains the response data, status code and headers.
|
137
137
|
|
138
|
-
> <Array(<EmployeesPaginated>, Integer, Hash)>
|
138
|
+
> <Array(<EmployeesPaginated>, Integer, Hash)> hris_employees_list_with_http_info(x_account_id, opts)
|
139
139
|
|
140
140
|
```ruby
|
141
141
|
begin
|
142
|
-
#
|
143
|
-
data, status_code, headers = api_instance.
|
142
|
+
# List Employees
|
143
|
+
data, status_code, headers = api_instance.hris_employees_list_with_http_info(x_account_id, opts)
|
144
144
|
p status_code # => 2xx
|
145
145
|
p headers # => { ... }
|
146
146
|
p data # => <EmployeesPaginated>
|
147
147
|
rescue StackOneHRIS::ApiError => e
|
148
|
-
puts "Error when calling EmployeesApi->
|
148
|
+
puts "Error when calling EmployeesApi->hris_employees_list_with_http_info: #{e}"
|
149
149
|
end
|
150
150
|
```
|
151
151
|
|