mockserver-client 5.3.0 → 6.0.0

data/docs/ControlApi.md

@@ -1,269 +0,0 @@
-# MockServer::ControlApi
-
-All URIs are relative to *http://localhost:1080*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**bind_put**](ControlApi.md#bind_put) | **PUT** /bind | bind additional listening ports
-[**clear_put**](ControlApi.md#clear_put) | **PUT** /clear | clears expectations and recorded requests that match the request matcher
-[**reset_put**](ControlApi.md#reset_put) | **PUT** /reset | clears all expectations and recorded requests
-[**retrieve_put**](ControlApi.md#retrieve_put) | **PUT** /retrieve | retrieve recorded requests, active expectations, recorded expectations or log messages
-[**status_put**](ControlApi.md#status_put) | **PUT** /status | return listening ports
-[**stop_put**](ControlApi.md#stop_put) | **PUT** /stop | stop running process
-
-
-# **bind_put**
-> Ports bind_put(ports)
-
-bind additional listening ports
-
-only supported on Netty version
-
-### Example
-```ruby
-# load the gem
-require 'mockserver-client'
-
-api_instance = MockServer::ControlApi.new
-ports = MockServer::Ports.new # Ports | list of ports to bind to, where 0 indicates dynamically bind to any available port
-
-begin
-  #bind additional listening ports
-  result = api_instance.bind_put(ports)
-  p result
-rescue MockServer::ApiError => e
-  puts "Exception when calling ControlApi->bind_put: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **ports** | [**Ports**](Ports.md)| list of ports to bind to, where 0 indicates dynamically bind to any available port | 
-
-### Return type
-
-[**Ports**](Ports.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **clear_put**
-> clear_put(opts)
-
-clears expectations and recorded requests that match the request matcher
-
-### Example
-```ruby
-# load the gem
-require 'mockserver-client'
-
-api_instance = MockServer::ControlApi.new
-opts = {
-  http_request: MockServer::HttpRequest.new # HttpRequest | request used to match expectations and recored requests to clear
-}
-
-begin
-  #clears expectations and recorded requests that match the request matcher
-  api_instance.clear_put(opts)
-rescue MockServer::ApiError => e
-  puts "Exception when calling ControlApi->clear_put: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **http_request** | [**HttpRequest**](HttpRequest.md)| request used to match expectations and recored requests to clear | [optional] 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-
-# **reset_put**
-> reset_put
-
-clears all expectations and recorded requests
-
-### Example
-```ruby
-# load the gem
-require 'mockserver-client'
-
-api_instance = MockServer::ControlApi.new
-
-begin
-  #clears all expectations and recorded requests
-  api_instance.reset_put
-rescue MockServer::ApiError => e
-  puts "Exception when calling ControlApi->reset_put: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-
-# **retrieve_put**
-> Object retrieve_put(opts)
-
-retrieve recorded requests, active expectations, recorded expectations or log messages
-
-### Example
-```ruby
-# load the gem
-require 'mockserver-client'
-
-api_instance = MockServer::ControlApi.new
-opts = {
-  format: 'format_example', # String | changes response format, default if not specificed is \"json\", supported values are \"java\", \"json\"
-  type: 'type_example', # String | specifies the type of object that is retrieve, default if not specified is \"requests\", supported values are \"logs\", \"requests\", \"recorded_expectations\", \"active_expectations\"
-  http_request: MockServer::HttpRequest.new # HttpRequest | request used to match which recorded requests, expectations or log messages to return, an empty body matches all requests, expectations or log messages
-}
-
-begin
-  #retrieve recorded requests, active expectations, recorded expectations or log messages
-  result = api_instance.retrieve_put(opts)
-  p result
-rescue MockServer::ApiError => e
-  puts "Exception when calling ControlApi->retrieve_put: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **format** | **String**| changes response format, default if not specificed is \"json\", supported values are \"java\", \"json\" | [optional] 
- **type** | **String**| specifies the type of object that is retrieve, default if not specified is \"requests\", supported values are \"logs\", \"requests\", \"recorded_expectations\", \"active_expectations\" | [optional] 
- **http_request** | [**HttpRequest**](HttpRequest.md)| request used to match which recorded requests, expectations or log messages to return, an empty body matches all requests, expectations or log messages | [optional] 
-
-### Return type
-
-**Object**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, application/java, text/plain
-
-
-
-# **status_put**
-> Ports status_put
-
-return listening ports
-
-### Example
-```ruby
-# load the gem
-require 'mockserver-client'
-
-api_instance = MockServer::ControlApi.new
-
-begin
-  #return listening ports
-  result = api_instance.status_put
-  p result
-rescue MockServer::ApiError => e
-  puts "Exception when calling ControlApi->status_put: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Ports**](Ports.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **stop_put**
-> stop_put
-
-stop running process
-
-only supported on Netty version
-
-### Example
-```ruby
-# load the gem
-require 'mockserver-client'
-
-api_instance = MockServer::ControlApi.new
-
-begin
-  #stop running process
-  api_instance.stop_put
-rescue MockServer::ApiError => e
-  puts "Exception when calling ControlApi->stop_put: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-

data/docs/Delay.md

@@ -1,9 +0,0 @@
-# MockServer::Delay
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**time_unit** | **String** |  | [optional] 
-**value** | **Integer** |  | [optional] 
-
-

data/docs/Expectation.md

@@ -1,7 +0,0 @@
-# MockServer::Expectation
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-

data/docs/ExpectationApi.md

@@ -1,51 +0,0 @@
-# MockServer::ExpectationApi
-
-All URIs are relative to *http://localhost:1080*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**expectation_put**](ExpectationApi.md#expectation_put) | **PUT** /expectation | create expectation
-
-
-# **expectation_put**
-> expectation_put(expectations)
-
-create expectation
-
-### Example
-```ruby
-# load the gem
-require 'mockserver-client'
-
-api_instance = MockServer::ExpectationApi.new
-expectations = nil # Array<Expectations> | expectation to create
-
-begin
-  #create expectation
-  api_instance.expectation_put(expectations)
-rescue MockServer::ApiError => e
-  puts "Exception when calling ExpectationApi->expectation_put: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **expectations** | [**Array&lt;Expectations&gt;**](Array.md)| expectation to create | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-

data/docs/Expectations.md

@@ -1,7 +0,0 @@
-# MockServer::Expectations
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-

data/docs/HttpClassCallback.md

@@ -1,8 +0,0 @@
-# MockServer::HttpClassCallback
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**callback_class** | **String** |  | [optional] 
-
-

data/docs/HttpError.md

@@ -1,10 +0,0 @@
-# MockServer::HttpError
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**delay** | [**Delay**](Delay.md) |  | [optional] 
-**drop_connection** | **BOOLEAN** |  | [optional] 
-**response_bytes** | **String** |  | [optional] 
-
-

data/docs/HttpForward.md

@@ -1,11 +0,0 @@
-# MockServer::HttpForward
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**host** | **String** |  | [optional] 
-**port** | **Integer** |  | [optional] 
-**scheme** | **String** |  | [optional] 
-**delay** | [**Delay**](Delay.md) |  | [optional] 
-
-

data/docs/HttpObjectCallback.md

@@ -1,8 +0,0 @@
-# MockServer::HttpObjectCallback
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**client_id** | **String** |  | [optional] 
-
-

data/docs/HttpOverrideForwardedRequest.md

@@ -1,9 +0,0 @@
-# MockServer::HttpOverrideForwardedRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**http_request** | [**HttpRequest**](HttpRequest.md) |  | [optional] 
-**delay** | [**Delay**](Delay.md) |  | [optional] 
-
-

data/docs/HttpRequest.md

@@ -1,15 +0,0 @@
-# MockServer::HttpRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**body** | [**Body**](Body.md) |  | [optional] 
-**headers** | [**KeyToMultiValue**](KeyToMultiValue.md) |  | [optional] 
-**cookies** | [**KeyToValue**](KeyToValue.md) |  | [optional] 
-**query_string_parameters** | [**KeyToMultiValue**](KeyToMultiValue.md) |  | [optional] 
-**path** | **String** |  | [optional] 
-**method** | **String** |  | [optional] 
-**secure** | **BOOLEAN** |  | [optional] 
-**keep_alive** | **BOOLEAN** |  | [optional] 
-
-

data/docs/HttpResponse.md

@@ -1,14 +0,0 @@
-# MockServer::HttpResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**body** | [**BodyWithContentType**](BodyWithContentType.md) |  | [optional] 
-**delay** | [**Delay**](Delay.md) |  | [optional] 
-**cookies** | [**KeyToValue**](KeyToValue.md) |  | [optional] 
-**connection_options** | [**ConnectionOptions**](ConnectionOptions.md) |  | [optional] 
-**headers** | [**KeyToMultiValue**](KeyToMultiValue.md) |  | [optional] 
-**status_code** | **Integer** |  | [optional] 
-**reason_phrase** | **String** |  | [optional] 
-
-

data/docs/HttpTemplate.md

@@ -1,10 +0,0 @@
-# MockServer::HttpTemplate
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**template_type** | **String** |  | [optional] 
-**template** | **String** |  | [optional] 
-**delay** | [**Delay**](Delay.md) |  | [optional] 
-
-

data/docs/KeyToMultiValue.md

@@ -1,7 +0,0 @@
-# MockServer::KeyToMultiValue
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-

data/docs/KeyToValue.md

@@ -1,7 +0,0 @@
-# MockServer::KeyToValue
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-

data/docs/Ports.md

@@ -1,8 +0,0 @@
-# MockServer::Ports
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ports** | **Array<Float>** |  | [optional] 
-
-

data/docs/TimeToLive.md

@@ -1,10 +0,0 @@
-# MockServer::TimeToLive
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**time_unit** | **String** |  | [optional] 
-**time_to_live** | **Integer** |  | [optional] 
-**unlimited** | **BOOLEAN** |  | [optional] 
-
-

data/docs/Times.md

@@ -1,9 +0,0 @@
-# MockServer::Times
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**remaining_times** | **Integer** |  | [optional] 
-**unlimited** | **BOOLEAN** |  | [optional] 
-
-

data/docs/Verification.md

@@ -1,9 +0,0 @@
-# MockServer::Verification
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**http_request** | [**HttpRequest**](HttpRequest.md) |  | [optional] 
-**times** | [**VerificationTimes**](VerificationTimes.md) |  | [optional] 
-
-

data/docs/VerificationSequence.md

@@ -1,8 +0,0 @@
-# MockServer::VerificationSequence
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**http_requests** | [**Array<HttpRequest>**](HttpRequest.md) |  | [optional] 
-
-

data/docs/VerificationTimes.md

@@ -1,9 +0,0 @@
-# MockServer::VerificationTimes
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**exact** | **BOOLEAN** |  | [optional] 
-
-

data/docs/VerifyApi.md

@@ -1,94 +0,0 @@
-# MockServer::VerifyApi
-
-All URIs are relative to *http://localhost:1080*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**verify_put**](VerifyApi.md#verify_put) | **PUT** /verify | verify a request has been received a specific number of times
-[**verify_sequence_put**](VerifyApi.md#verify_sequence_put) | **PUT** /verifySequence | verify a sequence of request has been received in the specific order
-
-
-# **verify_put**
-> verify_put(verification)
-
-verify a request has been received a specific number of times
-
-### Example
-```ruby
-# load the gem
-require 'mockserver-client'
-
-api_instance = MockServer::VerifyApi.new
-verification = MockServer::Verification.new # Verification | request matcher and the number of times to match
-
-begin
-  #verify a request has been received a specific number of times
-  api_instance.verify_put(verification)
-rescue MockServer::ApiError => e
-  puts "Exception when calling VerifyApi->verify_put: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **verification** | [**Verification**](Verification.md)| request matcher and the number of times to match | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: text/plain
-
-
-
-# **verify_sequence_put**
-> verify_sequence_put(verification_sequence)
-
-verify a sequence of request has been received in the specific order
-
-### Example
-```ruby
-# load the gem
-require 'mockserver-client'
-
-api_instance = MockServer::VerifyApi.new
-verification_sequence = MockServer::VerificationSequence.new # VerificationSequence | the sequence of requests matchers
-
-begin
-  #verify a sequence of request has been received in the specific order
-  api_instance.verify_sequence_put(verification_sequence)
-rescue MockServer::ApiError => e
-  puts "Exception when calling VerifyApi->verify_sequence_put: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **verification_sequence** | [**VerificationSequence**](VerificationSequence.md)| the sequence of requests matchers | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: text/plain
-
-
-