stackone_hris_client 1.5.2 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b51bed469dbe48efe770337b1bc3174edfcc49357bde2168a1586a1e588a1dec
4
- data.tar.gz: 50138272112948faf69ec67fab204684a89b6ed8aaae024f56346c285bac0534
3
+ metadata.gz: b3c7376b8d5de9ee4d5c49add57bad3f2177409dbd05258f5fafd73901980c8c
4
+ data.tar.gz: 89d15eb34ed71ca8d8e398daa2b9f9e98da7ae720a2fef8bf97a5aff004fd701
5
5
  SHA512:
6
- metadata.gz: b68f232cbfab9128af9a900d56af9ea63d49172a6a4678e408f0d4f5061f19287543286094a7c48ba51e076ed7a93b0e3f136d8d082b1df50f1375b6720d7992
7
- data.tar.gz: 7d0dbcb36ea6564b88f58af1b6addb6c5ba7a378b0852e723baa19c74a7d0536e7cc293d2da3ec94f45d5a33f875d740c07cdcddede49528e662e14064e69fdc
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.5.2)
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.5.2
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.5.2.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.5.2.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.5.2'
35
+ gem 'stackone_hris_client', '~> 1.7.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::EmployeesApi.new
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
- }
65
+ api_instance = StackOneHRIS::AccountsApi.new
66
+ id = 'id_example' # String |
75
67
 
76
68
  begin
77
- #
78
- result = api_instance.employees_get(id, x_account_id, opts)
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 EmployeesApi->employees_get: #{e}"
73
+ puts "Exception when calling AccountsApi->accounts_delete: #{e}"
82
74
  end
83
75
 
84
76
  ```
@@ -89,24 +81,29 @@ 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* | [**companies_get**](docs/CompaniesApi.md#companies_get) | **GET** /unified/hris/companies/{id} |
96
- *StackOneHRIS::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /unified/hris/companies |
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* | [**employees_get**](docs/EmployeesApi.md#employees_get) | **GET** /unified/hris/employees/{id} |
100
- *StackOneHRIS::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /unified/hris/employees |
101
- *StackOneHRIS::EmploymentsApi* | [**employments_get**](docs/EmploymentsApi.md#employments_get) | **GET** /unified/hris/employments/{id} |
102
- *StackOneHRIS::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /unified/hris/employments |
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::AccountsApi* | [**accounts_meta_get**](docs/AccountsApi.md#accounts_meta_get) | **GET** /accounts/{id}/meta | Get meta information of the account
88
+ *StackOneHRIS::CompaniesApi* | [**hris_companies_get**](docs/CompaniesApi.md#hris_companies_get) | **GET** /unified/hris/companies/{id} | Get Company
89
+ *StackOneHRIS::CompaniesApi* | [**hris_companies_list**](docs/CompaniesApi.md#hris_companies_list) | **GET** /unified/hris/companies | List Companies
90
+ *StackOneHRIS::ConnectSessionsApi* | [**connect_sessions_authenticate**](docs/ConnectSessionsApi.md#connect_sessions_authenticate) | **POST** /connect_sessions/authenticate | Authenticate Session
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
95
+ *StackOneHRIS::EmployeesApi* | [**hris_employees_get**](docs/EmployeesApi.md#hris_employees_get) | **GET** /unified/hris/employees/{id} | Get Employee
96
+ *StackOneHRIS::EmployeesApi* | [**hris_employees_list**](docs/EmployeesApi.md#hris_employees_list) | **GET** /unified/hris/employees | List Employees
97
+ *StackOneHRIS::EmploymentsApi* | [**hris_employments_get**](docs/EmploymentsApi.md#hris_employments_get) | **GET** /unified/hris/employments/{id} | Get Employment
98
+ *StackOneHRIS::EmploymentsApi* | [**hris_employments_list**](docs/EmploymentsApi.md#hris_employments_list) | **GET** /unified/hris/employments | List Employments
99
+ *StackOneHRIS::LocationsApi* | [**hris_locations_get**](docs/LocationsApi.md#hris_locations_get) | **GET** /unified/hris/locations/{id} | Get location
100
+ *StackOneHRIS::LocationsApi* | [**hris_locations_list**](docs/LocationsApi.md#hris_locations_list) | **GET** /unified/hris/locations | List locations
105
101
 
106
102
 
107
103
  ## Documentation for Models
108
104
 
109
105
  - [StackOneHRIS::Account](docs/Account.md)
106
+ - [StackOneHRIS::AccountMeta](docs/AccountMeta.md)
110
107
  - [StackOneHRIS::CompaniesPaginated](docs/CompaniesPaginated.md)
111
108
  - [StackOneHRIS::Company](docs/Company.md)
112
109
  - [StackOneHRIS::CompanyResult](docs/CompanyResult.md)
@@ -115,18 +112,39 @@ Class | Method | HTTP request | Description
115
112
  - [StackOneHRIS::ConnectSessionCreate](docs/ConnectSessionCreate.md)
116
113
  - [StackOneHRIS::ConnectSessionToken](docs/ConnectSessionToken.md)
117
114
  - [StackOneHRIS::CountryCodeEnum](docs/CountryCodeEnum.md)
115
+ - [StackOneHRIS::CreateEmployeeResult](docs/CreateEmployeeResult.md)
118
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)
119
129
  - [StackOneHRIS::EmployeeResult](docs/EmployeeResult.md)
120
130
  - [StackOneHRIS::EmployeesPaginated](docs/EmployeesPaginated.md)
121
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)
122
136
  - [StackOneHRIS::EmploymentResult](docs/EmploymentResult.md)
137
+ - [StackOneHRIS::EmploymentScheduleTypeEnum](docs/EmploymentScheduleTypeEnum.md)
123
138
  - [StackOneHRIS::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
124
139
  - [StackOneHRIS::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
125
140
  - [StackOneHRIS::EmploymentsPaginated](docs/EmploymentsPaginated.md)
126
141
  - [StackOneHRIS::EthnicityEnum](docs/EthnicityEnum.md)
127
142
  - [StackOneHRIS::GenderEnum](docs/GenderEnum.md)
143
+ - [StackOneHRIS::HrisCreateEmployeeRequestDto](docs/HrisCreateEmployeeRequestDto.md)
128
144
  - [StackOneHRIS::Image](docs/Image.md)
129
145
  - [StackOneHRIS::Location](docs/Location.md)
146
+ - [StackOneHRIS::LocationCountry](docs/LocationCountry.md)
147
+ - [StackOneHRIS::LocationLocationType](docs/LocationLocationType.md)
130
148
  - [StackOneHRIS::LocationResult](docs/LocationResult.md)
131
149
  - [StackOneHRIS::LocationTypeEnum](docs/LocationTypeEnum.md)
132
150
  - [StackOneHRIS::LocationsPaginated](docs/LocationsPaginated.md)
@@ -138,6 +156,7 @@ Class | Method | HTTP request | Description
138
156
  ## Documentation for Authorization
139
157
 
140
158
 
159
+ Authentication schemes defined for the API:
141
160
  ### basic
142
161
 
143
162
  - **Type**: HTTP basic authentication
data/docs/Account.md CHANGED
@@ -6,10 +6,11 @@
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** | | |
12
- | **credentials** | **Object** | | |
13
+ | **credentials** | **Object** | | [optional] |
13
14
  | **created_at** | **Time** | | |
14
15
  | **updated_at** | **Time** | | |
15
16
 
@@ -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,
@@ -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
@@ -4,16 +4,17 @@ 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
+ | [**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
13
14
 
14
15
  > <Account> accounts_delete(id)
15
16
 
16
-
17
+ Delete Account
17
18
 
18
19
  ### Examples
19
20
 
@@ -27,10 +28,10 @@ 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
34
35
  result = api_instance.accounts_delete(id)
35
36
  p result
36
37
  rescue StackOneHRIS::ApiError => e
@@ -46,7 +47,7 @@ This returns an Array which contains the response data, status code and headers.
46
47
 
47
48
  ```ruby
48
49
  begin
49
- #
50
+ # Delete Account
50
51
  data, status_code, headers = api_instance.accounts_delete_with_http_info(id)
51
52
  p status_code # => 2xx
52
53
  p headers # => { ... }
@@ -80,7 +81,7 @@ end
80
81
 
81
82
  > <Account> accounts_get(id)
82
83
 
83
-
84
+ Get Account
84
85
 
85
86
  ### Examples
86
87
 
@@ -94,10 +95,10 @@ 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
101
102
  result = api_instance.accounts_get(id)
102
103
  p result
103
104
  rescue StackOneHRIS::ApiError => e
@@ -113,7 +114,7 @@ This returns an Array which contains the response data, status code and headers.
113
114
 
114
115
  ```ruby
115
116
  begin
116
- #
117
+ # Get Account
117
118
  data, status_code, headers = api_instance.accounts_get_with_http_info(id)
118
119
  p status_code # => 2xx
119
120
  p headers # => { ... }
@@ -147,7 +148,7 @@ end
147
148
 
148
149
  > <Array<Account>> accounts_list(opts)
149
150
 
150
-
151
+ List Accounts
151
152
 
152
153
  ### Examples
153
154
 
@@ -167,7 +168,7 @@ opts = {
167
168
  }
168
169
 
169
170
  begin
170
- #
171
+ # List Accounts
171
172
  result = api_instance.accounts_list(opts)
172
173
  p result
173
174
  rescue StackOneHRIS::ApiError => e
@@ -183,7 +184,7 @@ This returns an Array which contains the response data, status code and headers.
183
184
 
184
185
  ```ruby
185
186
  begin
186
- #
187
+ # List Accounts
187
188
  data, status_code, headers = api_instance.accounts_list_with_http_info(opts)
188
189
  p status_code # => 2xx
189
190
  p headers # => { ... }
@@ -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
@@ -4,15 +4,15 @@ All URIs are relative to *https://api.stackone.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**companies_get**](CompaniesApi.md#companies_get) | **GET** /unified/hris/companies/{id} | |
8
- | [**companies_list**](CompaniesApi.md#companies_list) | **GET** /unified/hris/companies | |
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
- ## companies_get
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
 
@@ -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
@@ -38,29 +38,29 @@ opts = {
38
38
  }
39
39
 
40
40
  begin
41
- #
42
- result = api_instance.companies_get(id, x_account_id, opts)
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->companies_get: #{e}"
45
+ puts "Error when calling CompaniesApi->hris_companies_get: #{e}"
46
46
  end
47
47
  ```
48
48
 
49
- #### Using the companies_get_with_http_info variant
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)> companies_get_with_http_info(id, x_account_id, opts)
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.companies_get_with_http_info(id, x_account_id, opts)
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->companies_get_with_http_info: #{e}"
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
- ## companies_list
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.companies_list(x_account_id, opts)
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->companies_list: #{e}"
127
+ puts "Error when calling CompaniesApi->hris_companies_list: #{e}"
128
128
  end
129
129
  ```
130
130
 
131
- #### Using the companies_list_with_http_info variant
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)> companies_list_with_http_info(x_account_id, opts)
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.companies_list_with_http_info(x_account_id, opts)
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->companies_list_with_http_info: #{e}"
145
+ puts "Error when calling CompaniesApi->hris_companies_list_with_http_info: #{e}"
146
146
  end
147
147
  ```
148
148
 
@@ -23,7 +23,7 @@ instance = StackOneHRIS::ConnectSession.new(
23
23
  id: null,
24
24
  organization_id: null,
25
25
  project_id: null,
26
- categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;,&quot;common&quot;],
26
+ categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;,&quot;marketing&quot;,&quot;common&quot;],
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: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;,&quot;common&quot;],
21
+ categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;,&quot;marketing&quot;,&quot;common&quot;],
22
22
  provider: null,
23
23
  origin_owner_id: null,
24
24
  origin_owner_name: null,
@@ -24,7 +24,7 @@ instance = StackOneHRIS::ConnectSessionToken.new(
24
24
  id: null,
25
25
  organization_id: null,
26
26
  project_id: null,
27
- categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;,&quot;common&quot;],
27
+ categories: [&quot;ats&quot;,&quot;hris&quot;,&quot;crm&quot;,&quot;marketing&quot;,&quot;common&quot;],
28
28
  provider: null,
29
29
  origin_owner_id: null,
30
30
  origin_owner_name: null,
@@ -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
 
@@ -93,10 +93,10 @@ 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
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 # => { ... }
@@ -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
+