Skip to content

Commit e0423ca

Browse files
author
github-actions-bot
committed
fix(employees): add query param
1 parent f9016eb commit e0423ca

29 files changed

+1271
-29
lines changed

‎.openapi-generator/FILES‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ docs/CompanyResponse.md
1313
docs/CoreApi.md
1414
docs/CreateEmployeeRequest.md
1515
docs/CreateEmployeeRequestBankAccount.md
16+
docs/CreateEmployeeRequestDependents.md
17+
docs/CreateEmployeeRequestEmergencyContacts.md
1618
docs/CreateEmployeeRequestManager.md
1719
docs/CurrencyNotNullRequest.md
1820
docs/CurrencyResponse.md
@@ -22,6 +24,9 @@ docs/EmployeeResponseManager.md
2224
docs/Employees20230301Response.md
2325
docs/EmploymentNoNullEnumRequest.md
2426
docs/EmploymentResponse.md
27+
docs/EmploymentStatus.md
28+
docs/EmploymentStatusNotNullRequest.md
29+
docs/EmploymentStatusResponse.md
2530
docs/GroupNoNullEnumRequest.md
2631
docs/GroupResponse.md
2732
docs/Groups20230301Response.md
@@ -82,6 +87,8 @@ openapi_client/model/companies20230301_response.py
8287
openapi_client/model/company_response.py
8388
openapi_client/model/create_employee_request.py
8489
openapi_client/model/create_employee_request_bank_account.py
90+
openapi_client/model/create_employee_request_dependents.py
91+
openapi_client/model/create_employee_request_emergency_contacts.py
8592
openapi_client/model/create_employee_request_manager.py
8693
openapi_client/model/currency_not_null_request.py
8794
openapi_client/model/currency_response.py
@@ -91,6 +98,9 @@ openapi_client/model/employee_response_manager.py
9198
openapi_client/model/employees20230301_response.py
9299
openapi_client/model/employment_no_null_enum_request.py
93100
openapi_client/model/employment_response.py
101+
openapi_client/model/employment_status.py
102+
openapi_client/model/employment_status_not_null_request.py
103+
openapi_client/model/employment_status_response.py
94104
openapi_client/model/group_no_null_enum_request.py
95105
openapi_client/model/group_response.py
96106
openapi_client/model/groups20230301_response.py
@@ -147,6 +157,8 @@ test/test_company_response.py
147157
test/test_core_api.py
148158
test/test_create_employee_request.py
149159
test/test_create_employee_request_bank_account.py
160+
test/test_create_employee_request_dependents.py
161+
test/test_create_employee_request_emergency_contacts.py
150162
test/test_create_employee_request_manager.py
151163
test/test_currency_not_null_request.py
152164
test/test_currency_response.py
@@ -156,6 +168,9 @@ test/test_employee_response_manager.py
156168
test/test_employees20230301_response.py
157169
test/test_employment_no_null_enum_request.py
158170
test/test_employment_response.py
171+
test/test_employment_status.py
172+
test/test_employment_status_not_null_request.py
173+
test/test_employment_status_response.py
159174
test/test_group_no_null_enum_request.py
160175
test/test_group_response.py
161176
test/test_groups20230301_response.py

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,7 @@ from pprint import pprint
258258
from openapi_client.api import 2023_03_01_api
259259
from openapi_client.model.companies20230301_response import Companies20230301Response
260260
from openapi_client.model.employees20230301_response import Employees20230301Response
261+
from openapi_client.model.employment_status import EmploymentStatus
261262
from openapi_client.model.groups20230301_response import Groups20230301Response
262263
from openapi_client.model.identity_response import IdentityResponse
263264
from openapi_client.model.inline_response401 import InlineResponse401
@@ -344,6 +345,8 @@ Class | Method | HTTP request | Description
344345
- [CompanyResponse](docs/CompanyResponse.md)
345346
- [CreateEmployeeRequest](docs/CreateEmployeeRequest.md)
346347
- [CreateEmployeeRequestBankAccount](docs/CreateEmployeeRequestBankAccount.md)
348+
- [CreateEmployeeRequestDependents](docs/CreateEmployeeRequestDependents.md)
349+
- [CreateEmployeeRequestEmergencyContacts](docs/CreateEmployeeRequestEmergencyContacts.md)
347350
- [CreateEmployeeRequestManager](docs/CreateEmployeeRequestManager.md)
348351
- [CurrencyNotNullRequest](docs/CurrencyNotNullRequest.md)
349352
- [CurrencyResponse](docs/CurrencyResponse.md)
@@ -353,6 +356,9 @@ Class | Method | HTTP request | Description
353356
- [Employees20230301Response](docs/Employees20230301Response.md)
354357
- [EmploymentNoNullEnumRequest](docs/EmploymentNoNullEnumRequest.md)
355358
- [EmploymentResponse](docs/EmploymentResponse.md)
359+
- [EmploymentStatus](docs/EmploymentStatus.md)
360+
- [EmploymentStatusNotNullRequest](docs/EmploymentStatusNotNullRequest.md)
361+
- [EmploymentStatusResponse](docs/EmploymentStatusResponse.md)
356362
- [GroupNoNullEnumRequest](docs/GroupNoNullEnumRequest.md)
357363
- [GroupResponse](docs/GroupResponse.md)
358364
- [Groups20230301Response](docs/Groups20230301Response.md)

‎docs/20230301Api.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ from openapi_client.api import 2023_03_01_api
112112
from openapi_client.model.message_response import MessageResponse
113113
from openapi_client.model.employees20230301_response import Employees20230301Response
114114
from openapi_client.model.inline_response401 import InlineResponse401
115+
from openapi_client.model.employment_status import EmploymentStatus
115116
from pprint import pprint
116117
# Defining the host is optional and defaults to https://api.affixapi.com
117118
# See configuration.py for a list of all supported configuration parameters.
@@ -134,19 +135,24 @@ configuration.api_key['access-token'] = 'YOUR_API_KEY'
134135
with openapi_client.ApiClient(configuration) as api_client:
135136
# Create an instance of the API class
136137
api_instance = 2023_03_01_api.20230301Api(api_client)
138+
employment_status = EmploymentStatus("active") # EmploymentStatus | Enable server-side filtering of the `employment_status` attribute (optional)
137139

138-
# example, this endpoint has no required or optional parameters
140+
# example passing only required values which don't have defaults set
141+
# and optional values
139142
try:
140143
# Employees
141-
api_response = api_instance.xhr_employees20230301()
144+
api_response = api_instance.xhr_employees20230301(employment_status=employment_status)
142145
pprint(api_response)
143146
except openapi_client.ApiException as e:
144147
print("Exception when calling 20230301Api->xhr_employees20230301: %s\n" % e)
145148
```
146149

147150

148151
### Parameters
149-
This endpoint does not need any parameter.
152+
153+
Name | Type | Description | Notes
154+
------------- | ------------- | ------------- | -------------
155+
**employment_status** | **EmploymentStatus**| Enable server-side filtering of the `employment_status` attribute | [optional]
150156

151157
### Return type
152158

‎docs/CreateEmployeeRequest.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
1818
**ethnicity** | **str, none_type** | | [optional]
1919
**marital_status** | **str, none_type** | | [optional]
2020
**date_of_birth** | **date, none_type** | | [optional]
21-
**employment_status** | **str, none_type** | | [optional]
21+
**employment_status** | [**EmploymentStatusNotNullRequest**](EmploymentStatusNotNullRequest.md) | | [optional]
2222
**employment_type** | **str, none_type** | | [optional]
2323
**start_date** | **date, none_type** | | [optional]
2424
**termination_date** | **date, none_type** | | [optional]
@@ -30,6 +30,8 @@ Name | Type | Description | Notes
3030
**employments** | [**[EmploymentNoNullEnumRequest], none_type**](EmploymentNoNullEnumRequest.md) | | [optional]
3131
**custom_fields** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | | [optional]
3232
**groups** | [**GroupsNoNullEnumRequest**](GroupsNoNullEnumRequest.md) | | [optional]
33+
**dependents** | [**[CreateEmployeeRequestDependents], none_type**](CreateEmployeeRequestDependents.md) | | [optional]
34+
**emergency_contacts** | [**[CreateEmployeeRequestEmergencyContacts], none_type**](CreateEmployeeRequestEmergencyContacts.md) | | [optional]
3335

3436
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
3537

‎docs/CreateEmployeeRequestDependents.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CreateEmployeeRequestDependents
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **str, none_type** | |
8+
**relationship** | **str, none_type** | |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/CreateEmployeeRequestEmergencyContacts.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CreateEmployeeRequestEmergencyContacts
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**first_name** | **str, none_type** | |
8+
**last_name** | **str, none_type** | |
9+
**relationship** | **str, none_type** | |
10+
**mobile_phone_number** | **str, none_type** | |
11+
**primary_contact** | **bool, none_type** | |
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+

‎docs/EmployeeResponse.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
2020
**ethnicity** | **str, none_type** | |
2121
**marital_status** | **str, none_type** | `other` option can include co-habitating, civil partnership, separated, divorced, widowed, etc |
2222
**date_of_birth** | **date, none_type** | |
23-
**employment_status** | **str, none_type** | |
23+
**employment_status** | [**EmploymentStatusResponse**](EmploymentStatusResponse.md) | |
2424
**employment_type** | **str, none_type** | |
2525
**start_date** | **date, none_type** | |
2626
**remote_created_at** | **date, none_type** | | [readonly]
@@ -33,6 +33,8 @@ Name | Type | Description | Notes
3333
**employments** | [**[EmploymentResponse], none_type**](EmploymentResponse.md) | |
3434
**custom_fields** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | |
3535
**groups** | [**Groups20230301Response**](Groups20230301Response.md) | |
36+
**dependents** | [**[CreateEmployeeRequestDependents], none_type**](CreateEmployeeRequestDependents.md) | |
37+
**emergency_contacts** | [**[CreateEmployeeRequestEmergencyContacts], none_type**](CreateEmployeeRequestEmergencyContacts.md) | |
3638

3739
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
3840

‎docs/EmploymentStatus.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# EmploymentStatus
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**value** | **str** | | must be one of ["null", "active", "inactive", "pending", "leave", ]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/EmploymentStatusNotNullRequest.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# EmploymentStatusNotNullRequest
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**value** | **str** | | must be one of ["active", "inactive", "pending", "leave", ]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/EmploymentStatusResponse.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# EmploymentStatusResponse
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**value** | **str** | | must be one of ["null", "active", "inactive", "pending", "leave", ]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

0 commit comments

Comments
 (0)