stackone_hris_client 1.6.0 → 1.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (135) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +31 -5
  4. data/docs/Account.md +1 -1
  5. data/docs/AccountMeta.md +22 -0
  6. data/docs/AccountsApi.md +70 -2
  7. data/docs/CompaniesApi.md +1 -1
  8. data/docs/ConnectSessionsApi.md +1 -1
  9. data/docs/CreateEmployeeResult.md +22 -0
  10. data/docs/Employee.md +56 -54
  11. data/docs/EmployeeApiModel.md +80 -0
  12. data/docs/EmployeeApiModelAvatar.md +20 -0
  13. data/docs/EmployeeApiModelEmploymentStatus.md +20 -0
  14. data/docs/EmployeeApiModelEmploymentType.md +20 -0
  15. data/docs/EmployeeApiModelEthnicity.md +20 -0
  16. data/docs/EmployeeApiModelGender.md +20 -0
  17. data/docs/EmployeeApiModelHomeLocation.md +38 -0
  18. data/docs/EmployeeApiModelMaritalStatus.md +20 -0
  19. data/docs/EmployeeApiModelWorkLocation.md +38 -0
  20. data/docs/EmployeeCustomFieldTypeEnum.md +20 -0
  21. data/docs/EmployeeCustomFields.md +30 -0
  22. data/docs/EmployeeCustomFieldsType.md +20 -0
  23. data/docs/EmployeeResult.md +1 -1
  24. data/docs/EmployeesApi.md +219 -5
  25. data/docs/EmployeesPaginated.md +1 -1
  26. data/docs/Employment.md +17 -15
  27. data/docs/EmploymentEmploymentContractType.md +20 -0
  28. data/docs/EmploymentEmploymentType.md +20 -0
  29. data/docs/EmploymentPayFrequency.md +20 -0
  30. data/docs/EmploymentPayPeriod.md +20 -0
  31. data/docs/EmploymentScheduleTypeEnum.md +20 -0
  32. data/docs/EmploymentsApi.md +3 -3
  33. data/docs/HrisCreateEmployeeRequestDto.md +80 -0
  34. data/docs/Location.md +20 -20
  35. data/docs/LocationCountry.md +20 -0
  36. data/docs/LocationLocationType.md +20 -0
  37. data/docs/LocationsApi.md +1 -1
  38. data/gem-config.yml +2 -2
  39. data/generate_gem.sh +0 -0
  40. data/lib/stackone_hris_client/api/accounts_api.rb +61 -0
  41. data/lib/stackone_hris_client/api/employees_api.rb +231 -0
  42. data/lib/stackone_hris_client/models/account.rb +0 -5
  43. data/lib/stackone_hris_client/models/account_meta.rb +284 -0
  44. data/lib/stackone_hris_client/models/country_code_enum.rb +0 -6
  45. data/lib/stackone_hris_client/models/create_employee_result.rb +250 -0
  46. data/lib/stackone_hris_client/models/employee.rb +110 -126
  47. data/lib/stackone_hris_client/models/employee_api_model.rb +523 -0
  48. data/lib/stackone_hris_client/models/employee_api_model_avatar.rb +234 -0
  49. data/lib/stackone_hris_client/models/employee_api_model_employment_status.rb +272 -0
  50. data/lib/stackone_hris_client/models/employee_api_model_employment_type.rb +272 -0
  51. data/lib/stackone_hris_client/models/employee_api_model_ethnicity.rb +272 -0
  52. data/lib/stackone_hris_client/models/employee_api_model_gender.rb +272 -0
  53. data/lib/stackone_hris_client/models/employee_api_model_home_location.rb +324 -0
  54. data/lib/stackone_hris_client/models/employee_api_model_marital_status.rb +272 -0
  55. data/lib/stackone_hris_client/models/employee_api_model_work_location.rb +324 -0
  56. data/lib/stackone_hris_client/models/employee_custom_field_type_enum.rb +264 -0
  57. data/lib/stackone_hris_client/models/employee_custom_fields.rb +279 -0
  58. data/lib/stackone_hris_client/models/employee_custom_fields_type.rb +272 -0
  59. data/lib/stackone_hris_client/models/employment.rb +21 -6
  60. data/lib/stackone_hris_client/models/employment_employment_contract_type.rb +272 -0
  61. data/lib/stackone_hris_client/models/employment_employment_type.rb +272 -0
  62. data/lib/stackone_hris_client/models/employment_pay_frequency.rb +272 -0
  63. data/lib/stackone_hris_client/models/employment_pay_period.rb +272 -0
  64. data/lib/stackone_hris_client/models/employment_schedule_type_enum.rb +264 -0
  65. data/lib/stackone_hris_client/models/employment_status_enum.rb +0 -6
  66. data/lib/stackone_hris_client/models/employment_type_enum.rb +0 -6
  67. data/lib/stackone_hris_client/models/ethnicity_enum.rb +0 -6
  68. data/lib/stackone_hris_client/models/gender_enum.rb +0 -6
  69. data/lib/stackone_hris_client/models/hris_create_employee_request_dto.rb +523 -0
  70. data/lib/stackone_hris_client/models/location.rb +11 -7
  71. data/lib/stackone_hris_client/models/location_country.rb +272 -0
  72. data/lib/stackone_hris_client/models/location_location_type.rb +272 -0
  73. data/lib/stackone_hris_client/models/location_type_enum.rb +0 -6
  74. data/lib/stackone_hris_client/models/marital_status_enum.rb +0 -6
  75. data/lib/stackone_hris_client/models/pay_frequency_enum.rb +0 -6
  76. data/lib/stackone_hris_client/models/pay_period_enum.rb +0 -6
  77. data/lib/stackone_hris_client/version.rb +1 -1
  78. data/lib/stackone_hris_client.rb +22 -0
  79. data/spec/api/accounts_api_spec.rb +30 -8
  80. data/spec/api/companies_api_spec.rb +13 -13
  81. data/spec/api/connect_sessions_api_spec.rb +8 -8
  82. data/spec/api/employees_api_spec.rb +60 -18
  83. data/spec/api/employments_api_spec.rb +13 -13
  84. data/spec/api/locations_api_spec.rb +9 -9
  85. data/spec/models/account_meta_spec.rb +50 -0
  86. data/spec/models/account_spec.rb +18 -12
  87. data/spec/models/companies_paginated_spec.rb +4 -4
  88. data/spec/models/company_result_spec.rb +3 -3
  89. data/spec/models/company_spec.rb +4 -4
  90. data/spec/models/connect_session_authenticate_spec.rb +5 -5
  91. data/spec/models/connect_session_create_spec.rb +17 -11
  92. data/spec/models/connect_session_spec.rb +14 -14
  93. data/spec/models/connect_session_token_spec.rb +15 -15
  94. data/spec/models/country_code_enum_spec.rb +4 -4
  95. data/spec/models/create_employee_result_spec.rb +46 -0
  96. data/spec/models/employee.rb +220 -0
  97. data/spec/models/employee_api_model_avatar_spec.rb +40 -0
  98. data/spec/models/employee_api_model_employment_status_spec.rb +44 -0
  99. data/spec/models/employee_api_model_employment_type_spec.rb +44 -0
  100. data/spec/models/employee_api_model_ethnicity_spec.rb +44 -0
  101. data/spec/models/employee_api_model_gender_spec.rb +44 -0
  102. data/spec/models/employee_api_model_home_location_spec.rb +94 -0
  103. data/spec/models/employee_api_model_marital_status_spec.rb +44 -0
  104. data/spec/models/employee_api_model_spec.rb +220 -0
  105. data/spec/models/employee_api_model_work_location_spec.rb +94 -0
  106. data/spec/models/employee_custom_field_type_enum_spec.rb +44 -0
  107. data/spec/models/employee_custom_fields_spec.rb +70 -0
  108. data/spec/models/employee_custom_fields_type_spec.rb +44 -0
  109. data/spec/models/employee_result_spec.rb +6 -6
  110. data/spec/models/employees_paginated_spec.rb +7 -7
  111. data/spec/models/employment_employment_contract_type_spec.rb +44 -0
  112. data/spec/models/employment_employment_type_spec.rb +44 -0
  113. data/spec/models/employment_pay_frequency_spec.rb +44 -0
  114. data/spec/models/employment_pay_period_spec.rb +44 -0
  115. data/spec/models/employment_result_spec.rb +3 -3
  116. data/spec/models/employment_schedule_type_enum_spec.rb +44 -0
  117. data/spec/models/employment_spec.rb +16 -10
  118. data/spec/models/employment_status_enum_spec.rb +4 -4
  119. data/spec/models/employment_type_enum_spec.rb +4 -4
  120. data/spec/models/employments_paginated_spec.rb +4 -4
  121. data/spec/models/ethnicity_enum_spec.rb +4 -4
  122. data/spec/models/gender_enum_spec.rb +4 -4
  123. data/spec/models/hris_create_employee_request_dto_spec.rb +220 -0
  124. data/spec/models/image_spec.rb +3 -3
  125. data/spec/models/location_country_spec.rb +44 -0
  126. data/spec/models/location_location_type_spec.rb +44 -0
  127. data/spec/models/location_result_spec.rb +3 -3
  128. data/spec/models/location_spec.rb +12 -12
  129. data/spec/models/location_type_enum_spec.rb +3 -3
  130. data/spec/models/locations_paginated_spec.rb +4 -4
  131. data/spec/models/marital_status_enum_spec.rb +4 -4
  132. data/spec/models/pay_frequency_enum_spec.rb +4 -4
  133. data/spec/models/pay_period_enum_spec.rb +3 -3
  134. metadata +92 -4
  135. data/spec/models/employee_spec.rb +0 -124
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d4431aca0c3b558fa76dd1202e71afc8ae4dc23f2511435accc4eb13a892d161
4
- data.tar.gz: 1cbd10f52dadc7f6d8252ff1ff6eaca859371dc639d0b966beaf0d4ff196a97f
3
+ metadata.gz: b3c7376b8d5de9ee4d5c49add57bad3f2177409dbd05258f5fafd73901980c8c
4
+ data.tar.gz: 89d15eb34ed71ca8d8e398daa2b9f9e98da7ae720a2fef8bf97a5aff004fd701
5
5
  SHA512:
6
- metadata.gz: b02d3957a16fb71c2f8d591fa3300a6726c6d81738fc47f5e31ba7ed4bbcf92cb27df018ff20f574cb632b084c95e08e60dd39e3655bd962317bbad105e2ec36
7
- data.tar.gz: e483898527db7c1d5cb66e30105a08ac21d289e9ace5b9fa4192d34348340f2995244284d02e1012b264659ce545cc60c56d29cf7267c55048d058844e3da5b5
6
+ metadata.gz: 562634c17972619acba8a317dc15de1ec2aab64cc6b2b2a4b2d4b8614d40633913460adf014820260c472168952425fd8a930c8ff8b0fe9d4c439b4e653320cb
7
+ data.tar.gz: 36c12d443cfe04a9e918a809d4df2075d5873e16662555bd35a2a12fdf04b6a081df1615d3021b7dc42219344f1df34080614c945654d06dbcbf76f68a04e247
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- stackone_hris_client (1.6.0)
4
+ stackone_hris_client (1.7.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -70,4 +70,4 @@ DEPENDENCIES
70
70
  stackone_hris_client!
71
71
 
72
72
  BUNDLED WITH
73
- 2.4.7
73
+ 2.4.13
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.6.0
10
+ - Package version: 1.7.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.6.0.gem
26
+ gem install ./stackone_hris_client-1.7.0.gem
27
27
  ```
28
28
 
29
- (for development, run `gem install --dev ./stackone_hris_client-1.6.0.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./stackone_hris_client-1.7.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.6.0'
35
+ gem 'stackone_hris_client', '~> 1.7.0'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -63,7 +63,7 @@ StackOneHRIS.configure do |config|
63
63
  end
64
64
 
65
65
  api_instance = StackOneHRIS::AccountsApi.new
66
- id = 'id_example' # String |
66
+ id = 'id_example' # String |
67
67
 
68
68
  begin
69
69
  #Delete Account
@@ -84,10 +84,14 @@ Class | Method | HTTP request | Description
84
84
  *StackOneHRIS::AccountsApi* | [**accounts_delete**](docs/AccountsApi.md#accounts_delete) | **DELETE** /accounts/{id} | Delete Account
85
85
  *StackOneHRIS::AccountsApi* | [**accounts_get**](docs/AccountsApi.md#accounts_get) | **GET** /accounts/{id} | Get Account
86
86
  *StackOneHRIS::AccountsApi* | [**accounts_list**](docs/AccountsApi.md#accounts_list) | **GET** /accounts | List Accounts
87
+ *StackOneHRIS::AccountsApi* | [**accounts_meta_get**](docs/AccountsApi.md#accounts_meta_get) | **GET** /accounts/{id}/meta | Get meta information of the account
87
88
  *StackOneHRIS::CompaniesApi* | [**hris_companies_get**](docs/CompaniesApi.md#hris_companies_get) | **GET** /unified/hris/companies/{id} | Get Company
88
89
  *StackOneHRIS::CompaniesApi* | [**hris_companies_list**](docs/CompaniesApi.md#hris_companies_list) | **GET** /unified/hris/companies | List Companies
89
90
  *StackOneHRIS::ConnectSessionsApi* | [**connect_sessions_authenticate**](docs/ConnectSessionsApi.md#connect_sessions_authenticate) | **POST** /connect_sessions/authenticate | Authenticate Session
90
91
  *StackOneHRIS::ConnectSessionsApi* | [**connect_sessions_create**](docs/ConnectSessionsApi.md#connect_sessions_create) | **POST** /connect_sessions | Create Session
92
+ *StackOneHRIS::EmployeesApi* | [**employee_create**](docs/EmployeesApi.md#employee_create) | **POST** /unified/hris/employees | Creates an employee
93
+ *StackOneHRIS::EmployeesApi* | [**employee_replace**](docs/EmployeesApi.md#employee_replace) | **PUT** /unified/hris/employees/{id} | Replaces an employee
94
+ *StackOneHRIS::EmployeesApi* | [**employee_update**](docs/EmployeesApi.md#employee_update) | **PATCH** /unified/hris/employees/{id} | Updates an employee
91
95
  *StackOneHRIS::EmployeesApi* | [**hris_employees_get**](docs/EmployeesApi.md#hris_employees_get) | **GET** /unified/hris/employees/{id} | Get Employee
92
96
  *StackOneHRIS::EmployeesApi* | [**hris_employees_list**](docs/EmployeesApi.md#hris_employees_list) | **GET** /unified/hris/employees | List Employees
93
97
  *StackOneHRIS::EmploymentsApi* | [**hris_employments_get**](docs/EmploymentsApi.md#hris_employments_get) | **GET** /unified/hris/employments/{id} | Get Employment
@@ -99,6 +103,7 @@ Class | Method | HTTP request | Description
99
103
  ## Documentation for Models
100
104
 
101
105
  - [StackOneHRIS::Account](docs/Account.md)
106
+ - [StackOneHRIS::AccountMeta](docs/AccountMeta.md)
102
107
  - [StackOneHRIS::CompaniesPaginated](docs/CompaniesPaginated.md)
103
108
  - [StackOneHRIS::Company](docs/Company.md)
104
109
  - [StackOneHRIS::CompanyResult](docs/CompanyResult.md)
@@ -107,18 +112,39 @@ Class | Method | HTTP request | Description
107
112
  - [StackOneHRIS::ConnectSessionCreate](docs/ConnectSessionCreate.md)
108
113
  - [StackOneHRIS::ConnectSessionToken](docs/ConnectSessionToken.md)
109
114
  - [StackOneHRIS::CountryCodeEnum](docs/CountryCodeEnum.md)
115
+ - [StackOneHRIS::CreateEmployeeResult](docs/CreateEmployeeResult.md)
110
116
  - [StackOneHRIS::Employee](docs/Employee.md)
117
+ - [StackOneHRIS::EmployeeApiModel](docs/EmployeeApiModel.md)
118
+ - [StackOneHRIS::EmployeeApiModelAvatar](docs/EmployeeApiModelAvatar.md)
119
+ - [StackOneHRIS::EmployeeApiModelEmploymentStatus](docs/EmployeeApiModelEmploymentStatus.md)
120
+ - [StackOneHRIS::EmployeeApiModelEmploymentType](docs/EmployeeApiModelEmploymentType.md)
121
+ - [StackOneHRIS::EmployeeApiModelEthnicity](docs/EmployeeApiModelEthnicity.md)
122
+ - [StackOneHRIS::EmployeeApiModelGender](docs/EmployeeApiModelGender.md)
123
+ - [StackOneHRIS::EmployeeApiModelHomeLocation](docs/EmployeeApiModelHomeLocation.md)
124
+ - [StackOneHRIS::EmployeeApiModelMaritalStatus](docs/EmployeeApiModelMaritalStatus.md)
125
+ - [StackOneHRIS::EmployeeApiModelWorkLocation](docs/EmployeeApiModelWorkLocation.md)
126
+ - [StackOneHRIS::EmployeeCustomFieldTypeEnum](docs/EmployeeCustomFieldTypeEnum.md)
127
+ - [StackOneHRIS::EmployeeCustomFields](docs/EmployeeCustomFields.md)
128
+ - [StackOneHRIS::EmployeeCustomFieldsType](docs/EmployeeCustomFieldsType.md)
111
129
  - [StackOneHRIS::EmployeeResult](docs/EmployeeResult.md)
112
130
  - [StackOneHRIS::EmployeesPaginated](docs/EmployeesPaginated.md)
113
131
  - [StackOneHRIS::Employment](docs/Employment.md)
132
+ - [StackOneHRIS::EmploymentEmploymentContractType](docs/EmploymentEmploymentContractType.md)
133
+ - [StackOneHRIS::EmploymentEmploymentType](docs/EmploymentEmploymentType.md)
134
+ - [StackOneHRIS::EmploymentPayFrequency](docs/EmploymentPayFrequency.md)
135
+ - [StackOneHRIS::EmploymentPayPeriod](docs/EmploymentPayPeriod.md)
114
136
  - [StackOneHRIS::EmploymentResult](docs/EmploymentResult.md)
137
+ - [StackOneHRIS::EmploymentScheduleTypeEnum](docs/EmploymentScheduleTypeEnum.md)
115
138
  - [StackOneHRIS::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
116
139
  - [StackOneHRIS::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
117
140
  - [StackOneHRIS::EmploymentsPaginated](docs/EmploymentsPaginated.md)
118
141
  - [StackOneHRIS::EthnicityEnum](docs/EthnicityEnum.md)
119
142
  - [StackOneHRIS::GenderEnum](docs/GenderEnum.md)
143
+ - [StackOneHRIS::HrisCreateEmployeeRequestDto](docs/HrisCreateEmployeeRequestDto.md)
120
144
  - [StackOneHRIS::Image](docs/Image.md)
121
145
  - [StackOneHRIS::Location](docs/Location.md)
146
+ - [StackOneHRIS::LocationCountry](docs/LocationCountry.md)
147
+ - [StackOneHRIS::LocationLocationType](docs/LocationLocationType.md)
122
148
  - [StackOneHRIS::LocationResult](docs/LocationResult.md)
123
149
  - [StackOneHRIS::LocationTypeEnum](docs/LocationTypeEnum.md)
124
150
  - [StackOneHRIS::LocationsPaginated](docs/LocationsPaginated.md)
data/docs/Account.md CHANGED
@@ -10,7 +10,7 @@
10
10
  | **origin_owner_id** | **String** | | |
11
11
  | **origin_owner_name** | **String** | | |
12
12
  | **origin_username** | **String** | | |
13
- | **credentials** | **Object** | | |
13
+ | **credentials** | **Object** | | [optional] |
14
14
  | **created_at** | **Time** | | |
15
15
  | **updated_at** | **Time** | | |
16
16
 
@@ -0,0 +1,22 @@
1
+ # StackOneHRIS::AccountMeta
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **provider** | **String** | | |
8
+ | **category** | **String** | | |
9
+ | **models** | **Object** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'stackone_hris_client'
15
+
16
+ instance = StackOneHRIS::AccountMeta.new(
17
+ provider: null,
18
+ category: null,
19
+ models: null
20
+ )
21
+ ```
22
+
data/docs/AccountsApi.md CHANGED
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.stackone.com*
7
7
  | [**accounts_delete**](AccountsApi.md#accounts_delete) | **DELETE** /accounts/{id} | Delete Account |
8
8
  | [**accounts_get**](AccountsApi.md#accounts_get) | **GET** /accounts/{id} | Get Account |
9
9
  | [**accounts_list**](AccountsApi.md#accounts_list) | **GET** /accounts | List Accounts |
10
+ | [**accounts_meta_get**](AccountsApi.md#accounts_meta_get) | **GET** /accounts/{id}/meta | Get meta information of the account |
10
11
 
11
12
 
12
13
  ## accounts_delete
@@ -27,7 +28,7 @@ StackOneHRIS.configure do |config|
27
28
  end
28
29
 
29
30
  api_instance = StackOneHRIS::AccountsApi.new
30
- id = 'id_example' # String |
31
+ id = 'id_example' # String |
31
32
 
32
33
  begin
33
34
  # Delete Account
@@ -94,7 +95,7 @@ StackOneHRIS.configure do |config|
94
95
  end
95
96
 
96
97
  api_instance = StackOneHRIS::AccountsApi.new
97
- id = 'id_example' # String |
98
+ id = 'id_example' # String |
98
99
 
99
100
  begin
100
101
  # Get Account
@@ -213,3 +214,70 @@ end
213
214
  - **Content-Type**: Not defined
214
215
  - **Accept**: application/json
215
216
 
217
+
218
+ ## accounts_meta_get
219
+
220
+ > <AccountMeta> accounts_meta_get(id)
221
+
222
+ Get meta information of the account
223
+
224
+ ### Examples
225
+
226
+ ```ruby
227
+ require 'time'
228
+ require 'stackone_hris_client'
229
+ # setup authorization
230
+ StackOneHRIS.configure do |config|
231
+ # Configure HTTP basic authorization: basic
232
+ config.api_key_token = 'YOUR API KEY'
233
+ end
234
+
235
+ api_instance = StackOneHRIS::AccountsApi.new
236
+ id = 'id_example' # String |
237
+
238
+ begin
239
+ # Get meta information of the account
240
+ result = api_instance.accounts_meta_get(id)
241
+ p result
242
+ rescue StackOneHRIS::ApiError => e
243
+ puts "Error when calling AccountsApi->accounts_meta_get: #{e}"
244
+ end
245
+ ```
246
+
247
+ #### Using the accounts_meta_get_with_http_info variant
248
+
249
+ This returns an Array which contains the response data, status code and headers.
250
+
251
+ > <Array(<AccountMeta>, Integer, Hash)> accounts_meta_get_with_http_info(id)
252
+
253
+ ```ruby
254
+ begin
255
+ # Get meta information of the account
256
+ data, status_code, headers = api_instance.accounts_meta_get_with_http_info(id)
257
+ p status_code # => 2xx
258
+ p headers # => { ... }
259
+ p data # => <AccountMeta>
260
+ rescue StackOneHRIS::ApiError => e
261
+ puts "Error when calling AccountsApi->accounts_meta_get_with_http_info: #{e}"
262
+ end
263
+ ```
264
+
265
+ ### Parameters
266
+
267
+ | Name | Type | Description | Notes |
268
+ | ---- | ---- | ----------- | ----- |
269
+ | **id** | **String** | | |
270
+
271
+ ### Return type
272
+
273
+ [**AccountMeta**](AccountMeta.md)
274
+
275
+ ### Authorization
276
+
277
+ [basic](../README.md#basic)
278
+
279
+ ### HTTP request headers
280
+
281
+ - **Content-Type**: Not defined
282
+ - **Accept**: application/json
283
+
data/docs/CompaniesApi.md CHANGED
@@ -26,7 +26,7 @@ StackOneHRIS.configure do |config|
26
26
  end
27
27
 
28
28
  api_instance = StackOneHRIS::CompaniesApi.new
29
- id = 'id_example' # String |
29
+ id = 'id_example' # String |
30
30
  x_account_id = 'x_account_id_example' # String | The account identifier
31
31
  opts = {
32
32
  page: 'page_example', # String | The page number of the results to fetch
@@ -93,7 +93,7 @@ StackOneHRIS.configure do |config|
93
93
  end
94
94
 
95
95
  api_instance = StackOneHRIS::ConnectSessionsApi.new
96
- connect_session_create = StackOneHRIS::ConnectSessionCreate.new({origin_owner_id: 'origin_owner_id_example', origin_owner_name: 'origin_owner_name_example'}) # ConnectSessionCreate |
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
@@ -0,0 +1,22 @@
1
+ # StackOneHRIS::CreateEmployeeResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status_code** | **Float** | | |
8
+ | **message** | **String** | | |
9
+ | **timestamp** | **Time** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'stackone_hris_client'
15
+
16
+ instance = StackOneHRIS::CreateEmployeeResult.new(
17
+ status_code: null,
18
+ message: null,
19
+ timestamp: null
20
+ )
21
+ ```
22
+
data/docs/Employee.md CHANGED
@@ -4,37 +4,38 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | |
8
- | **first_name** | **String** | | |
9
- | **last_name** | **String** | | |
10
- | **name** | **String** | | |
11
- | **display_name** | **String** | | |
12
- | **gender** | [**GenderEnum**](GenderEnum.md) | | |
13
- | **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | | [optional] |
14
- | **date_of_birth** | **Time** | | [optional] |
15
- | **birthday** | **Time** | | [optional] |
16
- | **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | | [optional] |
17
- | **avatar** | [**Image**](Image.md) | | [optional] |
18
- | **avatar_url** | **String** | | [optional] |
19
- | **personal_email** | **String** | | [optional] |
20
- | **personal_phone_number** | **String** | | |
21
- | **work_email** | **String** | | |
22
- | **work_phone_number** | **String** | | |
23
- | **job_title** | **String** | | [optional] |
24
- | **department** | **String** | | |
25
- | **manager_id** | **String** | | [optional] |
26
- | **hire_date** | **Time** | | [optional] |
27
- | **start_date** | **Time** | | [optional] |
28
- | **tenure** | **Float** | | [optional] |
29
- | **work_anniversary** | **Time** | | [optional] |
30
- | **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | | [optional] |
31
- | **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | | [optional] |
32
- | **termination_date** | **Time** | | [optional] |
33
- | **company_name** | **String** | | [optional] |
34
- | **home_location** | [**Location**](Location.md) | | [optional] |
35
- | **work_location** | [**Location**](Location.md) | | [optional] |
36
- | **company** | **String** | | [optional] |
37
- | **employments** | [**Array&lt;Employment&gt;**](Employment.md) | | [optional] |
7
+ | **id** | **String** | The employee ID | [optional] |
8
+ | **first_name** | **String** | The employee first name | [optional] |
9
+ | **last_name** | **String** | The employee last name | [optional] |
10
+ | **name** | **String** | The employee name | [optional] |
11
+ | **display_name** | **String** | The employee display name | [optional] |
12
+ | **avatar_url** | **String** | The employee avatar Url | [optional] |
13
+ | **personal_email** | **String** | The employee personal email | [optional] |
14
+ | **personal_phone_number** | **String** | The employee personal phone number | [optional] |
15
+ | **work_email** | **String** | The employee work email | [optional] |
16
+ | **work_phone_number** | **String** | The employee work phone number | [optional] |
17
+ | **job_title** | **String** | The employee job title | [optional] |
18
+ | **department** | **String** | The employee department | [optional] |
19
+ | **manager_id** | **String** | The employee manager ID | [optional] |
20
+ | **gender** | [**EmployeeApiModelGender**](EmployeeApiModelGender.md) | | [optional] |
21
+ | **ethnicity** | [**EmployeeApiModelEthnicity**](EmployeeApiModelEthnicity.md) | | [optional] |
22
+ | **date_of_birth** | **String** | The employee date_of_birth | [optional] |
23
+ | **birthday** | **String** | The employee birthday | [optional] |
24
+ | **marital_status** | [**EmployeeApiModelMaritalStatus**](EmployeeApiModelMaritalStatus.md) | | [optional] |
25
+ | **avatar** | [**EmployeeApiModelAvatar**](EmployeeApiModelAvatar.md) | | [optional] |
26
+ | **hire_date** | **String** | The employee hire date | [optional] |
27
+ | **start_date** | **String** | The employee start date | [optional] |
28
+ | **tenure** | **String** | The employee tenure | [optional] |
29
+ | **work_anniversary** | **String** | The employee work anniversary | [optional] |
30
+ | **employment_type** | [**EmployeeApiModelEmploymentType**](EmployeeApiModelEmploymentType.md) | | [optional] |
31
+ | **employment_contract_type** | [**EmploymentEmploymentContractType**](EmploymentEmploymentContractType.md) | | [optional] |
32
+ | **employment_status** | [**EmployeeApiModelEmploymentStatus**](EmployeeApiModelEmploymentStatus.md) | | [optional] |
33
+ | **termination_date** | **String** | The employee termination date | [optional] |
34
+ | **home_location** | [**EmployeeApiModelHomeLocation**](EmployeeApiModelHomeLocation.md) | | [optional] |
35
+ | **work_location** | [**EmployeeApiModelWorkLocation**](EmployeeApiModelWorkLocation.md) | | [optional] |
36
+ | **company_name** | **String** | The employee company name | [optional] |
37
+ | **employments** | [**Array&lt;Employment&gt;**](Employment.md) | The employee employments | [optional] |
38
+ | **custom_fields** | [**Array&lt;EmployeeCustomFields&gt;**](EmployeeCustomFields.md) | The employee custom fields | [optional] |
38
39
 
39
40
  ## Example
40
41
 
@@ -42,37 +43,38 @@
42
43
  require 'stackone_hris_client'
43
44
 
44
45
  instance = StackOneHRIS::Employee.new(
45
- id: null,
46
- first_name: null,
47
- last_name: null,
48
- name: null,
49
- display_name: null,
46
+ id: 1687-3,
47
+ first_name: Issac,
48
+ last_name: Newton,
49
+ name: Issac Newton,
50
+ display_name: Sir Issac Newton,
51
+ avatar_url: https://example.com/avatar.png,
52
+ personal_email: isaac.newton@example.com,
53
+ personal_phone_number: +1234567890,
54
+ work_email: newton@example.com,
55
+ work_phone_number: +1234567890,
56
+ job_title: Physicist,
57
+ department: Physics,
58
+ manager_id: 67890,
50
59
  gender: null,
51
60
  ethnicity: null,
52
- date_of_birth: null,
53
- birthday: null,
61
+ date_of_birth: 1990-01-01,
62
+ birthday: 2023-06-14T00:00:00Z,
54
63
  marital_status: null,
55
64
  avatar: null,
56
- avatar_url: null,
57
- personal_email: null,
58
- personal_phone_number: null,
59
- work_email: null,
60
- work_phone_number: null,
61
- job_title: null,
62
- department: null,
63
- manager_id: null,
64
- hire_date: null,
65
- start_date: null,
66
- tenure: null,
67
- work_anniversary: null,
65
+ hire_date: 2022-01-01,
66
+ start_date: 2022-01-01,
67
+ tenure: 2,
68
+ work_anniversary: 2022-06-14T00:00:00Z,
68
69
  employment_type: null,
70
+ employment_contract_type: null,
69
71
  employment_status: null,
70
- termination_date: null,
71
- company_name: null,
72
+ termination_date: 2023-06-14T00:00:00Z,
72
73
  home_location: null,
73
74
  work_location: null,
74
- company: null,
75
- employments: null
75
+ company_name: Example Corp,
76
+ employments: null,
77
+ custom_fields: null
76
78
  )
77
79
  ```
78
80
 
@@ -0,0 +1,80 @@
1
+ # StackOneHRIS::EmployeeApiModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The employee ID | [optional] |
8
+ | **first_name** | **String** | The employee first name | [optional] |
9
+ | **last_name** | **String** | The employee last name | [optional] |
10
+ | **name** | **String** | The employee name | [optional] |
11
+ | **display_name** | **String** | The employee display name | [optional] |
12
+ | **avatar_url** | **String** | The employee avatar Url | [optional] |
13
+ | **personal_email** | **String** | The employee personal email | [optional] |
14
+ | **personal_phone_number** | **String** | The employee personal phone number | [optional] |
15
+ | **work_email** | **String** | The employee work email | [optional] |
16
+ | **work_phone_number** | **String** | The employee work phone number | [optional] |
17
+ | **job_title** | **String** | The employee job title | [optional] |
18
+ | **department** | **String** | The employee department | [optional] |
19
+ | **manager_id** | **String** | The employee manager ID | [optional] |
20
+ | **gender** | [**EmployeeApiModelGender**](EmployeeApiModelGender.md) | | [optional] |
21
+ | **ethnicity** | [**EmployeeApiModelEthnicity**](EmployeeApiModelEthnicity.md) | | [optional] |
22
+ | **date_of_birth** | **String** | The employee date_of_birth | [optional] |
23
+ | **birthday** | **String** | The employee birthday | [optional] |
24
+ | **marital_status** | [**EmployeeApiModelMaritalStatus**](EmployeeApiModelMaritalStatus.md) | | [optional] |
25
+ | **avatar** | [**EmployeeApiModelAvatar**](EmployeeApiModelAvatar.md) | | [optional] |
26
+ | **hire_date** | **String** | The employee hire date | [optional] |
27
+ | **start_date** | **String** | The employee start date | [optional] |
28
+ | **tenure** | **String** | The employee tenure | [optional] |
29
+ | **work_anniversary** | **String** | The employee work anniversary | [optional] |
30
+ | **employment_type** | [**EmployeeApiModelEmploymentType**](EmployeeApiModelEmploymentType.md) | | [optional] |
31
+ | **employment_contract_type** | [**EmploymentEmploymentContractType**](EmploymentEmploymentContractType.md) | | [optional] |
32
+ | **employment_status** | [**EmployeeApiModelEmploymentStatus**](EmployeeApiModelEmploymentStatus.md) | | [optional] |
33
+ | **termination_date** | **String** | The employee termination date | [optional] |
34
+ | **home_location** | [**EmployeeApiModelHomeLocation**](EmployeeApiModelHomeLocation.md) | | [optional] |
35
+ | **work_location** | [**EmployeeApiModelWorkLocation**](EmployeeApiModelWorkLocation.md) | | [optional] |
36
+ | **company_name** | **String** | The employee company name | [optional] |
37
+ | **employments** | [**Array&lt;Employment&gt;**](Employment.md) | The employee employments | [optional] |
38
+ | **custom_fields** | [**Array&lt;EmployeeCustomFields&gt;**](EmployeeCustomFields.md) | The employee custom fields | [optional] |
39
+
40
+ ## Example
41
+
42
+ ```ruby
43
+ require 'stackone_hris_client'
44
+
45
+ instance = StackOneHRIS::EmployeeApiModel.new(
46
+ id: 1687-3,
47
+ first_name: Issac,
48
+ last_name: Newton,
49
+ name: Issac Newton,
50
+ display_name: Sir Issac Newton,
51
+ avatar_url: https://example.com/avatar.png,
52
+ personal_email: isaac.newton@example.com,
53
+ personal_phone_number: +1234567890,
54
+ work_email: newton@example.com,
55
+ work_phone_number: +1234567890,
56
+ job_title: Physicist,
57
+ department: Physics,
58
+ manager_id: 67890,
59
+ gender: null,
60
+ ethnicity: null,
61
+ date_of_birth: 1990-01-01,
62
+ birthday: 2023-06-14T00:00:00Z,
63
+ marital_status: null,
64
+ avatar: null,
65
+ hire_date: 2022-01-01,
66
+ start_date: 2022-01-01,
67
+ tenure: 2,
68
+ work_anniversary: 2022-06-14T00:00:00Z,
69
+ employment_type: null,
70
+ employment_contract_type: null,
71
+ employment_status: null,
72
+ termination_date: 2023-06-14T00:00:00Z,
73
+ home_location: null,
74
+ work_location: null,
75
+ company_name: Example Corp,
76
+ employments: null,
77
+ custom_fields: null
78
+ )
79
+ ```
80
+
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EmployeeApiModelAvatar
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **url** | **String** | | [optional] |
8
+ | **base64** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::EmployeeApiModelAvatar.new(
16
+ url: null,
17
+ base64: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EmployeeApiModelEmploymentStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | |
8
+ | **source_value** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::EmployeeApiModelEmploymentStatus.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EmployeeApiModelEmploymentType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | |
8
+ | **source_value** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::EmployeeApiModelEmploymentType.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EmployeeApiModelEthnicity
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | |
8
+ | **source_value** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::EmployeeApiModelEthnicity.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EmployeeApiModelGender
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | |
8
+ | **source_value** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'stackone_hris_client'
14
+
15
+ instance = StackOneHRIS::EmployeeApiModelGender.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,38 @@
1
+ # StackOneHRIS::EmployeeApiModelHomeLocation
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The unique ID of the location | [optional] |
8
+ | **employee_id** | **String** | The employee ID | [optional] |
9
+ | **name** | **String** | The name of the location | [optional] |
10
+ | **phone_number** | **String** | The phone number of the location | [optional] |
11
+ | **street_1** | **String** | The first line of the address | [optional] |
12
+ | **street_2** | **String** | The second line of the address | [optional] |
13
+ | **city** | **String** | The city where the location is situated | [optional] |
14
+ | **state** | **String** | The state where the location is situated | [optional] |
15
+ | **zip_code** | **String** | The ZIP code/Postal code of the location | [optional] |
16
+ | **country** | [**LocationCountry**](LocationCountry.md) | | [optional] |
17
+ | **location_type** | [**LocationLocationType**](LocationLocationType.md) | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'stackone_hris_client'
23
+
24
+ instance = StackOneHRIS::EmployeeApiModelHomeLocation.new(
25
+ id: 123456,
26
+ employee_id: 1687-3,
27
+ name: Woolsthorpe Manor,
28
+ phone_number: +44 1476 860 364,
29
+ street_1: Water Lane,
30
+ street_2: Woolsthorpe by Colsterworth,
31
+ city: Grantham,
32
+ state: Lincolnshire,
33
+ zip_code: NG33 5NR,
34
+ country: null,
35
+ location_type: null
36
+ )
37
+ ```
38
+