Testing various api features
Project description
Getting started
Testing various api features
How to Build
You must have Python 2 >=2.7.9
or Python 3 >=3.4
installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc.
These dependencies are defined in the requirements.txt
file that comes with the SDK.
To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps at https://pip.pypa.io/en/stable/installing/.
Python and PIP executables should be defined in your PATH. Open command prompt and type pip --version
.
This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.
- Using command line, navigate to the directory containing the generated files (including
requirements.txt
) for the SDK. - Run the command
pip install -r requirements.txt
. This should install all the required dependencies.
How to Use
The following section explains how to use the Tester SDK package in a new project.
1. Open Project in an IDE
Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on Open
in PyCharm to browse to your generated SDK directory and then click OK
.
The project files will be displayed in the side bar as follows:
2. Add a new Test Project
Create a new directory by right clicking on the solution name as shown below:
Name the directory as "test"
Add a python file to this project with the name "testsdk"
Name it "testsdk"
In your python file you will be required to import the generated python library using the following code lines
from api-tester-upload-test.hello_from_haider import HelloFromHaider
After this you can write code to instantiate an API client object, get a controller object and make API calls. Sample code is given in the subsequent sections.
3. Run the Test Project
To run the file within your test project, right click on your Python file inside your Test project and click on Run
How to Test
You can test the generated SDK and the server with automatically generated test cases. unittest is used as the testing framework and nose is used as the test runner. You can run the tests as follows:
- From terminal/cmd navigate to the root directory of the SDK.
- Invoke
pip install -r test-requirements.txt
- Invoke
nosetests
Initialization
You need the following information for initializing the API client.
Parameter | Description |
---|---|
square_version | 2019-05-08 |
API client can be initialized as following.
# Configuration parameters
square_version = '2019-05-08' # 2019-05-08
client = HelloFromHaider(square_version)
Class Reference
List of Controllers
- FormParamsController
- QueryParamsController
- BodyParamsController
- ErrorCodesController
- ResponseTypesController
- QueryParamController
- TemplateParamsController
- HeaderController
- EchoController
FormParamsController
Get controller instance
An instance of the FormParamsController
class can be accessed from the API Client.
form_params_controller = client.form_params
date_as_optional
TODO: Add a method description
def date_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{ \"date\" : \"1994-02-13\" }"
body = json.loads(body_value)
result = form_params_controller.date_as_optional(body)
dynamic_as_optional
TODO: Add a method description
def dynamic_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{ \"dynamic\" : { \"dynamic\" : \"test\" } }"
body = json.loads(body_value)
result = form_params_controller.dynamic_as_optional(body)
string_as_optional
TODO: Add a method description
def string_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"string\" : \"test\"}"
body = json.loads(body_value)
result = form_params_controller.string_as_optional(body)
precision_as_optional
TODO: Add a method description
def precision_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"precision\" : 1.23}"
body = json.loads(body_value)
result = form_params_controller.precision_as_optional(body)
long_as_optional
TODO: Add a method description
def long_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"long\" : 123123}"
body = json.loads(body_value)
result = form_params_controller.long_as_optional(body)
send_number_as_optional
TODO: Add a method description
def send_number_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"number\" : 1}"
body = json.loads(body_value)
result = form_params_controller.send_number_as_optional(body)
send_datetime_optional_in_endpoint
TODO: Add a method description
def send_datetime_optional_in_endpoint(self,
body=None)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Optional |
TODO: Add a parameter description |
Example Usage
body = datetime.now()
result = form_params_controller.send_datetime_optional_in_endpoint(body)
send_optional_unix_time_stamp_in_model_body
TODO: Add a method description
def send_optional_unix_time_stamp_in_model_body(self,
date_time)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Required |
TODO: Add a parameter description |
Example Usage
date_time = UnixDateTime()
result = form_params_controller.send_optional_unix_time_stamp_in_model_body(date_time)
send_optional_unix_time_stamp_in_nested_model_body
TODO: Add a method description
def send_optional_unix_time_stamp_in_nested_model_body(self,
date_time)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Required |
TODO: Add a parameter description |
Example Usage
date_time_value = "{\"dateTime\" : {\"dateTime\":1484719381}}"
date_time = json.loads(date_time_value)
result = form_params_controller.send_optional_unix_time_stamp_in_nested_model_body(date_time)
send_rfc_1123_date_time_in_nested_model
TODO: Add a method description
def send_rfc_1123_date_time_in_nested_model(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body = SendRfc1123DateTime()
result = form_params_controller.send_rfc_1123_date_time_in_nested_model(body)
send_rfc_1123_date_time_in_model
TODO: Add a method description
def send_rfc_1123_date_time_in_model(self,
date_time)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Required |
TODO: Add a parameter description |
Example Usage
date_time = ModelWithOptionalRfc1123DateTime()
result = form_params_controller.send_rfc_1123_date_time_in_model(date_time)
send_optional_datetime_in_model
TODO: Add a method description
def send_optional_datetime_in_model(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body = ModelWithOptionalRfc3339DateTime()
result = form_params_controller.send_optional_datetime_in_model(body)
send_rfc_339_date_time_in_nested_models
TODO: Add a method description
def send_rfc_339_date_time_in_nested_models(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body = SendRfc339DateTime()
result = form_params_controller.send_rfc_339_date_time_in_nested_models(body)
uuid_as_optional
TODO: Add a method description
def uuid_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{ \"uuid\" : \"123e4567-e89b-12d3-a456-426655440000\" }"
body = json.loads(body_value)
result = form_params_controller.uuid_as_optional(body)
send_optional_unix_date_time_in_body
TODO: Add a method description
def send_optional_unix_date_time_in_body(self,
date_time=None)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Optional |
TODO: Add a parameter description |
Example Usage
date_time = datetime.now()
result = form_params_controller.send_optional_unix_date_time_in_body(date_time)
send_optional_rfc_1123_in_body
TODO: Add a method description
def send_optional_rfc_1123_in_body(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body = datetime.now()
result = form_params_controller.send_optional_rfc_1123_in_body(body)
boolean_as_optional
TODO: Add a method description
def boolean_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"boolean\" : true}"
body = json.loads(body_value)
result = form_params_controller.boolean_as_optional(body)
send_string_in_form_with_new_line
TODO: Add a method description
def send_string_in_form_with_new_line(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"name\":\"farhan\", \"field\":\"QA\"}"
body = json.loads(body_value)
result = form_params_controller.send_string_in_form_with_new_line(body)
send_string_in_form_with_r
TODO: Add a method description
def send_string_in_form_with_r(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"name\":\"farhan\",\"field\":\"QA\"}"
body = json.loads(body_value)
result = form_params_controller.send_string_in_form_with_r(body)
send_string_in_form_with_r_n
TODO: Add a method description
def send_string_in_form_with_r_n(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"name\":\"farhan\",\"field\":\"QA\"}"
body = json.loads(body_value)
result = form_params_controller.send_string_in_form_with_r_n(body)
update_string_array_with_form
TODO: Add a method description
def update_string_array_with_form(self,
strings)
Parameters
Parameter | Tags | Description |
---|---|---|
strings | Required Collection |
TODO: Add a parameter description |
Example Usage
strings_value = '["abc", "def"]'
strings = json.loads(strings_value)
result = form_params_controller.update_string_array_with_form(strings)
send_integer_enum_array
TODO: Add a method description
def send_integer_enum_array(self,
suites)
Parameters
Parameter | Tags | Description |
---|---|---|
suites | Required Collection |
TODO: Add a parameter description |
Example Usage
suites = [SuiteCode.HEARTS,SuiteCode.CLUBS,SuiteCode.DIAMONDS,SuiteCode.SPADES,SuiteCode.CLUBS]
result = form_params_controller.send_integer_enum_array(suites)
send_string_enum_array
TODO: Add a method description
def send_string_enum_array(self,
days)
Parameters
Parameter | Tags | Description |
---|---|---|
days | Required Collection |
TODO: Add a parameter description |
Example Usage
days = [Days.TUESDAY,Days.SATURDAY,Days.MONDAY,Days.SUNDAY]
result = form_params_controller.send_string_enum_array(days)
send_delete_form_with_model_array
TODO: Add a method description
def send_delete_form_with_model_array(self,
models)
Parameters
Parameter | Tags | Description |
---|---|---|
models | Required Collection |
TODO: Add a parameter description |
Example Usage
models_value = "[{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}, {\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}]"
models = json.loads(models_value)
result = form_params_controller.send_delete_form_with_model_array(models)
update_model_array_with_form
TODO: Add a method description
def update_model_array_with_form(self,
models)
Parameters
Parameter | Tags | Description |
---|---|---|
models | Required Collection |
TODO: Add a parameter description |
Example Usage
models_value = "[{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}, {\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}]"
models = json.loads(models_value)
result = form_params_controller.update_model_array_with_form(models)
update_string_with_form
TODO: Add a method description
def update_string_with_form(self,
value)
Parameters
Parameter | Tags | Description |
---|---|---|
value | Required |
TODO: Add a parameter description |
Example Usage
value = 'TestString'
result = form_params_controller.update_string_with_form(value)
send_rfc_3339_date_time_array
TODO: Add a method description
def send_rfc_3339_date_time_array(self,
datetimes)
Parameters
Parameter | Tags | Description |
---|---|---|
datetimes | Required Collection |
TODO: Add a parameter description |
Example Usage
datetimes_value = ["1994-02-13T14:01:54.9571247Z","1994-02-13T14:01:54.9571247Z"]
datetimes = json.loads(datetimes_value)
result = form_params_controller.send_rfc_3339_date_time_array(datetimes)
send_mixed_array
Send a variety for form params. Returns file count and body params
def send_mixed_array(self,
options=dict())
Parameters
Parameter | Tags | Description |
---|---|---|
file | Required |
TODO: Add a parameter description |
integers | Required Collection |
TODO: Add a parameter description |
models | Required Collection |
TODO: Add a parameter description |
strings | Required Collection |
TODO: Add a parameter description |
Example Usage
collect = {}
file = open("pathtofile", 'rb')
collect['file'] = file
integers_value = "[1,2,3,4,5]"
integers = json.loads(integers_value)
collect['integers'] = integers
models_value = "[{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"},{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}]"
models = json.loads(models_value)
collect['models'] = models
strings_value = '["abc", "def"]'
strings = json.loads(strings_value)
collect['strings'] = strings
result = form_params_controller.send_mixed_array(collect)
update_model_with_form
TODO: Add a method description
def update_model_with_form(self,
model)
Parameters
Parameter | Tags | Description |
---|---|---|
model | Required |
TODO: Add a parameter description |
Example Usage
model_value = "{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}"
model = json.loads(model_value)
result = form_params_controller.update_model_with_form(model)
send_delete_form_1
TODO: Add a method description
def send_delete_form_1(self,
model)
Parameters
Parameter | Tags | Description |
---|---|---|
model | Required |
TODO: Add a parameter description |
Example Usage
model_value = "{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}"
model = json.loads(model_value)
result = form_params_controller.send_delete_form_1(model)
send_integer_array
TODO: Add a method description
def send_integer_array(self,
integers)
Parameters
Parameter | Tags | Description |
---|---|---|
integers | Required Collection |
TODO: Add a parameter description |
Example Usage
integers_value = "[1,2,3,4,5]"
integers = json.loads(integers_value)
result = form_params_controller.send_integer_array(integers)
send_string_array
TODO: Add a method description
def send_string_array(self,
strings)
Parameters
Parameter | Tags | Description |
---|---|---|
strings | Required Collection |
TODO: Add a parameter description |
Example Usage
strings_value = '["abc", "def"]'
strings = json.loads(strings_value)
result = form_params_controller.send_string_array(strings)
allow_dynamic_form_fields
TODO: Add a method description
def allow_dynamic_form_fields(self,
name,
_optional_form_parameters=None)
Parameters
Parameter | Tags | Description |
---|---|---|
name | Required |
TODO: Add a parameter description |
_optional_form_parameters | Optional |
Additional optional form parameters are supported by this method |
Example Usage
name = 'farhan'
# key-value map for optional form parameters
optional_form_parameters = { }
result = form_params_controller.allow_dynamic_form_fields(name, optional_form_parameters)
send_model_array
TODO: Add a method description
def send_model_array(self,
models)
Parameters
Parameter | Tags | Description |
---|---|---|
models | Required Collection |
TODO: Add a parameter description |
Example Usage
models_value = "[{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"},{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}]"
models = json.loads(models_value)
result = form_params_controller.send_model_array(models)
send_file
TODO: Add a method description
def send_file(self,
file)
Parameters
Parameter | Tags | Description |
---|---|---|
file | Required |
TODO: Add a parameter description |
Example Usage
file = open("pathtofile", 'rb')
result = form_params_controller.send_file(file)
send_multiple_files
TODO: Add a method description
def send_multiple_files(self,
file,
file_1)
Parameters
Parameter | Tags | Description |
---|---|---|
file | Required |
TODO: Add a parameter description |
file1 | Required |
TODO: Add a parameter description |
Example Usage
file = open("pathtofile", 'rb')
file_1 = open("pathtofile", 'rb')
result = form_params_controller.send_multiple_files(file, file_1)
send_string
TODO: Add a method description
def send_string(self,
value)
Parameters
Parameter | Tags | Description |
---|---|---|
value | Required |
TODO: Add a parameter description |
Example Usage
value = 'TestString'
result = form_params_controller.send_string(value)
send_long
TODO: Add a method description
def send_long(self,
value)
Parameters
Parameter | Tags | Description |
---|---|---|
value | Required |
TODO: Add a parameter description |
Example Usage
value = 5147483647
result = form_params_controller.send_long(value)
send_model
TODO: Add a method description
def send_model(self,
model)
Parameters
Parameter | Tags | Description |
---|---|---|
model | Required |
TODO: Add a parameter description |
Example Usage
model_value = "{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}"
model = json.loads(model_value)
result = form_params_controller.send_model(model)
send_unix_date_time_array
TODO: Add a method description
def send_unix_date_time_array(self,
datetimes)
Parameters
Parameter | Tags | Description |
---|---|---|
datetimes | Required Collection |
TODO: Add a parameter description |
Example Usage
datetimes_value = [1484719381,1484719381]
datetimes = json.loads(datetimes_value)
result = form_params_controller.send_unix_date_time_array(datetimes)
send_rfc_1123_date_time_array
TODO: Add a method description
def send_rfc_1123_date_time_array(self,
datetimes)
Parameters
Parameter | Tags | Description |
---|---|---|
datetimes | Required Collection |
TODO: Add a parameter description |
Example Usage
datetimes_value = ["Sun, 06 Nov 1994 08:49:37 GMT","Sun, 06 Nov 1994 08:49:37 GMT"]
datetimes = json.loads(datetimes_value)
result = form_params_controller.send_rfc_1123_date_time_array(datetimes)
send_rfc_1123_date_time
TODO: Add a method description
def send_rfc_1123_date_time(self,
datetime)
Parameters
Parameter | Tags | Description |
---|---|---|
datetime | Required |
TODO: Add a parameter description |
Example Usage
datetime = Sun, 06 Nov 1994 08:49:37 GMT
result = form_params_controller.send_rfc_1123_date_time(datetime)
send_rfc_3339_date_time
TODO: Add a method description
def send_rfc_3339_date_time(self,
datetime)
Parameters
Parameter | Tags | Description |
---|---|---|
datetime | Required |
TODO: Add a parameter description |
Example Usage
datetime = 1994-02-13T14:01:54.9571247Z
result = form_params_controller.send_rfc_3339_date_time(datetime)
send_date_array
TODO: Add a method description
def send_date_array(self,
dates)
Parameters
Parameter | Tags | Description |
---|---|---|
dates | Required Collection |
TODO: Add a parameter description |
Example Usage
dates_value = ["1994-02-13","1994-02-13"]
dates = json.loads(dates_value)
result = form_params_controller.send_date_array(dates)
send_date
TODO: Add a method description
def send_date(self,
date)
Parameters
Parameter | Tags | Description |
---|---|---|
date | Required |
TODO: Add a parameter description |
Example Usage
date = 1994-02-13
result = form_params_controller.send_date(date)
send_unix_date_time
TODO: Add a method description
def send_unix_date_time(self,
datetime)
Parameters
Parameter | Tags | Description |
---|---|---|
datetime | Required |
TODO: Add a parameter description |
Example Usage
datetime = 1484719381
result = form_params_controller.send_unix_date_time(datetime)
send_delete_multipart
TODO: Add a method description
def send_delete_multipart(self,
file)
Parameters
Parameter | Tags | Description |
---|---|---|
file | Required |
TODO: Add a parameter description |
Example Usage
file = open("pathtofile", 'rb')
result = form_params_controller.send_delete_multipart(file)
send_delete_form
TODO: Add a method description
def send_delete_form(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"name\":\"farhan\",\"field\":\"&&&\"}"
body = json.loads(body_value)
result = form_params_controller.send_delete_form(body)
QueryParamsController
Get controller instance
An instance of the QueryParamsController
class can be accessed from the API Client.
query_params_controller = client.query_params
boolean_as_optional
TODO: Add a method description
def boolean_as_optional(self,
boolean,
boolean_1=None)
Parameters
Parameter | Tags | Description |
---|---|---|
boolean | Required |
TODO: Add a parameter description |
boolean1 | Optional |
TODO: Add a parameter description |
Example Usage
boolean = True
boolean_1 = True
result = query_params_controller.boolean_as_optional(boolean, boolean_1)
rfc_1123_datetime_as_optional
TODO: Add a method description
def rfc_1123_datetime_as_optional(self,
date_time,
date_time_1=None)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Required |
TODO: Add a parameter description |
dateTime1 | Optional |
TODO: Add a parameter description |
Example Usage
date_time = Sun, 06 Nov 1994 08:49:37 GMT
date_time_1 = Sun, 06 Nov 1994 08:49:37 GMT
result = query_params_controller.rfc_1123_datetime_as_optional(date_time, date_time_1)
rfc_3339_datetime_as_optional
TODO: Add a method description
def rfc_3339_datetime_as_optional(self,
date_time,
date_time_1=None)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Required |
TODO: Add a parameter description |
dateTime1 | Optional |
TODO: Add a parameter description |
Example Usage
date_time = 1994-02-13T14:01:54.9571247Z
date_time_1 = 1994-02-13T14:01:54.9571247Z
result = query_params_controller.rfc_3339_datetime_as_optional(date_time, date_time_1)
send_date_as_optional
TODO: Add a method description
def send_date_as_optional(self,
date,
date_1=None)
Parameters
Parameter | Tags | Description |
---|---|---|
date | Required |
TODO: Add a parameter description |
date1 | Optional |
TODO: Add a parameter description |
Example Usage
date = 1994-02-13
date_1 = 1994-02-13
result = query_params_controller.send_date_as_optional(date, date_1)
send_string_as_optional
TODO: Add a method description
def send_string_as_optional(self,
string,
string_1=None)
Parameters
Parameter | Tags | Description |
---|---|---|
string | Required |
TODO: Add a parameter description |
string1 | Optional |
TODO: Add a parameter description |
Example Usage
string = 'test'
string_1 = 'test'
result = query_params_controller.send_string_as_optional(string, string_1)
unixdatetime_as_optional
TODO: Add a method description
def unixdatetime_as_optional(self,
date_time,
date_time_1=None)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Required |
TODO: Add a parameter description |
dateTime1 | Optional |
TODO: Add a parameter description |
Example Usage
date_time = 1484719381
date_time_1 = 1484719381
result = query_params_controller.unixdatetime_as_optional(date_time, date_time_1)
send_number_as_optional
TODO: Add a method description
def send_number_as_optional(self,
number,
number_1=None)
Parameters
Parameter | Tags | Description |
---|---|---|
number | Required |
TODO: Add a parameter description |
number1 | Optional |
TODO: Add a parameter description |
Example Usage
number = 1
number_1 = 1
result = query_params_controller.send_number_as_optional(number, number_1)
send_long_as_optional
TODO: Add a method description
def send_long_as_optional(self,
long,
long_1=None)
Parameters
Parameter | Tags | Description |
---|---|---|
long | Required |
TODO: Add a parameter description |
long1 | Optional |
TODO: Add a parameter description |
Example Usage
long = 123123
long_1 = 123123
result = query_params_controller.send_long_as_optional(long, long_1)
precision_as_optional
TODO: Add a method description
def precision_as_optional(self,
precision,
precision_1=None)
Parameters
Parameter | Tags | Description |
---|---|---|
precision | Required |
TODO: Add a parameter description |
precision1 | Optional |
TODO: Add a parameter description |
Example Usage
precision = 1.23
precision_1 = 1.23
result = query_params_controller.precision_as_optional(precision, precision_1)
BodyParamsController
Get controller instance
An instance of the BodyParamsController
class can be accessed from the API Client.
body_params_controller = client.body_params
send_number_as_optional
TODO: Add a method description
def send_number_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"number\" : 1}"
body = json.loads(body_value)
result = body_params_controller.send_number_as_optional(body)
send_optional_datetime_in_model
TODO: Add a method description
def send_optional_datetime_in_model(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body = ModelWithOptionalRfc3339DateTime()
result = body_params_controller.send_optional_datetime_in_model(body)
send_rfc_339_date_time_in_nested_models
TODO: Add a method description
def send_rfc_339_date_time_in_nested_models(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body = SendRfc339DateTime()
result = body_params_controller.send_rfc_339_date_time_in_nested_models(body)
uuid_as_optional
TODO: Add a method description
def uuid_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{ \"uuid\" : \"123e4567-e89b-12d3-a456-426655440000\" }"
body = json.loads(body_value)
result = body_params_controller.uuid_as_optional(body)
date_as_optional
TODO: Add a method description
def date_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{ \"date\" : \"1994-02-13\" }"
body = json.loads(body_value)
result = body_params_controller.date_as_optional(body)
dynamic_as_optional
TODO: Add a method description
def dynamic_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{ \"dynamic\" : { \"dynamic\" : \"test\" } }"
body = json.loads(body_value)
result = body_params_controller.dynamic_as_optional(body)
string_as_optional
TODO: Add a method description
def string_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"string\" : \"test\"}"
body = json.loads(body_value)
result = body_params_controller.string_as_optional(body)
precision_as_optional
TODO: Add a method description
def precision_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"precision\" : 1.23}"
body = json.loads(body_value)
result = body_params_controller.precision_as_optional(body)
long_as_optional
TODO: Add a method description
def long_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"long\" : 123123}"
body = json.loads(body_value)
result = body_params_controller.long_as_optional(body)
send_optional_unix_date_time_in_body
TODO: Add a method description
def send_optional_unix_date_time_in_body(self,
date_time=None)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Optional |
TODO: Add a parameter description |
Example Usage
date_time = datetime.now()
result = body_params_controller.send_optional_unix_date_time_in_body(date_time)
send_optional_rfc_1123_in_body
TODO: Add a method description
def send_optional_rfc_1123_in_body(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body = datetime.now()
result = body_params_controller.send_optional_rfc_1123_in_body(body)
send_datetime_optional_in_endpoint
TODO: Add a method description
def send_datetime_optional_in_endpoint(self,
body=None)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Optional |
TODO: Add a parameter description |
Example Usage
body = datetime.now()
result = body_params_controller.send_datetime_optional_in_endpoint(body)
send_optional_unix_time_stamp_in_model_body
TODO: Add a method description
def send_optional_unix_time_stamp_in_model_body(self,
date_time)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Required |
TODO: Add a parameter description |
Example Usage
date_time = UnixDateTime()
result = body_params_controller.send_optional_unix_time_stamp_in_model_body(date_time)
send_optional_unix_time_stamp_in_nested_model_body
TODO: Add a method description
def send_optional_unix_time_stamp_in_nested_model_body(self,
date_time)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Required |
TODO: Add a parameter description |
Example Usage
date_time_value = "{\"dateTime\" : {\"dateTime\":1484719381}}"
date_time = json.loads(date_time_value)
result = body_params_controller.send_optional_unix_time_stamp_in_nested_model_body(date_time)
send_rfc_1123_date_time_in_nested_model
TODO: Add a method description
def send_rfc_1123_date_time_in_nested_model(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body = SendRfc1123DateTime()
result = body_params_controller.send_rfc_1123_date_time_in_nested_model(body)
send_rfc_1123_date_time_in_model
TODO: Add a method description
def send_rfc_1123_date_time_in_model(self,
date_time)
Parameters
Parameter | Tags | Description |
---|---|---|
dateTime | Required |
TODO: Add a parameter description |
Example Usage
date_time = ModelWithOptionalRfc1123DateTime()
result = body_params_controller.send_rfc_1123_date_time_in_model(date_time)
boolean_as_optional
TODO: Add a method description
def boolean_as_optional(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"boolean\" : true}"
body = json.loads(body_value)
result = body_params_controller.boolean_as_optional(body)
send_string_with_new_line
TODO: Add a method description
def send_string_with_new_line(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"name\":\"farhan\", \"field\":\"QA\"}"
body = json.loads(body_value)
result = body_params_controller.send_string_with_new_line(body)
send_string_with_r
TODO: Add a method description
def send_string_with_r(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"name\":\"farhan\",\"field\":\"QA\"}"
body = json.loads(body_value)
result = body_params_controller.send_string_with_r(body)
send_string_in_body_with_r_n
TODO: Add a method description
def send_string_in_body_with_r_n(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"name\":\"farhan\",\"field\":\"QA\"}"
body = json.loads(body_value)
result = body_params_controller.send_string_in_body_with_r_n(body)
send_delete_body_with_model
TODO: Add a method description
def send_delete_body_with_model(self,
model)
Parameters
Parameter | Tags | Description |
---|---|---|
model | Required |
TODO: Add a parameter description |
Example Usage
model_value = "{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}"
model = json.loads(model_value)
result = body_params_controller.send_delete_body_with_model(model)
send_delete_body_with_model_array
TODO: Add a method description
def send_delete_body_with_model_array(self,
models)
Parameters
Parameter | Tags | Description |
---|---|---|
models | Required Collection |
TODO: Add a parameter description |
Example Usage
models_value = "[{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}, {\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}]"
models = json.loads(models_value)
result = body_params_controller.send_delete_body_with_model_array(models)
update_model_array
TODO: Add a method description
def update_model_array(self,
models)
Parameters
Parameter | Tags | Description |
---|---|---|
models | Required Collection |
TODO: Add a parameter description |
Example Usage
models_value = "[{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}, {\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}]"
models = json.loads(models_value)
result = body_params_controller.update_model_array(models)
update_string_1
TODO: Add a method description
def update_string_1(self,
value)
Parameters
Parameter | Tags | Description |
---|---|---|
value | Required |
TODO: Add a parameter description |
Example Usage
value = 'TestString'
result = body_params_controller.update_string_1(value)
update_string_array
TODO: Add a method description
def update_string_array(self,
strings)
Parameters
Parameter | Tags | Description |
---|---|---|
strings | Required Collection |
TODO: Add a parameter description |
Example Usage
strings_value = '["abc", "def"]'
strings = json.loads(strings_value)
result = body_params_controller.update_string_array(strings)
send_string_enum_array
TODO: Add a method description
def send_string_enum_array(self,
days)
Parameters
Parameter | Tags | Description |
---|---|---|
days | Required Collection |
TODO: Add a parameter description |
Example Usage
days = [Days.TUESDAY,Days.SATURDAY,Days.MONDAY,Days.SUNDAY]
result = body_params_controller.send_string_enum_array(days)
send_integer_enum_array
TODO: Add a method description
def send_integer_enum_array(self,
suites)
Parameters
Parameter | Tags | Description |
---|---|---|
suites | Required Collection |
TODO: Add a parameter description |
Example Usage
suites = [SuiteCode.HEARTS,SuiteCode.CLUBS,SuiteCode.DIAMONDS,SuiteCode.SPADES,SuiteCode.CLUBS]
result = body_params_controller.send_integer_enum_array(suites)
update_model
TODO: Add a method description
def update_model(self,
model)
Parameters
Parameter | Tags | Description |
---|---|---|
model | Required |
TODO: Add a parameter description |
Example Usage
model_value = "{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}"
model = json.loads(model_value)
result = body_params_controller.update_model(model)
send_string
TODO: Add a method description
def send_string(self,
value)
Parameters
Parameter | Tags | Description |
---|---|---|
value | Required |
TODO: Add a parameter description |
Example Usage
value = 'TestString'
result = body_params_controller.send_string(value)
update_string
TODO: Add a method description
def update_string(self,
value)
Parameters
Parameter | Tags | Description |
---|---|---|
value | Required |
TODO: Add a parameter description |
Example Usage
value = 'TestString'
result = body_params_controller.update_string(value)
send_integer_array
TODO: Add a method description
def send_integer_array(self,
integers)
Parameters
Parameter | Tags | Description |
---|---|---|
integers | Required Collection |
TODO: Add a parameter description |
Example Usage
integers_value = "[1,2,3,4,5]"
integers = json.loads(integers_value)
result = body_params_controller.send_integer_array(integers)
wrap_body_in_object
TODO: Add a method description
def wrap_body_in_object(self,
field,
name)
Parameters
Parameter | Tags | Description |
---|---|---|
field | Required |
TODO: Add a parameter description |
name | Required |
TODO: Add a parameter description |
Example Usage
field = 'QA'
name = 'farhan'
result = body_params_controller.wrap_body_in_object(field, name)
validate_required_parameter
TODO: Add a method description
def validate_required_parameter(self,
model,
option=None)
Parameters
Parameter | Tags | Description |
---|---|---|
model | Required |
TODO: Add a parameter description |
option | Optional |
TODO: Add a parameter description |
Example Usage
model_value = "{\"name\":\"farhan\", \"field\": \"QA\"}"
model = json.loads(model_value)
option = '...'
result = body_params_controller.validate_required_parameter(model, option)
additional_model_parameters_1
TODO: Add a method description
def additional_model_parameters_1(self,
model)
Parameters
Parameter | Tags | Description |
---|---|---|
model | Required |
TODO: Add a parameter description |
Example Usage
model_value = "{\"name\":\"farhan\", \"field\":\"QA\", \"address\": \"Ghori Town\", \"Job\": {\"company\": \"APIMATIC\", \"location\":\"NUST\"}}"
model = json.loads(model_value)
result = body_params_controller.additional_model_parameters_1(model)
send_model
TODO: Add a method description
def send_model(self,
model)
Parameters
Parameter | Tags | Description |
---|---|---|
model | Required |
TODO: Add a parameter description |
Example Usage
model_value = "{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}"
model = json.loads(model_value)
result = body_params_controller.send_model(model)
send_model_array
TODO: Add a method description
def send_model_array(self,
models)
Parameters
Parameter | Tags | Description |
---|---|---|
models | Required Collection |
TODO: Add a parameter description |
Example Usage
models_value = "[{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"},{\"name\":\"Shahid Khaliq\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"boss\":{\"personType\":\"Boss\",\"name\":\"Zeeshan Ejaz\",\"age\":5147483645,\"address\":\"H # 531, S # 20\",\"uid\":\"123321\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\",\"salary\":20000,\"department\":\"Software Development\",\"joiningDay\":\"Saturday\",\"workingDays\":[\"Monday\",\"Tuesday\",\"Friday\"],\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\",\"promotedAt\":1484719381},\"dependents\":[{\"name\":\"Future Wife\",\"age\":5147483649,\"address\":\"H # 531, S # 20\",\"uid\":\"123412\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"},{\"name\":\"Future Kid\",\"age\":5147483648,\"address\":\"H # 531, S # 20\",\"uid\":\"312341\",\"birthday\":\"1994-02-13\",\"birthtime\":\"1994-02-13T14:01:54.9571247Z\"}],\"hiredAt\":\"Sun, 06 Nov 1994 08:49:37 GMT\"}]"
models = json.loads(models_value)
result = body_params_controller.send_model_array(models)
send_dynamic
TODO: Add a method description
def send_dynamic(self,
dynamic)
Parameters
Parameter | Tags | Description |
---|---|---|
dynamic | Required |
TODO: Add a parameter description |
Example Usage
dynamic_value = "{\"uid\": \"1123213\", \"name\": \"Shahid\"}"
dynamic = json.loads(dynamic_value)
result = body_params_controller.send_dynamic(dynamic)
send_rfc_3339_date_time_array
TODO: Add a method description
def send_rfc_3339_date_time_array(self,
datetimes)
Parameters
Parameter | Tags | Description |
---|---|---|
datetimes | Required Collection |
TODO: Add a parameter description |
Example Usage
datetimes_value = ["1994-02-13T14:01:54.9571247Z","1994-02-13T14:01:54.9571247Z"]
datetimes = json.loads(datetimes_value)
result = body_params_controller.send_rfc_3339_date_time_array(datetimes)
send_string_array
sends a string body param
def send_string_array(self,
sarray)
Parameters
Parameter | Tags | Description |
---|---|---|
sarray | Required Collection |
TODO: Add a parameter description |
Example Usage
sarray_value = '["abc", "def"]'
sarray = json.loads(sarray_value)
result = body_params_controller.send_string_array(sarray)
additional_model_parameters
TODO: Add a method description
def additional_model_parameters(self,
model)
Parameters
Parameter | Tags | Description |
---|---|---|
model | Required |
TODO: Add a parameter description |
Example Usage
model_value = "{\"name\":\"farhan\", \"field\":\"QA\", \"address\": \"Ghori Town\", \"Job\": {\"company\": \"APIMATIC\", \"location\":\"NUST\"}}"
model = json.loads(model_value)
result = body_params_controller.additional_model_parameters(model)
send_unix_date_time_array
TODO: Add a method description
def send_unix_date_time_array(self,
datetimes)
Parameters
Parameter | Tags | Description |
---|---|---|
datetimes | Required Collection |
TODO: Add a parameter description |
Example Usage
datetimes_value = [1484719381,1484719381]
datetimes = json.loads(datetimes_value)
result = body_params_controller.send_unix_date_time_array(datetimes)
send_rfc_1123_date_time_array
TODO: Add a method description
def send_rfc_1123_date_time_array(self,
datetimes)
Parameters
Parameter | Tags | Description |
---|---|---|
datetimes | Required Collection |
TODO: Add a parameter description |
Example Usage
datetimes_value = ["Sun, 06 Nov 1994 08:49:37 GMT","Sun, 06 Nov 1994 08:49:37 GMT"]
datetimes = json.loads(datetimes_value)
result = body_params_controller.send_rfc_1123_date_time_array(datetimes)
send_delete_plain_text
TODO: Add a method description
def send_delete_plain_text(self,
text_string)
Parameters
Parameter | Tags | Description |
---|---|---|
textString | Required |
TODO: Add a parameter description |
Example Usage
text_string = 'farhan
nouman'
result = body_params_controller.send_delete_plain_text(text_string)
send_date_array
TODO: Add a method description
def send_date_array(self,
dates)
Parameters
Parameter | Tags | Description |
---|---|---|
dates | Required Collection |
TODO: Add a parameter description |
Example Usage
dates_value = ["1994-02-13", "1994-02-13"]
dates = json.loads(dates_value)
result = body_params_controller.send_date_array(dates)
send_rfc_3339_date_time
TODO: Add a method description
def send_rfc_3339_date_time(self,
datetime)
Parameters
Parameter | Tags | Description |
---|---|---|
datetime | Required |
TODO: Add a parameter description |
Example Usage
datetime = 1994-02-13T14:01:54.9571247Z
result = body_params_controller.send_rfc_3339_date_time(datetime)
send_rfc_1123_date_time
TODO: Add a method description
def send_rfc_1123_date_time(self,
datetime)
Parameters
Parameter | Tags | Description |
---|---|---|
datetime | Required |
TODO: Add a parameter description |
Example Usage
datetime = Sun, 06 Nov 1994 08:49:37 GMT
result = body_params_controller.send_rfc_1123_date_time(datetime)
send_unix_date_time
TODO: Add a method description
def send_unix_date_time(self,
datetime)
Parameters
Parameter | Tags | Description |
---|---|---|
datetime | Required |
TODO: Add a parameter description |
Example Usage
datetime = 1484719381
result = body_params_controller.send_unix_date_time(datetime)
send_date
TODO: Add a method description
def send_date(self,
date)
Parameters
Parameter | Tags | Description |
---|---|---|
date | Required |
TODO: Add a parameter description |
Example Usage
date = 1994-02-13
result = body_params_controller.send_date(date)
send_delete_body
TODO: Add a method description
def send_delete_body(self,
body)
Parameters
Parameter | Tags | Description |
---|---|---|
body | Required |
TODO: Add a parameter description |
Example Usage
body_value = "{\"name\": \"farhan\", \"field\": \"QA\"}"
body = json.loads(body_value)
result = body_params_controller.send_delete_body(body)
ErrorCodesController
Get controller instance
An instance of the ErrorCodesController
class can be accessed from the API Client.
error_codes_controller = client.error_codes
date_in_exception
TODO: Add a method description
def date_in_exception(self)
Example Usage
result = error_codes_controller.date_in_exception()
Errors
Error Code | Error Description |
---|---|
444 | date in exception |
uuid_in_exception
TODO: Add a method description
def uuid_in_exception(self)
Example Usage
result = error_codes_controller.uuid_in_exception()
Errors
Error Code | Error Description |
---|---|
444 | uuid in exception |
dynamic_in_exception
TODO: Add a method description
def dynamic_in_exception(self)
Example Usage
result = error_codes_controller.dynamic_in_exception()
Errors
Error Code | Error Description |
---|---|
444 | dynamic in Exception |
precision_in_exception
TODO: Add a method description
def precision_in_exception(self)
Example Usage
result = error_codes_controller.precision_in_exception()
Errors
Error Code | Error Description |
---|---|
444 | precision in Exception |
boolean_in_exception
TODO: Add a method description
def boolean_in_exception(self)
Example Usage
result = error_codes_controller.boolean_in_exception()
Errors
Error Code | Error Description |
---|---|
444 | Boolean in Exception |
long_in_exception
TODO: Add a method description
def long_in_exception(self)
Example Usage
result = error_codes_controller.long_in_exception()
Errors
Error Code | Error Description |
---|---|
444 | long in exception |
number_in_exception
TODO: Add a method description
def number_in_exception(self)
Example Usage
result = error_codes_controller.number_in_exception()
Errors
Error Code | Error Description |
---|---|
444 | number in exception |
get_exception_with_string
TODO: Add a method description
def get_exception_with_string(self)
Example Usage
result = error_codes_controller.get_exception_with_string()
Errors
Error Code | Error Description |
---|---|
444 | exception with string |
receive_endpoint_level_exception
TODO: Add a method description
def receive_endpoint_level_exception(self)
Example Usage
result = error_codes_controller.receive_endpoint_level_exception()
Errors
Error Code | Error Description |
---|---|
451 | caught endpoint exception |
receive_global_level_exception
TODO: Add a method description
def receive_global_level_exception(self)
Example Usage
result = error_codes_controller.receive_global_level_exception()
receive_exception_with_rfc_3339_datetime
TODO: Add a method description
def receive_exception_with_rfc_3339_datetime(self)
Example Usage
result = error_codes_controller.receive_exception_with_rfc_3339_datetime()
Errors
Error Code | Error Description |
---|---|
444 | DateTime Exception |
receive_exception_with_unixtimestamp_exception
TODO: Add a method description
def receive_exception_with_unixtimestamp_exception(self)
Example Usage
result = error_codes_controller.receive_exception_with_unixtimestamp_exception()
Errors
Error Code | Error Description |
---|---|
444 | unixtimestamp exception |
receive_exception_with_rfc_1123_datetime
TODO: Add a method description
def receive_exception_with_rfc_1123_datetime(self)
Example Usage
result = error_codes_controller.receive_exception_with_rfc_1123_datetime()
Errors
Error Code | Error Description |
---|---|
444 | Rfc1123 Exception |
get_401
TODO: Add a method description
def get_401(self)
Example Usage
result = error_codes_controller.get_401()
Errors
Error Code | Error Description |
---|---|
401 | 401 Local |
421 | Default |
431 | Default |
432 | Default |
441 | Default |
0 | Invalid response. |
get_501
TODO: Add a method description
def get_501(self)
Example Usage
result = error_codes_controller.get_501()
Errors
Error Code | Error Description |
---|---|
501 | error 501 |
get_400
TODO: Add a method description
def get_400(self)
Example Usage
result = error_codes_controller.get_400()
get_500
TODO: Add a method description
def get_500(self)
Example Usage
result = error_codes_controller.get_500()
catch_412_global_error
TODO: Add a method description
def catch_412_global_error(self)
Example Usage
result = error_codes_controller.catch_412_global_error()
ResponseTypesController
Get controller instance
An instance of the ResponseTypesController
class can be accessed from the API Client.
response_types_controller = client.response_types
get_content_type_headers
TODO: Add a method description
def get_content_type_headers(self)
Example Usage
response_types_controller.get_content_type_headers()
get_integer_array
Get an array of integers.
def get_integer_array(self)
Example Usage
result = response_types_controller.get_integer_array()
get_dynamic
TODO: Add a method description
def get_dynamic(self)
Example Usage
result = response_types_controller.get_dynamic()
get_dynamic_array
TODO: Add a method description
def get_dynamic_array(self)
Example Usage
result = response_types_controller.get_dynamic_array()
get_3339_datetime
TODO: Add a method description
def get_3339_datetime(self)
Example Usage
result = response_types_controller.get_3339_datetime()
get_3339_datetime_array
TODO: Add a method description
def get_3339_datetime_array(self)
Example Usage
result = response_types_controller.get_3339_datetime_array()
get_boolean
TODO: Add a method description
def get_boolean(self)
Example Usage
result = response_types_controller.get_boolean()
get_boolean_array
TODO: Add a method description
def get_boolean_array(self)
Example Usage
result = response_types_controller.get_boolean_array()
get_headers
TODO: Add a method description
def get_headers(self)
Example Usage
response_types_controller.get_headers()
get_1123_date_time
TODO: Add a method description
def get_1123_date_time(self)
Example Usage
result = response_types_controller.get_1123_date_time()
get_unix_date_time
TODO: Add a method description
def get_unix_date_time(self)
Example Usage
result = response_types_controller.get_unix_date_time()
get_1123_date_time_array
TODO: Add a method description
def get_1123_date_time_array(self)
Example Usage
result = response_types_controller.get_1123_date_time_array()
get_unix_date_time_array
TODO: Add a method description
def get_unix_date_time_array(self)
Example Usage
result = response_types_controller.get_unix_date_time_array()
get_int_enum_array
TODO: Add a method description
def get_int_enum_array(self)
Example Usage
result = response_types_controller.get_int_enum_array()
get_binary
gets a binary object
def get_binary(self)
Example Usage
result = response_types_controller.get_binary()
get_integer
Gets a integer response
def get_integer(self)
Example Usage
result = response_types_controller.get_integer()
get_string_enum
TODO: Add a method description
def get_string_enum(self)
Example Usage
result = response_types_controller.get_string_enum()
get_model_array
TODO: Add a method description
def get_model_array(self)
Example Usage
result = response_types_controller.get_model_array()
get_long
TODO: Add a method description
def get_long(self)
Example Usage
result = response_types_controller.get_long()
get_model
TODO: Add a method description
def get_model(self)
Example Usage
result = response_types_controller.get_model()
get_string_enum_array
TODO: Add a method description
def get_string_enum_array(self)
Example Usage
result = response_types_controller.get_string_enum_array()
get_int_enum
TODO: Add a method description
def get_int_enum(self)
Example Usage
result = response_types_controller.get_int_enum()
get_precision
TODO: Add a method description
def get_precision(self)
Example Usage
result = response_types_controller.get_precision()
return_complex_1_object
TODO: Add a method description
def return_complex_1_object(self)
Example Usage
result = response_types_controller.return_complex_1_object()
return_complex_3_object
TODO: Add a method description
def return_complex_3_object(self)
Example Usage
result = response_types_controller.return_complex_3_object()
return_response_with_enums
TODO: Add a method description
def return_response_with_enums(self)
Example Usage
result = response_types_controller.return_response_with_enums()
return_complex_2_object
TODO: Add a method description
def return_complex_2_object(self)
Example Usage
result = response_types_controller.return_complex_2_object()
return_tester_model
TODO: Add a method description
def return_tester_model(self)
Example Usage
result = response_types_controller.return_tester_model()
return_developer_model
TODO: Add a method description
def return_developer_model(self)
Example Usage
result = response_types_controller.return_developer_model()
return_employee_model
TODO: Add a method description
def return_employee_model(self)
Example Usage
result = response_types_controller.return_employee_model()
return_boss_model
TODO: Add a method description
def return_boss_model(self)
Example Usage
result = response_types_controller.return_boss_model()
return_company_model
TODO: Add a method description
def return_company_model(self)
Example Usage
result = response_types_controller.return_company_model()
get_date
TODO: Add a method description
def get_date(self)
Example Usage
result = response_types_controller.get_date()
get_date_array
TODO: Add a method description
def get_date_array(self)
Example Usage
result = response_types_controller.get_date_array()
QueryParamController
Get controller instance
An instance of the QueryParamController
class can be accessed from the API Client.
query_param_controller = client.query_param
multiple_params
TODO: Add a method description
def multiple_params(self,
number,
precision,
string,
url)
Parameters
Parameter | Tags | Description |
---|---|---|
number | Required |
TODO: Add a parameter description |
precision | Required |
TODO: Add a parameter description |
string | Required |
TODO: Add a parameter description |
url | Required |
TODO: Add a parameter description |
Example Usage
number = 123412312
precision = 1112.34
string = '""test./;";12&&3asl"";"qw1&34"///..//.'
url = 'http://www.abc.com/test?a=b&c="http://lolol.com?param=no&another=lol"'
result = query_param_controller.multiple_params(number, precision, string, url)
number_array
TODO: Add a method description
def number_array(self,
integers)
Parameters
Parameter | Tags | Description |
---|---|---|
integers | Required Collection |
TODO: Add a parameter description |
Example Usage
integers_value = "[1,2,3,4,5]"
integers = json.loads(integers_value)
result = query_param_controller.number_array(integers)
string_array
TODO: Add a method description
def string_array(self,
strings)
Parameters
Parameter | Tags | Description |
---|---|---|
strings | Required Collection |
TODO: Add a parameter description |
Example Usage
strings_value = '["abc", "def"]'
strings = json.loads(strings_value)
result = query_param_controller.string_array(strings)
simple_query
TODO: Add a method description
def simple_query(self,
boolean,
number,
string,
_optional_query_parameters=None)
Parameters
Parameter | Tags | Description |
---|---|---|
boolean | Required |
TODO: Add a parameter description |
number | Required |
TODO: Add a parameter description |
string | Required |
TODO: Add a parameter description |
_optional_query_parameters | Optional |
Additional optional query parameters are supported by this method |
Example Usage
boolean = True
number = 4
string = 'TestString'
# key-value map for optional query parameters
optional_query_parameters = { }
result = query_param_controller.simple_query(boolean, number, string, optional_query_parameters)
integer_enum_array
TODO: Add a method description
def integer_enum_array(self,
suites)
Parameters
Parameter | Tags | Description |
---|---|---|
suites | Required Collection |
TODO: Add a parameter description |
Example Usage
suites = [SuiteCode.HEARTS,SuiteCode.CLUBS,SuiteCode.DIAMONDS,SuiteCode.SPADES,SuiteCode.CLUBS]
result = query_param_controller.integer_enum_array(suites)
string_enum_array
TODO: Add a method description
def string_enum_array(self,
days)
Parameters
Parameter | Tags | Description |
---|---|---|
days | Required Collection |
TODO: Add a parameter description |
Example Usage
days = [Days.TUESDAY,Days.SATURDAY,Days.MONDAY,Days.SUNDAY]
result = query_param_controller.string_enum_array(days)
url_param
TODO: Add a method description
def url_param(self,
url)
Parameters
Parameter | Tags | Description |
---|---|---|
url | Required |
TODO: Add a parameter description |
Example Usage
url = 'https://www.shahidisawesome.com/and/also/a/narcissist?thisis=aparameter&another=one'
result = query_param_controller.url_param(url)
no_params
TODO: Add a method description
def no_params(self)
Example Usage
result = query_param_controller.no_params()
string_param
TODO: Add a method description
def string_param(self,
string)
Parameters
Parameter | Tags | Description |
---|---|---|
string | Required |
TODO: Add a parameter description |
Example Usage
string = 'l;asd;asdwe[2304&&;\'.d??\\a\\\\\\;sd//'
result = query_param_controller.string_param(string)
rfc_1123_date_time
TODO: Add a method description
def rfc_1123_date_time(self,
datetime)
Parameters
Parameter | Tags | Description |
---|---|---|
datetime | Required |
TODO: Add a parameter description |
Example Usage
datetime = Sun, 06 Nov 1994 08:49:37 GMT
result = query_param_controller.rfc_1123_date_time(datetime)
rfc_1123_date_time_array
TODO: Add a method description
def rfc_1123_date_time_array(self,
datetimes)
Parameters
Parameter | Tags | Description |
---|---|---|
datetimes | Required Collection |
TODO: Add a parameter description |
Example Usage
datetimes_value = ["Sun, 06 Nov 1994 08:49:37 GMT","Sun, 06 Nov 1994 08:49:37 GMT"]
datetimes = json.loads(datetimes_value)
result = query_param_controller.rfc_1123_date_time_array(datetimes)
rfc_3339_date_time_array
TODO: Add a method description
def rfc_3339_date_time_array(self,
datetimes)
Parameters
Parameter | Tags | Description |
---|---|---|
datetimes | Required Collection |
TODO: Add a parameter description |
Example Usage
datetimes_value = ["1994-02-13T14:01:54.9571247Z","1994-02-13T14:01:54.9571247Z"]
datetimes = json.loads(datetimes_value)
result = query_param_controller.rfc_3339_date_time_array(datetimes)
rfc_3339_date_time
TODO: Add a method description
def rfc_3339_date_time(self,
datetime)
Parameters
Parameter | Tags | Description |
---|---|---|
datetime | Required |
TODO: Add a parameter description |
Example Usage
datetime = 1994-02-13T14:01:54.9571247Z
result = query_param_controller.rfc_3339_date_time(datetime)
optional_dynamic_query_param
get optional dynamic query parameter
def optional_dynamic_query_param(self,
name,
_optional_query_parameters=None)
Parameters
Parameter | Tags | Description |
---|---|---|
name | Required |
TODO: Add a parameter description |
_optional_query_parameters | Optional |
Additional optional query parameters are supported by this method |
Example Usage
name = 'farhan'
# key-value map for optional query parameters
optional_query_parameters = { }
result = query_param_controller.optional_dynamic_query_param(name, optional_query_parameters)
unix_date_time_array
TODO: Add a method description
def unix_date_time_array(self,
datetimes)
Parameters
Parameter | Tags | Description |
---|---|---|
datetimes | Required Collection |
TODO: Add a parameter description |
Example Usage
datetimes_value = [1484719381,1484719381]
datetimes = json.loads(datetimes_value)
result = query_param_controller.unix_date_time_array(datetimes)
unix_date_time
TODO: Add a method description
def unix_date_time(self,
datetime)
Parameters
Parameter | Tags | Description |
---|---|---|
datetime | Required |
TODO: Add a parameter description |
Example Usage
datetime = 1484719381
result = query_param_controller.unix_date_time(datetime)
date_array
TODO: Add a method description
def date_array(self,
dates)
Parameters
Parameter | Tags | Description |
---|---|---|
dates | Required Collection |
TODO: Add a parameter description |
Example Usage
dates_value = ["1994-02-13","1994-02-13"]
dates = json.loads(dates_value)
result = query_param_controller.date_array(dates)
date
TODO: Add a method description
def date(self,
date)
Parameters
Parameter | Tags | Description |
---|---|---|
date | Required |
TODO: Add a parameter description |
Example Usage
date = 1994-02-13
result = query_param_controller.date(date)
TemplateParamsController
Get controller instance
An instance of the TemplateParamsController
class can be accessed from the API Client.
template_params_controller = client.template_params
send_string_array
TODO: Add a method description
def send_string_array(self,
strings)
Parameters
Parameter | Tags | Description |
---|---|---|
strings | Required Collection |
TODO: Add a parameter description |
Example Usage
strings_value = '["abc", "def"]'
strings = json.loads(strings_value)
result = template_params_controller.send_string_array(strings)
send_integer_array
TODO: Add a method description
def send_integer_array(self,
integers)
Parameters
Parameter | Tags | Description |
---|---|---|
integers | Required Collection |
TODO: Add a parameter description |
Example Usage
integers_value = "[1,2,3,4,5]"
integers = json.loads(integers_value)
result = template_params_controller.send_integer_array(integers)
HeaderController
Get controller instance
An instance of the HeaderController
class can be accessed from the API Client.
header_controller = client.header
send_headers
Sends a single header params
def send_headers(self,
custom_header,
value)
Parameters
Parameter | Tags | Description |
---|---|---|
customHeader | Required |
TODO: Add a parameter description |
value | Required |
Represents the value of the custom header |
Example Usage
custom_header = 'TestString'
value = 'TestString'
result = header_controller.send_headers(custom_header, value)
get_message
TODO: Add a method description
def get_message(self,
operation)
Parameters
Parameter | Tags | Description |
---|---|---|
operation | Required |
TODO: Add a parameter description |
Example Usage
operation = 'operation'
header_controller.get_message(operation)
get_message_1
TODO: Add a method description
def get_message_1(self,
operation)
Parameters
Parameter | Tags | Description |
---|---|---|
operation | Required |
TODO: Add a parameter description |
Example Usage
operation = 'operation'
header_controller.get_message_1(operation)
EchoController
Get controller instance
An instance of the EchoController
class can be accessed from the API Client.
echo_controller = client.echo
query_echo
TODO: Add a method description
def query_echo(self,
_optional_query_parameters=None)
Parameters
Parameter | Tags | Description |
---|---|---|
_optional_query_parameters | Optional |
Additional optional query parameters are supported by this method |
Example Usage
# key-value map for optional query parameters
optional_query_parameters = { }
result = echo_controller.query_echo(optional_query_parameters)
json_echo
Echo's back the request
def json_echo(self,
input)
Parameters
Parameter | Tags | Description |
---|---|---|
input | Required |
TODO: Add a parameter description |
Example Usage
input_value = "{\"uid\": \"1123213\", \"name\": \"Shahid\"}"
input = json.loads(input_value)
result = echo_controller.json_echo(input)
form_echo
Sends the request including any form params as JSON
def form_echo(self,
input)
Parameters
Parameter | Tags | Description |
---|---|---|
input | Required |
TODO: Add a parameter description |
Example Usage
input_value = "{\"uid\": \"1123213\", \"name\": \"Shahid\"}"
input = json.loads(input_value)
result = echo_controller.form_echo(input)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for api-tester-upload-test-1.1.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8dd6c2310646e836a5b6df2e82fead8f4c28f64fd875ef4dd68356cddd054601 |
|
MD5 | 93858ce357b20e97ad8826bb679fa13f |
|
BLAKE2b-256 | b9660d4e3018cb1c877041dd42ef16ba20b578944dd8e86186c77ffdc142f5df |
Hashes for api_tester_upload_test-1.1.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae0563b53f718a43d2d95aa20a706d48d097f86f5bdd96f0ac8e108e28497704 |
|
MD5 | bc9905489af3798524c1bdab42690b4d |
|
BLAKE2b-256 | 3cfc4cf343eefae7616eb26e2672958ad03ff1fd80fdb0e05f5079ec67d8c88d |