Look for details in API documentation's changelog

Author: Api (Codebuild)

.openapi-generator/FILES

@@ -881,6 +881,7 @@ docs/ObjectUserApi.md
 docs/ObjectUsergroupApi.md
 docs/ObjectUsergroupdelegationApi.md
 docs/ObjectUsergroupmembershipApi.md
+docs/ObjectUserlogintypeApi.md
 docs/ObjectUserstagedApi.md
 docs/ObjectVariableexpenseApi.md
 docs/ObjectVersionhistoryApi.md
@@ -1076,6 +1077,9 @@ docs/UsergroupmembershipRequest.md
 docs/UsergroupmembershipRequestCompound.md
 docs/UsergroupmembershipResponse.md
 docs/UsergroupmembershipResponseCompound.md
+docs/UserlogintypeAutocompleteElementResponse.md
+docs/UserlogintypeGetAutocompleteV2Response.md
+docs/UserlogintypeGetAutocompleteV2ResponseMPayload.md
 docs/UserstagedCreateUserV1Response.md
 docs/UserstagedCreateUserV1ResponseMPayload.md
 docs/UserstagedDeleteObjectV1Response.md
@@ -1209,6 +1213,7 @@ eZmaxApi/api/object_user_api.py
 eZmaxApi/api/object_usergroup_api.py
 eZmaxApi/api/object_usergroupdelegation_api.py
 eZmaxApi/api/object_usergroupmembership_api.py
+eZmaxApi/api/object_userlogintype_api.py
 eZmaxApi/api/object_userstaged_api.py
 eZmaxApi/api/object_variableexpense_api.py
 eZmaxApi/api/object_versionhistory_api.py
@@ -2221,6 +2226,9 @@ eZmaxApi/models/usergroupmembership_request.py
 eZmaxApi/models/usergroupmembership_request_compound.py
 eZmaxApi/models/usergroupmembership_response.py
 eZmaxApi/models/usergroupmembership_response_compound.py
+eZmaxApi/models/userlogintype_autocomplete_element_response.py
+eZmaxApi/models/userlogintype_get_autocomplete_v2_response.py
+eZmaxApi/models/userlogintype_get_autocomplete_v2_response_m_payload.py
 eZmaxApi/models/userstaged_create_user_v1_response.py
 eZmaxApi/models/userstaged_create_user_v1_response_m_payload.py
 eZmaxApi/models/userstaged_delete_object_v1_response.py
@@ -3173,6 +3181,7 @@ test/test_object_user_api.py
 test/test_object_usergroup_api.py
 test/test_object_usergroupdelegation_api.py
 test/test_object_usergroupmembership_api.py
+test/test_object_userlogintype_api.py
 test/test_object_userstaged_api.py
 test/test_object_variableexpense_api.py
 test/test_object_versionhistory_api.py
@@ -3368,6 +3377,9 @@ test/test_usergroupmembership_request.py
 test/test_usergroupmembership_request_compound.py
 test/test_usergroupmembership_response.py
 test/test_usergroupmembership_response_compound.py
+test/test_userlogintype_autocomplete_element_response.py
+test/test_userlogintype_get_autocomplete_v2_response.py
+test/test_userlogintype_get_autocomplete_v2_response_m_payload.py
 test/test_userstaged_create_user_v1_response.py
 test/test_userstaged_create_user_v1_response_m_payload.py
 test/test_userstaged_delete_object_v1_response.py

README.md

@@ -354,6 +354,7 @@ Class | Method | HTTP request | Description
 *ObjectUsergroupmembershipApi* | [**usergroupmembership_delete_object_v1**](docs/ObjectUsergroupmembershipApi.md#usergroupmembership_delete_object_v1) | **DELETE** /1/object/usergroupmembership/{pkiUsergroupmembershipID} | Delete an existing Usergroupmembership
 *ObjectUsergroupmembershipApi* | [**usergroupmembership_edit_object_v1**](docs/ObjectUsergroupmembershipApi.md#usergroupmembership_edit_object_v1) | **PUT** /1/object/usergroupmembership/{pkiUsergroupmembershipID} | Edit an existing Usergroupmembership
 *ObjectUsergroupmembershipApi* | [**usergroupmembership_get_object_v2**](docs/ObjectUsergroupmembershipApi.md#usergroupmembership_get_object_v2) | **GET** /2/object/usergroupmembership/{pkiUsergroupmembershipID} | Retrieve an existing Usergroupmembership
+*ObjectUserlogintypeApi* | [**userlogintype_get_autocomplete_v2**](docs/ObjectUserlogintypeApi.md#userlogintype_get_autocomplete_v2) | **GET** /2/object/userlogintype/getAutocomplete/{sSelector} | Retrieve Userlogintypes and IDs
 *ObjectUserstagedApi* | [**userstaged_create_user_v1**](docs/ObjectUserstagedApi.md#userstaged_create_user_v1) | **POST** /1/object/userstaged/{pkiUserstagedID}/createUser | Create a User from a Userstaged and then map it
 *ObjectUserstagedApi* | [**userstaged_delete_object_v1**](docs/ObjectUserstagedApi.md#userstaged_delete_object_v1) | **DELETE** /1/object/userstaged/{pkiUserstagedID} | Delete an existing Userstaged
 *ObjectUserstagedApi* | [**userstaged_get_list_v1**](docs/ObjectUserstagedApi.md#userstaged_get_list_v1) | **GET** /1/object/userstaged/getList | Retrieve Userstaged list
@@ -1387,6 +1388,9 @@ Class | Method | HTTP request | Description
  - [UsergroupmembershipRequestCompound](docs/UsergroupmembershipRequestCompound.md)
  - [UsergroupmembershipResponse](docs/UsergroupmembershipResponse.md)
  - [UsergroupmembershipResponseCompound](docs/UsergroupmembershipResponseCompound.md)
+ - [UserlogintypeAutocompleteElementResponse](docs/UserlogintypeAutocompleteElementResponse.md)
+ - [UserlogintypeGetAutocompleteV2Response](docs/UserlogintypeGetAutocompleteV2Response.md)
+ - [UserlogintypeGetAutocompleteV2ResponseMPayload](docs/UserlogintypeGetAutocompleteV2ResponseMPayload.md)
  - [UserstagedCreateUserV1Response](docs/UserstagedCreateUserV1Response.md)
  - [UserstagedCreateUserV1ResponseMPayload](docs/UserstagedCreateUserV1ResponseMPayload.md)
  - [UserstagedDeleteObjectV1Response](docs/UserstagedDeleteObjectV1Response.md)

docs/ObjectUserlogintypeApi.md

@@ -0,0 +1,94 @@
+# eZmaxApi.ObjectUserlogintypeApi
+
+All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**userlogintype_get_autocomplete_v2**](ObjectUserlogintypeApi.md#userlogintype_get_autocomplete_v2) | **GET** /2/object/userlogintype/getAutocomplete/{sSelector} | Retrieve Userlogintypes and IDs
+
+
+# **userlogintype_get_autocomplete_v2**
+> UserlogintypeGetAutocompleteV2Response userlogintype_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
+
+Retrieve Userlogintypes and IDs
+
+Get the list of Userlogintype to be used in a dropdown or autocomplete control.
+
+### Example
+
+* Api Key Authentication (Authorization):
+```python
+import time
+import os
+import eZmaxApi
+from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
+from eZmaxApi.models.userlogintype_get_autocomplete_v2_response import UserlogintypeGetAutocompleteV2Response
+from eZmaxApi.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
+# See configuration.py for a list of all supported configuration parameters.
+configuration = eZmaxApi.Configuration(
+    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: Authorization
+configuration.api_key['Authorization'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['Authorization'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with eZmaxApi.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = eZmaxApi.ObjectUserlogintypeApi(api_client)
+    s_selector = 's_selector_example' # str | The type of Userlogintypes to return
+    e_filter_active = 'Active' # str | Specify which results we want to display. (optional) (default to 'Active')
+    s_query = 's_query_example' # str | Allow to filter the returned results (optional)
+    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)
+
+    try:
+        # Retrieve Userlogintypes and IDs
+        api_response = api_instance.userlogintype_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
+        print("The response of ObjectUserlogintypeApi->userlogintype_get_autocomplete_v2:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ObjectUserlogintypeApi->userlogintype_get_autocomplete_v2: %s\n" % e)
+```
+
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **s_selector** | **str**| The type of Userlogintypes to return | 
+ **e_filter_active** | **str**| Specify which results we want to display. | [optional] [default to 'Active']
+ **s_query** | **str**| Allow to filter the returned results | [optional] 
+ **accept_language** | [**HeaderAcceptLanguage**](.md)|  | [optional] 
+
+### Return type
+
+[**UserlogintypeGetAutocompleteV2Response**](UserlogintypeGetAutocompleteV2Response.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

docs/UserlogintypeAutocompleteElementResponse.md

@@ -0,0 +1,31 @@
+# UserlogintypeAutocompleteElementResponse
+
+A Userlogintype AutocompleteElement Response
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pki_userlogintype_id** | **int** | The unique ID of the Userlogintype  Valid values:  |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**| | 
+**s_userlogintype_description_x** | **str** | The description of the Userlogintype in the language of the requester | 
+**b_userlogintype_isactive** | **bool** | Whether the Userlogintype is active or not | 
+
+## Example
+
+```python
+from eZmaxApi.models.userlogintype_autocomplete_element_response import UserlogintypeAutocompleteElementResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UserlogintypeAutocompleteElementResponse from a JSON string
+userlogintype_autocomplete_element_response_instance = UserlogintypeAutocompleteElementResponse.from_json(json)
+# print the JSON string representation of the object
+print UserlogintypeAutocompleteElementResponse.to_json()
+
+# convert the object into a dict
+userlogintype_autocomplete_element_response_dict = userlogintype_autocomplete_element_response_instance.to_dict()
+# create an instance of UserlogintypeAutocompleteElementResponse from a dict
+userlogintype_autocomplete_element_response_form_dict = userlogintype_autocomplete_element_response.from_dict(userlogintype_autocomplete_element_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/UserlogintypeGetAutocompleteV2Response.md

@@ -0,0 +1,31 @@
+# UserlogintypeGetAutocompleteV2Response
+
+Response for GET /2/object/userlogintype/getAutocomplete
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
+**m_payload** | [**UserlogintypeGetAutocompleteV2ResponseMPayload**](UserlogintypeGetAutocompleteV2ResponseMPayload.md) |  | 
+
+## Example
+
+```python
+from eZmaxApi.models.userlogintype_get_autocomplete_v2_response import UserlogintypeGetAutocompleteV2Response
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UserlogintypeGetAutocompleteV2Response from a JSON string
+userlogintype_get_autocomplete_v2_response_instance = UserlogintypeGetAutocompleteV2Response.from_json(json)
+# print the JSON string representation of the object
+print UserlogintypeGetAutocompleteV2Response.to_json()
+
+# convert the object into a dict
+userlogintype_get_autocomplete_v2_response_dict = userlogintype_get_autocomplete_v2_response_instance.to_dict()
+# create an instance of UserlogintypeGetAutocompleteV2Response from a dict
+userlogintype_get_autocomplete_v2_response_form_dict = userlogintype_get_autocomplete_v2_response.from_dict(userlogintype_get_autocomplete_v2_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/UserlogintypeGetAutocompleteV2ResponseMPayload.md

@@ -0,0 +1,29 @@
+# UserlogintypeGetAutocompleteV2ResponseMPayload
+
+Payload for POST /2/object/userlogintype/getAutocomplete
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**a_obj_userlogintype** | [**List[UserlogintypeAutocompleteElementResponse]**](UserlogintypeAutocompleteElementResponse.md) | An array of Userlogintype autocomplete element response. | 
+
+## Example
+
+```python
+from eZmaxApi.models.userlogintype_get_autocomplete_v2_response_m_payload import UserlogintypeGetAutocompleteV2ResponseMPayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UserlogintypeGetAutocompleteV2ResponseMPayload from a JSON string
+userlogintype_get_autocomplete_v2_response_m_payload_instance = UserlogintypeGetAutocompleteV2ResponseMPayload.from_json(json)
+# print the JSON string representation of the object
+print UserlogintypeGetAutocompleteV2ResponseMPayload.to_json()
+
+# convert the object into a dict
+userlogintype_get_autocomplete_v2_response_m_payload_dict = userlogintype_get_autocomplete_v2_response_m_payload_instance.to_dict()
+# create an instance of UserlogintypeGetAutocompleteV2ResponseMPayload from a dict
+userlogintype_get_autocomplete_v2_response_m_payload_form_dict = userlogintype_get_autocomplete_v2_response_m_payload.from_dict(userlogintype_get_autocomplete_v2_response_m_payload_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eZmaxApi/__init__.py

@@ -83,6 +83,7 @@
 from eZmaxApi.api.object_usergroup_api import ObjectUsergroupApi
 from eZmaxApi.api.object_usergroupdelegation_api import ObjectUsergroupdelegationApi
 from eZmaxApi.api.object_usergroupmembership_api import ObjectUsergroupmembershipApi
+from eZmaxApi.api.object_userlogintype_api import ObjectUserlogintypeApi
 from eZmaxApi.api.object_userstaged_api import ObjectUserstagedApi
 from eZmaxApi.api.object_variableexpense_api import ObjectVariableexpenseApi
 from eZmaxApi.api.object_versionhistory_api import ObjectVersionhistoryApi
@@ -1103,6 +1104,9 @@
 from eZmaxApi.models.usergroupmembership_request_compound import UsergroupmembershipRequestCompound
 from eZmaxApi.models.usergroupmembership_response import UsergroupmembershipResponse
 from eZmaxApi.models.usergroupmembership_response_compound import UsergroupmembershipResponseCompound
+from eZmaxApi.models.userlogintype_autocomplete_element_response import UserlogintypeAutocompleteElementResponse
+from eZmaxApi.models.userlogintype_get_autocomplete_v2_response import UserlogintypeGetAutocompleteV2Response
+from eZmaxApi.models.userlogintype_get_autocomplete_v2_response_m_payload import UserlogintypeGetAutocompleteV2ResponseMPayload
 from eZmaxApi.models.userstaged_create_user_v1_response import UserstagedCreateUserV1Response
 from eZmaxApi.models.userstaged_create_user_v1_response_m_payload import UserstagedCreateUserV1ResponseMPayload
 from eZmaxApi.models.userstaged_delete_object_v1_response import UserstagedDeleteObjectV1Response

eZmaxApi/api/__init__.py

@@ -66,6 +66,7 @@
 from eZmaxApi.api.object_usergroup_api import ObjectUsergroupApi
 from eZmaxApi.api.object_usergroupdelegation_api import ObjectUsergroupdelegationApi
 from eZmaxApi.api.object_usergroupmembership_api import ObjectUsergroupmembershipApi
+from eZmaxApi.api.object_userlogintype_api import ObjectUserlogintypeApi
 from eZmaxApi.api.object_userstaged_api import ObjectUserstagedApi
 from eZmaxApi.api.object_variableexpense_api import ObjectVariableexpenseApi
 from eZmaxApi.api.object_versionhistory_api import ObjectVersionhistoryApi