Skip to main content

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.

Building SDK - Step 1

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.

Open project in PyCharm - Step 1

Click on Open in PyCharm to browse to your generated SDK directory and then click OK.

Open project in PyCharm - Step 2

The project files will be displayed in the side bar as follows:

Open project in PyCharm - Step 3

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Add a new project in PyCharm - Step 1

Name the directory as "test"

Add a new project in PyCharm - Step 2

Add a python file to this project with the name "testsdk"

Add a new project in PyCharm - Step 3

Name it "testsdk"

Add a new project in PyCharm - Step 4

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

Add a new project in PyCharm - Step 4

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

Run Test Project - Step 1

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:

  1. From terminal/cmd navigate to the root directory of the SDK.
  2. Invoke pip install -r test-requirements.txt
  3. 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

Class: FormParamsController

Get controller instance

An instance of the FormParamsController class can be accessed from the API Client.

 form_params_controller = client.form_params

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Back to List of Controllers

Class: QueryParamsController

Get controller instance

An instance of the QueryParamsController class can be accessed from the API Client.

 query_params_controller = client.query_params

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Back to List of Controllers

Class: BodyParamsController

Get controller instance

An instance of the BodyParamsController class can be accessed from the API Client.

 body_params_controller = client.body_params

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Back to List of Controllers

Class: ErrorCodesController

Get controller instance

An instance of the ErrorCodesController class can be accessed from the API Client.

 error_codes_controller = client.error_codes

Method: 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

Method: 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

Method: 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

Method: 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

Method: 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

Method: 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

Method: 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

Method: 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

Method: 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

Method: 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()

Method: 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

Method: 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

Method: 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

Method: 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.

Method: 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

Method: get_400

TODO: Add a method description

def get_400(self)

Example Usage

result = error_codes_controller.get_400()

Method: get_500

TODO: Add a method description

def get_500(self)

Example Usage

result = error_codes_controller.get_500()

Method: 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()

Back to List of Controllers

Class: ResponseTypesController

Get controller instance

An instance of the ResponseTypesController class can be accessed from the API Client.

 response_types_controller = client.response_types

Method: get_content_type_headers

TODO: Add a method description

def get_content_type_headers(self)

Example Usage

response_types_controller.get_content_type_headers()

Method: get_integer_array

Get an array of integers.

def get_integer_array(self)

Example Usage

result = response_types_controller.get_integer_array()

Method: get_dynamic

TODO: Add a method description

def get_dynamic(self)

Example Usage

result = response_types_controller.get_dynamic()

Method: get_dynamic_array

TODO: Add a method description

def get_dynamic_array(self)

Example Usage

result = response_types_controller.get_dynamic_array()

Method: get_3339_datetime

TODO: Add a method description

def get_3339_datetime(self)

Example Usage

result = response_types_controller.get_3339_datetime()

Method: 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()

Method: get_boolean

TODO: Add a method description

def get_boolean(self)

Example Usage

result = response_types_controller.get_boolean()

Method: get_boolean_array

TODO: Add a method description

def get_boolean_array(self)

Example Usage

result = response_types_controller.get_boolean_array()

Method: get_headers

TODO: Add a method description

def get_headers(self)

Example Usage

response_types_controller.get_headers()

Method: 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()

Method: 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()

Method: 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()

Method: 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()

Method: 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()

Method: get_binary

gets a binary object

def get_binary(self)

Example Usage

result = response_types_controller.get_binary()

Method: get_integer

Gets a integer response

def get_integer(self)

Example Usage

result = response_types_controller.get_integer()

Method: get_string_enum

TODO: Add a method description

def get_string_enum(self)

Example Usage

result = response_types_controller.get_string_enum()

Method: get_model_array

TODO: Add a method description

def get_model_array(self)

Example Usage

result = response_types_controller.get_model_array()

Method: get_long

TODO: Add a method description

def get_long(self)

Example Usage

result = response_types_controller.get_long()

Method: get_model

TODO: Add a method description

def get_model(self)

Example Usage

result = response_types_controller.get_model()

Method: 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()

Method: get_int_enum

TODO: Add a method description

def get_int_enum(self)

Example Usage

result = response_types_controller.get_int_enum()

Method: get_precision

TODO: Add a method description

def get_precision(self)

Example Usage

result = response_types_controller.get_precision()

Method: 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()

Method: 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()

Method: 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()

Method: 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()

Method: return_tester_model

TODO: Add a method description

def return_tester_model(self)

Example Usage

result = response_types_controller.return_tester_model()

Method: return_developer_model

TODO: Add a method description

def return_developer_model(self)

Example Usage

result = response_types_controller.return_developer_model()

Method: return_employee_model

TODO: Add a method description

def return_employee_model(self)

Example Usage

result = response_types_controller.return_employee_model()

Method: return_boss_model

TODO: Add a method description

def return_boss_model(self)

Example Usage

result = response_types_controller.return_boss_model()

Method: return_company_model

TODO: Add a method description

def return_company_model(self)

Example Usage

result = response_types_controller.return_company_model()

Method: get_date

TODO: Add a method description

def get_date(self)

Example Usage

result = response_types_controller.get_date()

Method: get_date_array

TODO: Add a method description

def get_date_array(self)

Example Usage

result = response_types_controller.get_date_array()

Back to List of Controllers

Class: QueryParamController

Get controller instance

An instance of the QueryParamController class can be accessed from the API Client.

 query_param_controller = client.query_param

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: no_params

TODO: Add a method description

def no_params(self)

Example Usage

result = query_param_controller.no_params()

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Method: 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)

Back to List of Controllers

Class: TemplateParamsController

Get controller instance

An instance of the TemplateParamsController class can be accessed from the API Client.

 template_params_controller = client.template_params

Method: 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)

Method: 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)

Back to List of Controllers

Class: HeaderController

Get controller instance

An instance of the HeaderController class can be accessed from the API Client.

 header_controller = client.header

Method: 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)

Method: 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)

Method: 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)

Back to List of Controllers

Class: EchoController

Get controller instance

An instance of the EchoController class can be accessed from the API Client.

 echo_controller = client.echo

Method: 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)

Method: 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)

Method: 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)

Back to List of Controllers

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

api-tester-upload-test-1.1.15.tar.gz (103.3 kB view hashes)

Uploaded Source

Built Distribution

api_tester_upload_test-1.1.15-py3-none-any.whl (191.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page