stackone_hris_client 1.5.2 → 1.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +49 -30
  4. data/docs/Account.md +3 -1
  5. data/docs/AccountMeta.md +22 -0
  6. data/docs/AccountsApi.md +82 -14
  7. data/docs/CompaniesApi.md +25 -25
  8. data/docs/ConnectSession.md +1 -1
  9. data/docs/ConnectSessionCreate.md +1 -1
  10. data/docs/ConnectSessionToken.md +1 -1
  11. data/docs/ConnectSessionsApi.md +9 -9
  12. data/docs/CreateEmployeeResult.md +22 -0
  13. data/docs/Employee.md +56 -52
  14. data/docs/EmployeeApiModel.md +80 -0
  15. data/docs/EmployeeApiModelAvatar.md +20 -0
  16. data/docs/EmployeeApiModelEmploymentStatus.md +20 -0
  17. data/docs/EmployeeApiModelEmploymentType.md +20 -0
  18. data/docs/EmployeeApiModelEthnicity.md +20 -0
  19. data/docs/EmployeeApiModelGender.md +20 -0
  20. data/docs/EmployeeApiModelHomeLocation.md +38 -0
  21. data/docs/EmployeeApiModelMaritalStatus.md +20 -0
  22. data/docs/EmployeeApiModelWorkLocation.md +38 -0
  23. data/docs/EmployeeCustomFieldTypeEnum.md +20 -0
  24. data/docs/EmployeeCustomFields.md +30 -0
  25. data/docs/EmployeeCustomFieldsType.md +20 -0
  26. data/docs/EmployeeResult.md +1 -1
  27. data/docs/EmployeesApi.md +242 -28
  28. data/docs/EmployeesPaginated.md +1 -1
  29. data/docs/Employment.md +17 -15
  30. data/docs/EmploymentEmploymentContractType.md +20 -0
  31. data/docs/EmploymentEmploymentType.md +20 -0
  32. data/docs/EmploymentPayFrequency.md +20 -0
  33. data/docs/EmploymentPayPeriod.md +20 -0
  34. data/docs/EmploymentScheduleTypeEnum.md +20 -0
  35. data/docs/EmploymentsApi.md +27 -27
  36. data/docs/HrisCreateEmployeeRequestDto.md +80 -0
  37. data/docs/Location.md +20 -20
  38. data/docs/LocationCountry.md +20 -0
  39. data/docs/LocationLocationType.md +20 -0
  40. data/docs/LocationsApi.md +9 -9
  41. data/gem-config.yml +2 -2
  42. data/generate_gem.sh +0 -0
  43. data/lib/stackone_hris_client/api/accounts_api.rb +68 -7
  44. data/lib/stackone_hris_client/api/companies_api.rb +20 -20
  45. data/lib/stackone_hris_client/api/connect_sessions_api.rb +5 -5
  46. data/lib/stackone_hris_client/api/employees_api.rb +251 -20
  47. data/lib/stackone_hris_client/api/employments_api.rb +20 -20
  48. data/lib/stackone_hris_client/api/locations_api.rb +5 -5
  49. data/lib/stackone_hris_client/api_client.rb +1 -1
  50. data/lib/stackone_hris_client/api_error.rb +1 -1
  51. data/lib/stackone_hris_client/configuration.rb +2 -2
  52. data/lib/stackone_hris_client/models/account.rb +16 -7
  53. data/lib/stackone_hris_client/models/account_meta.rb +284 -0
  54. data/lib/stackone_hris_client/models/companies_paginated.rb +1 -1
  55. data/lib/stackone_hris_client/models/company.rb +1 -1
  56. data/lib/stackone_hris_client/models/company_result.rb +1 -1
  57. data/lib/stackone_hris_client/models/connect_session.rb +1 -1
  58. data/lib/stackone_hris_client/models/connect_session_authenticate.rb +1 -1
  59. data/lib/stackone_hris_client/models/connect_session_create.rb +1 -1
  60. data/lib/stackone_hris_client/models/connect_session_token.rb +1 -1
  61. data/lib/stackone_hris_client/models/country_code_enum.rb +1 -7
  62. data/lib/stackone_hris_client/models/create_employee_result.rb +250 -0
  63. data/lib/stackone_hris_client/models/employee.rb +117 -124
  64. data/lib/stackone_hris_client/models/employee_api_model.rb +523 -0
  65. data/lib/stackone_hris_client/models/employee_api_model_avatar.rb +234 -0
  66. data/lib/stackone_hris_client/models/employee_api_model_employment_status.rb +272 -0
  67. data/lib/stackone_hris_client/models/employee_api_model_employment_type.rb +272 -0
  68. data/lib/stackone_hris_client/models/employee_api_model_ethnicity.rb +272 -0
  69. data/lib/stackone_hris_client/models/employee_api_model_gender.rb +272 -0
  70. data/lib/stackone_hris_client/models/employee_api_model_home_location.rb +324 -0
  71. data/lib/stackone_hris_client/models/employee_api_model_marital_status.rb +272 -0
  72. data/lib/stackone_hris_client/models/employee_api_model_work_location.rb +324 -0
  73. data/lib/stackone_hris_client/models/employee_custom_field_type_enum.rb +264 -0
  74. data/lib/stackone_hris_client/models/employee_custom_fields.rb +279 -0
  75. data/lib/stackone_hris_client/models/employee_custom_fields_type.rb +272 -0
  76. data/lib/stackone_hris_client/models/employee_result.rb +1 -1
  77. data/lib/stackone_hris_client/models/employees_paginated.rb +1 -1
  78. data/lib/stackone_hris_client/models/employment.rb +22 -7
  79. data/lib/stackone_hris_client/models/employment_employment_contract_type.rb +272 -0
  80. data/lib/stackone_hris_client/models/employment_employment_type.rb +272 -0
  81. data/lib/stackone_hris_client/models/employment_pay_frequency.rb +272 -0
  82. data/lib/stackone_hris_client/models/employment_pay_period.rb +272 -0
  83. data/lib/stackone_hris_client/models/employment_result.rb +1 -1
  84. data/lib/stackone_hris_client/models/employment_schedule_type_enum.rb +264 -0
  85. data/lib/stackone_hris_client/models/employment_status_enum.rb +1 -7
  86. data/lib/stackone_hris_client/models/employment_type_enum.rb +1 -7
  87. data/lib/stackone_hris_client/models/employments_paginated.rb +1 -1
  88. data/lib/stackone_hris_client/models/ethnicity_enum.rb +1 -7
  89. data/lib/stackone_hris_client/models/gender_enum.rb +1 -7
  90. data/lib/stackone_hris_client/models/hris_create_employee_request_dto.rb +523 -0
  91. data/lib/stackone_hris_client/models/image.rb +1 -1
  92. data/lib/stackone_hris_client/models/location.rb +12 -8
  93. data/lib/stackone_hris_client/models/location_country.rb +272 -0
  94. data/lib/stackone_hris_client/models/location_location_type.rb +272 -0
  95. data/lib/stackone_hris_client/models/location_result.rb +1 -1
  96. data/lib/stackone_hris_client/models/location_type_enum.rb +1 -7
  97. data/lib/stackone_hris_client/models/locations_paginated.rb +1 -1
  98. data/lib/stackone_hris_client/models/marital_status_enum.rb +1 -7
  99. data/lib/stackone_hris_client/models/pay_frequency_enum.rb +1 -7
  100. data/lib/stackone_hris_client/models/pay_period_enum.rb +1 -7
  101. data/lib/stackone_hris_client/version.rb +2 -2
  102. data/lib/stackone_hris_client.rb +23 -1
  103. data/spec/api/accounts_api_spec.rb +30 -8
  104. data/spec/api/companies_api_spec.rb +13 -13
  105. data/spec/api/connect_sessions_api_spec.rb +8 -8
  106. data/spec/api/employees_api_spec.rb +60 -18
  107. data/spec/api/employments_api_spec.rb +13 -13
  108. data/spec/api/locations_api_spec.rb +9 -9
  109. data/spec/api_client_spec.rb +1 -1
  110. data/spec/configuration_spec.rb +1 -1
  111. data/spec/models/account_meta_spec.rb +50 -0
  112. data/spec/models/account_spec.rb +18 -12
  113. data/spec/models/companies_paginated_spec.rb +4 -4
  114. data/spec/models/company_result_spec.rb +3 -3
  115. data/spec/models/company_spec.rb +4 -4
  116. data/spec/models/connect_session_authenticate_spec.rb +5 -5
  117. data/spec/models/connect_session_create_spec.rb +17 -11
  118. data/spec/models/connect_session_spec.rb +14 -14
  119. data/spec/models/connect_session_token_spec.rb +15 -15
  120. data/spec/models/country_code_enum_spec.rb +4 -4
  121. data/spec/models/create_employee_result_spec.rb +46 -0
  122. data/spec/models/employee.rb +220 -0
  123. data/spec/models/employee_api_model_avatar_spec.rb +40 -0
  124. data/spec/models/employee_api_model_employment_status_spec.rb +44 -0
  125. data/spec/models/employee_api_model_employment_type_spec.rb +44 -0
  126. data/spec/models/employee_api_model_ethnicity_spec.rb +44 -0
  127. data/spec/models/employee_api_model_gender_spec.rb +44 -0
  128. data/spec/models/employee_api_model_home_location_spec.rb +94 -0
  129. data/spec/models/employee_api_model_marital_status_spec.rb +44 -0
  130. data/spec/models/employee_api_model_spec.rb +220 -0
  131. data/spec/models/employee_api_model_work_location_spec.rb +94 -0
  132. data/spec/models/employee_custom_field_type_enum_spec.rb +44 -0
  133. data/spec/models/employee_custom_fields_spec.rb +70 -0
  134. data/spec/models/employee_custom_fields_type_spec.rb +44 -0
  135. data/spec/models/employee_result_spec.rb +6 -6
  136. data/spec/models/employees_paginated_spec.rb +7 -7
  137. data/spec/models/employment_employment_contract_type_spec.rb +44 -0
  138. data/spec/models/employment_employment_type_spec.rb +44 -0
  139. data/spec/models/employment_pay_frequency_spec.rb +44 -0
  140. data/spec/models/employment_pay_period_spec.rb +44 -0
  141. data/spec/models/employment_result_spec.rb +3 -3
  142. data/spec/models/employment_schedule_type_enum_spec.rb +44 -0
  143. data/spec/models/employment_spec.rb +16 -10
  144. data/spec/models/employment_status_enum_spec.rb +4 -4
  145. data/spec/models/employment_type_enum_spec.rb +4 -4
  146. data/spec/models/employments_paginated_spec.rb +4 -4
  147. data/spec/models/ethnicity_enum_spec.rb +4 -4
  148. data/spec/models/gender_enum_spec.rb +4 -4
  149. data/spec/models/hris_create_employee_request_dto_spec.rb +220 -0
  150. data/spec/models/image_spec.rb +3 -3
  151. data/spec/models/location_country_spec.rb +44 -0
  152. data/spec/models/location_location_type_spec.rb +44 -0
  153. data/spec/models/location_result_spec.rb +3 -3
  154. data/spec/models/location_spec.rb +12 -12
  155. data/spec/models/location_type_enum_spec.rb +3 -3
  156. data/spec/models/locations_paginated_spec.rb +4 -4
  157. data/spec/models/marital_status_enum_spec.rb +4 -4
  158. data/spec/models/pay_frequency_enum_spec.rb +4 -4
  159. data/spec/models/pay_period_enum_spec.rb +3 -3
  160. data/spec/spec_helper.rb +1 -1
  161. data/stackone_hris_client.gemspec +1 -1
  162. metadata +92 -4
  163. data/spec/models/employee_spec.rb +0 -124
data/docs/Employee.md CHANGED
@@ -4,36 +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
- | **personal_email** | **String** | | [optional] |
19
- | **personal_phone_number** | **String** | | |
20
- | **work_email** | **String** | | |
21
- | **work_phone_number** | **String** | | |
22
- | **job_title** | **String** | | [optional] |
23
- | **department** | **String** | | |
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** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | | [optional] |
30
- | **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | | [optional] |
31
- | **termination_date** | **Time** | | [optional] |
32
- | **company_name** | **String** | | [optional] |
33
- | **home_location** | [**Location**](Location.md) | | [optional] |
34
- | **work_location** | [**Location**](Location.md) | | [optional] |
35
- | **company** | **String** | | [optional] |
36
- | **employments** | [**Array<Employment>**](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<Employment>**](Employment.md) | The employee employments | [optional] |
38
+ | **custom_fields** | [**Array<EmployeeCustomFields>**](EmployeeCustomFields.md) | The employee custom fields | [optional] |
37
39
 
38
40
  ## Example
39
41
 
@@ -41,36 +43,38 @@
41
43
  require 'stackone_hris_client'
42
44
 
43
45
  instance = StackOneHRIS::Employee.new(
44
- id: null,
45
- first_name: null,
46
- last_name: null,
47
- name: null,
48
- 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,
49
59
  gender: null,
50
60
  ethnicity: null,
51
- date_of_birth: null,
52
- birthday: null,
61
+ date_of_birth: 1990-01-01,
62
+ birthday: 2023-06-14T00:00:00Z,
53
63
  marital_status: null,
54
64
  avatar: null,
55
- personal_email: null,
56
- personal_phone_number: null,
57
- work_email: null,
58
- work_phone_number: null,
59
- job_title: null,
60
- department: null,
61
- manager_id: null,
62
- hire_date: null,
63
- start_date: null,
64
- tenure: null,
65
- 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,
66
69
  employment_type: null,
70
+ employment_contract_type: null,
67
71
  employment_status: null,
68
- termination_date: null,
69
- company_name: null,
72
+ termination_date: 2023-06-14T00:00:00Z,
70
73
  home_location: null,
71
74
  work_location: null,
72
- company: null,
73
- employments: null
75
+ company_name: Example Corp,
76
+ employments: null,
77
+ custom_fields: null
74
78
  )
75
79
  ```
76
80
 
data/docs/EmployeeApiModel.md ADDED
@@ -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<Employment>**](Employment.md) | The employee employments | [optional] |
38
+ | **custom_fields** | [**Array<EmployeeCustomFields>**](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
+
data/docs/EmployeeApiModelAvatar.md ADDED
@@ -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
+
data/docs/EmployeeApiModelEmploymentStatus.md ADDED
@@ -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
+
data/docs/EmployeeApiModelEmploymentType.md ADDED
@@ -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
+
data/docs/EmployeeApiModelEthnicity.md ADDED
@@ -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
+
data/docs/EmployeeApiModelGender.md ADDED
@@ -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
+
data/docs/EmployeeApiModelHomeLocation.md ADDED
@@ -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
+
data/docs/EmployeeApiModelMaritalStatus.md ADDED
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EmployeeApiModelMaritalStatus
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::EmployeeApiModelMaritalStatus.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
data/docs/EmployeeApiModelWorkLocation.md ADDED
@@ -0,0 +1,38 @@
1
+ # StackOneHRIS::EmployeeApiModelWorkLocation
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::EmployeeApiModelWorkLocation.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
+
data/docs/EmployeeCustomFieldTypeEnum.md ADDED
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EmployeeCustomFieldTypeEnum
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::EmployeeCustomFieldTypeEnum.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
data/docs/EmployeeCustomFields.md ADDED
@@ -0,0 +1,30 @@
1
+ # StackOneHRIS::EmployeeCustomFields
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The unique identifier for the custom field, which defaults to the name property if the ID is not accessible. | [optional] |
8
+ | **name** | **String** | The name of the custom field. | [optional] |
9
+ | **description** | **String** | The description of the custom field. | [optional] |
10
+ | **type** | [**EmployeeCustomFieldsType**](EmployeeCustomFieldsType.md) | | [optional] |
11
+ | **value** | **Object** | The value associated with the custom field. | [optional] |
12
+ | **value_id** | **String** | The unique identifier for the value of the custom field. | [optional] |
13
+ | **options** | **Array<String>** | An array of possible options for the custom field. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'stackone_hris_client'
19
+
20
+ instance = StackOneHRIS::EmployeeCustomFields.new(
21
+ id: custom_field_123,
22
+ name: Training Completion Status,
23
+ description: The completion status of the employee's training.,
24
+ type: null,
25
+ value: Completed,
26
+ value_id: value_456,
27
+ options: ["Not Started","In Progress","Completed","Overdue"]
28
+ )
29
+ ```
30
+
data/docs/EmployeeCustomFieldsType.md ADDED
@@ -0,0 +1,20 @@
1
+ # StackOneHRIS::EmployeeCustomFieldsType
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::EmployeeCustomFieldsType.new(
16
+ value: null,
17
+ source_value: null
18
+ )
19
+ ```
20
+
data/docs/EmployeeResult.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **data** | [**Employee**](Employee.md) | | |
7
+ | **data** | [**EmployeeApiModel**](EmployeeApiModel.md) | | |
8
8
  | **raw** | **String** | | [optional] |
9
9
 
10
10
  ## Example