diff --git a/.swagger-codegen/VERSION b/.swagger-codegen/VERSION index be9d3eb..580ce10 100644 --- a/.swagger-codegen/VERSION +++ b/.swagger-codegen/VERSION @@ -1 +1 @@ -2.4.13-SNAPSHOT \ No newline at end of file +2.4.21-SNAPSHOT \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index bdfc5ec..2627fdc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes. +## [v1.1.0] - Monitor API v2.0-1.1.0 - 2022-04-11 +### Changed +- Added support for version v2.0-1.1.0 of the DocuSign Monitor API. +- Updated the SDK release version. + ## [v1.0.0] - Monitor API v2.0-1.0.0 - 2021-06-24 ### Changed - Updated the SDK release version. diff --git a/linter.sh b/linter.sh new file mode 100644 index 0000000..7362bab --- /dev/null +++ b/linter.sh @@ -0,0 +1,2 @@ +./vendor/bin/phpcbf -p src --extensions=php -d memory_limit=512M +./vendor/bin/phpcs src --standard=ruleset.xml \ No newline at end of file diff --git a/ruleset.xml b/ruleset.xml new file mode 100644 index 0000000..bd643e3 --- /dev/null +++ b/ruleset.xml @@ -0,0 +1,7 @@ + + + DocuSign custom coding standard. + + + + \ No newline at end of file diff --git a/src/Api/DataSetApi.php b/src/Api/DataSetApi.php index 186d043..998603e 100644 --- a/src/Api/DataSetApi.php +++ b/src/Api/DataSetApi.php @@ -8,19 +8,20 @@ * * @category Class * @package DocuSign\Monitor - * @author Swagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ /** * Monitor API * - * Use the DocuSign Monitor API to receive a data feed containing atypical security events within your DocuSign account. This data goes directly to an integrated application or website. + * An API for an integrator to access the features of DocuSign Monitor * * OpenAPI spec version: v2.0 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * Swagger Codegen version: 2.4.13-SNAPSHOT + * Swagger Codegen version: 2.4.21-SNAPSHOT */ /** @@ -32,6 +33,15 @@ namespace DocuSign\Monitor\Api\DataSetApi; +/** + * GetStreamOptions Class Doc Comment + * + * @category Class + * @package DocuSign\Monitor + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. + * @link https://github.com/swagger-api/swagger-codegen + */ class GetStreamOptions { /** @@ -42,6 +52,7 @@ class GetStreamOptions /** * Gets cursor + * * @return ?string */ public function getCursor(): ?string @@ -52,6 +63,7 @@ public function getCursor(): ?string /** * Sets cursor * @param ?string $cursor The cursor value to continue querying the data with. For an intial call, use empty string + * * @return self */ public function setCursor(?string $cursor): self @@ -67,6 +79,7 @@ public function setCursor(?string $cursor): self /** * Gets limit + * * @return ?int */ public function getLimit(): ?int @@ -77,6 +90,7 @@ public function getLimit(): ?int /** * Sets limit * @param ?int $limit The maximum number of records to return, minimum of 1, maximum of 2000. Defaults to 1000 if no value is provided + * * @return self */ public function setLimit(?int $limit): self @@ -100,7 +114,8 @@ public function setLimit(?int $limit): self * * @category Class * @package DocuSign\Monitor - * @author Swagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ class DataSetApi @@ -116,6 +131,7 @@ class DataSetApi * Constructor * * @param ApiClient|null $apiClient The api client to use + * * @return void */ public function __construct(ApiClient $apiClient = null) @@ -149,9 +165,9 @@ public function setApiClient(ApiClient $apiClient): self /** * Update $resourcePath with $ * - * @param string $resourcePath - * @param string $baseName - * @param string $paramName + * @param string $resourcePath the resource path to use + * @param string $baseName the base name param + * @param string $paramName the parameter name * * @return string */ @@ -172,7 +188,8 @@ public function updateResourcePath(string $resourcePath, string $baseName, strin * * @param ?string $data_set_name The name of the dataset to stream * @param ?string $version The requested API version - * @param \DocuSign\Monitor\Api\DataSetApi\GetStreamOptions for modifying the behavior of the function. (optional) + * @param \DocuSign\Monitor\Api\DataSetApi\GetStreamOptions $options for modifying the behavior of the function. (optional) + * * @throws ApiException on non-2xx response * @return \DocuSign\Monitor\Model\CursoredResult */ @@ -189,7 +206,8 @@ public function getStream($data_set_name, $version, \DocuSign\Monitor\Api\DataSe * * @param ?string $data_set_name The name of the dataset to stream * @param ?string $version The requested API version - * @param \DocuSign\Monitor\Api\DataSetApi\GetStreamOptions for modifying the behavior of the function. (optional) + * @param \DocuSign\Monitor\Api\DataSetApi\GetStreamOptions $options for modifying the behavior of the function. (optional) + * * @throws ApiException on non-2xx response * @return array of \DocuSign\Monitor\Model\CursoredResult, HTTP status code, HTTP response headers (array of strings) */ @@ -267,4 +285,108 @@ public function getStreamWithHttpInfo($data_set_name, $version, \DocuSign\Monito throw $e; } } + + /** + * Operation postWebQuery + * + * + * + * @param ?string $data_set_name The name of the dataset to query + * @param ?string $version The requested API version + * @param \DocuSign\Monitor\Model\WebQuery $web_query A collection of filter clauses and aggregations scoped to one or more organizations. The fields queryScope and queryScopeId may be omitted defaulting to all applicable organizations (required) + * + * @throws ApiException on non-2xx response + * @return \DocuSign\Monitor\Model\AggregateResult + */ + public function postWebQuery($data_set_name, $version, $web_query) + { + list($response) = $this->postWebQueryWithHttpInfo($data_set_name, $version, $web_query); + return $response; + } + + /** + * Operation postWebQueryWithHttpInfo + * + * + * + * @param ?string $data_set_name The name of the dataset to query + * @param ?string $version The requested API version + * @param \DocuSign\Monitor\Model\WebQuery $web_query A collection of filter clauses and aggregations scoped to one or more organizations. The fields queryScope and queryScopeId may be omitted defaulting to all applicable organizations (required) + * + * @throws ApiException on non-2xx response + * @return array of \DocuSign\Monitor\Model\AggregateResult, HTTP status code, HTTP response headers (array of strings) + */ + public function postWebQueryWithHttpInfo($data_set_name, $version, $web_query): array + { + // verify the required parameter 'data_set_name' is set + if ($data_set_name === null) { + throw new \InvalidArgumentException('Missing the required parameter $data_set_name when calling postWebQuery'); + } + // verify the required parameter 'version' is set + if ($version === null) { + throw new \InvalidArgumentException('Missing the required parameter $version when calling postWebQuery'); + } + // verify the required parameter 'web_query' is set + if ($web_query === null) { + throw new \InvalidArgumentException('Missing the required parameter $web_query when calling postWebQuery'); + } + // parse inputs + $resourcePath = "/api/v{version}/datasets/{dataSetName}/web_query"; + $httpBody = $_tempBody ?? ''; // $_tempBody is the method argument, if present + $queryParams = $headerParams = $formParams = []; + $headerParams['Accept'] ??= $this->apiClient->selectHeaderAccept(['application/json']); + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['application/json']); + + + // path params + if ($data_set_name !== null) { + $resourcePath = self::updateResourcePath($resourcePath, "dataSetName", $data_set_name); + } + // path params + if ($version !== null) { + $resourcePath = self::updateResourcePath($resourcePath, "version", $version); + } + + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + // body params + $_tempBody = null; + if (isset($web_query)) { + $_tempBody = $web_query; + } + + // for model (json/xml) + if (isset($_tempBody)) { + $httpBody = $_tempBody; // $_tempBody is the method argument, if present + } elseif (count($formParams) > 0) { + $httpBody = $formParams; // for HTTP post (form) + } + // this endpoint requires OAuth (access token) + if (strlen($this->apiClient->getConfig()->getAccessToken()) !== 0) { + $headerParams['Authorization'] = 'Bearer ' . $this->apiClient->getConfig()->getAccessToken(); + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'POST', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\Monitor\Model\AggregateResult', + '/api/v{version}/datasets/{dataSetName}/web_query' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\Monitor\Model\AggregateResult', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\Monitor\Model\AggregateResult', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } } diff --git a/src/HeaderSelector.php b/src/HeaderSelector.php index 277b7ba..58e920b 100644 --- a/src/HeaderSelector.php +++ b/src/HeaderSelector.php @@ -5,19 +5,20 @@ * * @category Class * @package DocuSign\Monitor - * @author Swagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ /** * Monitor API * - * Use the DocuSign Monitor API to receive a data feed containing atypical security events within your DocuSign account. This data goes directly to an integrated application or website. + * An API for an integrator to access the features of DocuSign Monitor * * OpenAPI spec version: v2.0 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * Swagger Codegen version: 2.4.13-SNAPSHOT + * Swagger Codegen version: 2.4.21-SNAPSHOT */ /** @@ -35,32 +36,39 @@ * * @category Class * @package DocuSign\Monitor - * @author Swagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ class HeaderSelector { /** - * @param string[] $accept - * @param string[] $contentTypes + * SelectHeaders method comment + * + * @param string[] $accept list of strings + * @param string[] $contentTypes list of strings for contentTypes + * * @return array */ public function selectHeaders($accept, $contentTypes) { $headers = []; - $accept = $this->selectAcceptHeader($accept); + $accept = $this->_selectAcceptHeader($accept); if ($accept !== null) { $headers['Accept'] = $accept; } - $headers['Content-Type'] = $this->selectContentTypeHeader($contentTypes); + $headers['Content-Type'] = $this->_selectContentTypeHeader($contentTypes); return $headers; } /** - * @param string[] $accept + * SelectHeadersForMultipart method comment + * + * @param string[] $accept list of strings + * * @return array */ public function selectHeadersForMultipart($accept) @@ -78,7 +86,7 @@ public function selectHeadersForMultipart($accept) * * @return string Accept (e.g. application/json) */ - private function selectAcceptHeader($accept) + private function _selectAcceptHeader($accept) { if (count($accept) === 0 || (count($accept) === 1 && $accept[0] === '')) { return null; @@ -96,7 +104,7 @@ private function selectAcceptHeader($accept) * * @return string Content-Type (e.g. application/json) */ - private function selectContentTypeHeader($contentType) + private function _selectContentTypeHeader($contentType) { if (count($contentType) === 0 || (count($contentType) === 1 && $contentType[0] === '')) { return 'application/json'; diff --git a/src/Model/AggregateResult.php b/src/Model/AggregateResult.php new file mode 100644 index 0000000..547498d --- /dev/null +++ b/src/Model/AggregateResult.php @@ -0,0 +1,306 @@ + + * @license The DocuSign PHP Client SDK is licensed under the MIT License. + * @link https://github.com/swagger-api/swagger-codegen + */ + +/** + * Monitor API + * + * An API for an integrator to access the features of DocuSign Monitor + * + * OpenAPI spec version: v2.0 + * Contact: devcenter@docusign.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + * Swagger Codegen version: 2.4.21-SNAPSHOT + */ + +/** + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen + * Do not edit the class manually. + */ + +namespace DocuSign\Monitor\Model; + +use \ArrayAccess; +use DocuSign\Monitor\ObjectSerializer; + +/** + * AggregateResult Class Doc Comment + * + * @category Class + * @package DocuSign\Monitor + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. + * @link https://github.com/swagger-api/swagger-codegen + */ +class AggregateResult implements ModelInterface, ArrayAccess +{ + const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $swaggerModelName = 'AggregateResult'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerTypes = [ + 'result' => '\DocuSign\Monitor\Model\AggregateResultResult[]' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'result' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'result' => 'result' + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'result' => 'setResult' + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'result' => 'getResult' + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + + + + + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->container['result'] = isset($data['result']) ? $data['result'] : null; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + + /** + * Gets result + * + * @return \DocuSign\Monitor\Model\AggregateResultResult[] + */ + public function getResult() + { + return $this->container['result']; + } + + /** + * Sets result + * + * @param \DocuSign\Monitor\Model\AggregateResultResult[] $result result + * + * @return $this + */ + public function setResult($result) + { + $this->container['result'] = $result; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * + * @param integer $offset Offset + * + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param integer $offset Offset + * + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param integer $offset Offset + * + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); + } + + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} + diff --git a/src/Model/AggregateResultResult.php b/src/Model/AggregateResultResult.php new file mode 100644 index 0000000..d7a4ad6 --- /dev/null +++ b/src/Model/AggregateResultResult.php @@ -0,0 +1,336 @@ + + * @license The DocuSign PHP Client SDK is licensed under the MIT License. + * @link https://github.com/swagger-api/swagger-codegen + */ + +/** + * Monitor API + * + * An API for an integrator to access the features of DocuSign Monitor + * + * OpenAPI spec version: v2.0 + * Contact: devcenter@docusign.com + * Generated by: https://github.com/swagger-api/swagger-codegen.git + * Swagger Codegen version: 2.4.21-SNAPSHOT + */ + +/** + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen + * Do not edit the class manually. + */ + +namespace DocuSign\Monitor\Model; + +use \ArrayAccess; +use DocuSign\Monitor\ObjectSerializer; + +/** + * AggregateResultResult Class Doc Comment + * + * @category Class + * @package DocuSign\Monitor + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. + * @link https://github.com/swagger-api/swagger-codegen + */ +class AggregateResultResult implements ModelInterface, ArrayAccess +{ + const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $swaggerModelName = 'AggregateResult_result'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerTypes = [ + 'name' => '?string', + 'data' => 'object[]' + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $swaggerFormats = [ + 'name' => null, + 'data' => null + ]; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function swaggerFormats() + { + return self::$swaggerFormats; + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'name' => 'name', + 'data' => 'data' + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'name' => 'setName', + 'data' => 'setData' + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'name' => 'getName', + 'data' => 'getData' + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$swaggerModelName; + } + + + + + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['data'] = isset($data['data']) ? $data['data'] : null; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + + /** + * Gets name + * + * @return ?string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * + * @param ?string $name name + * + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + + /** + * Gets data + * + * @return object[] + */ + public function getData() + { + return $this->container['data']; + } + + /** + * Sets data + * + * @param object[] $data data + * + * @return $this + */ + public function setData($data) + { + $this->container['data'] = $data; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * + * @param integer $offset Offset + * + * @return boolean + */ + #[\ReturnTypeWillChange] + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param integer $offset Offset + * + * @return mixed + */ + #[\ReturnTypeWillChange] + public function offsetGet($offset) + { + return isset($this->container[$offset]) ? $this->container[$offset] : null; + } + + /** + * Sets value based on offset. + * + * @param integer $offset Offset + * @param mixed $value Value to be set + * + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetSet($offset, $value) + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param integer $offset Offset + * + * @return void + */ + #[\ReturnTypeWillChange] + public function offsetUnset($offset) + { + unset($this->container[$offset]); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_PRETTY_PRINT + ); + } + + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} + diff --git a/src/Model/CursoredResult.php b/src/Model/CursoredResult.php index 72def2d..72e8919 100644 --- a/src/Model/CursoredResult.php +++ b/src/Model/CursoredResult.php @@ -6,19 +6,20 @@ * * @category Class * @package DocuSign\Monitor - * @author Swaagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ /** * Monitor API * - * Use the DocuSign Monitor API to receive a data feed containing atypical security events within your DocuSign account. This data goes directly to an integrated application or website. + * An API for an integrator to access the features of DocuSign Monitor * * OpenAPI spec version: v2.0 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * Swagger Codegen version: 2.4.13-SNAPSHOT + * Swagger Codegen version: 2.4.21-SNAPSHOT */ /** @@ -37,7 +38,8 @@ * * @category Class * @package DocuSign\Monitor - * @author Swagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ class CursoredResult implements ModelInterface, ArrayAccess @@ -264,6 +266,7 @@ public function setData($data) * * @return boolean */ + #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); @@ -276,6 +279,7 @@ public function offsetExists($offset) * * @return mixed */ + #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; @@ -289,6 +293,7 @@ public function offsetGet($offset) * * @return void */ + #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { @@ -305,6 +310,7 @@ public function offsetSet($offset, $value) * * @return void */ + #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); diff --git a/src/Model/ModelInterface.php b/src/Model/ModelInterface.php index 6787697..af79d89 100644 --- a/src/Model/ModelInterface.php +++ b/src/Model/ModelInterface.php @@ -6,19 +6,20 @@ * * @category Class * @package DocuSign\Monitor\Model - * @author Swagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ /** * Monitor API * - * Use the DocuSign Monitor API to receive a data feed containing atypical security events within your DocuSign account. This data goes directly to an integrated application or website. + * An API for an integrator to access the features of DocuSign Monitor * * OpenAPI spec version: v2.0 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * Swagger Codegen version: 2.4.13-SNAPSHOT + * Swagger Codegen version: 2.4.21-SNAPSHOT */ /** @@ -32,8 +33,11 @@ /** * Interface abstracting model access. * + * @category Interface * @package DocuSign\Monitor\Model - * @author Swagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. + * @link https://github.com/swagger-api/swagger-codegen */ interface ModelInterface { diff --git a/src/Model/WebQuery.php b/src/Model/WebQuery.php index ef0804d..48dd236 100644 --- a/src/Model/WebQuery.php +++ b/src/Model/WebQuery.php @@ -6,19 +6,20 @@ * * @category Class * @package DocuSign\Monitor - * @author Swaagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ /** - * DocuSign Monitor API - v2 + * Monitor API * * An API for an integrator to access the features of DocuSign Monitor * * OpenAPI spec version: v2.0 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * Swagger Codegen version: 2.4.13-SNAPSHOT + * Swagger Codegen version: 2.4.21-SNAPSHOT */ /** @@ -37,7 +38,8 @@ * * @category Class * @package DocuSign\Monitor - * @author Swagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ class WebQuery implements ModelInterface, ArrayAccess @@ -49,7 +51,7 @@ class WebQuery implements ModelInterface, ArrayAccess * * @var string */ - protected static $swaggerModelName = 'WebQuery'; + protected static $swaggerModelName = 'webQuery'; /** * Array of property to type mappings. Used for (de)serialization @@ -57,10 +59,10 @@ class WebQuery implements ModelInterface, ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'filters' => '\DocuSign\Monitor\Model\Filter[]', - 'aggregations' => '\DocuSign\Monitor\Model\Aggregation[]', - 'query_scope' => 'string', - 'query_scope_id' => 'string' + 'filters' => 'object[]', + 'aggregations' => 'object[]', + 'query_scope' => '?string', + 'query_scope_id' => '?string' ]; /** @@ -72,7 +74,7 @@ class WebQuery implements ModelInterface, ArrayAccess 'filters' => null, 'aggregations' => null, 'query_scope' => null, - 'query_scope_id' => 'uuid' + 'query_scope_id' => null ]; /** @@ -173,9 +175,7 @@ public function getModelName() return self::$swaggerModelName; } - const QUERY_SCOPE_ACCOUNT_ID = 'AccountId'; const QUERY_SCOPE_ORGANIZATION_ID = 'OrganizationId'; - const QUERY_SCOPE_NONE = 'None'; @@ -187,9 +187,7 @@ public function getModelName() public function getQueryScopeAllowableValues() { return [ - self::QUERY_SCOPE_ACCOUNT_ID, self::QUERY_SCOPE_ORGANIZATION_ID, - self::QUERY_SCOPE_NONE, ]; } @@ -250,7 +248,7 @@ public function valid() /** * Gets filters * - * @return \DocuSign\Monitor\Model\Filter[] + * @return object[] */ public function getFilters() { @@ -260,7 +258,7 @@ public function getFilters() /** * Sets filters * - * @param \DocuSign\Monitor\Model\Filter[] $filters filters + * @param object[] $filters filters * * @return $this */ @@ -274,7 +272,7 @@ public function setFilters($filters) /** * Gets aggregations * - * @return \DocuSign\Monitor\Model\Aggregation[] + * @return object[] */ public function getAggregations() { @@ -284,7 +282,7 @@ public function getAggregations() /** * Sets aggregations * - * @param \DocuSign\Monitor\Model\Aggregation[] $aggregations aggregations + * @param object[] $aggregations aggregations * * @return $this */ @@ -298,7 +296,7 @@ public function setAggregations($aggregations) /** * Gets query_scope * - * @return string + * @return ?string */ public function getQueryScope() { @@ -308,7 +306,7 @@ public function getQueryScope() /** * Sets query_scope * - * @param string $query_scope query_scope + * @param ?string $query_scope query_scope * * @return $this */ @@ -331,7 +329,7 @@ public function setQueryScope($query_scope) /** * Gets query_scope_id * - * @return string + * @return ?string */ public function getQueryScopeId() { @@ -341,7 +339,7 @@ public function getQueryScopeId() /** * Sets query_scope_id * - * @param string $query_scope_id query_scope_id + * @param ?string $query_scope_id query_scope_id * * @return $this */ @@ -358,6 +356,7 @@ public function setQueryScopeId($query_scope_id) * * @return boolean */ + #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); @@ -370,6 +369,7 @@ public function offsetExists($offset) * * @return mixed */ + #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; @@ -383,6 +383,7 @@ public function offsetGet($offset) * * @return void */ + #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { @@ -399,6 +400,7 @@ public function offsetSet($offset, $value) * * @return void */ + #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); diff --git a/src/ObjectSerializer.php b/src/ObjectSerializer.php index e0f0e87..3cfeca3 100644 --- a/src/ObjectSerializer.php +++ b/src/ObjectSerializer.php @@ -6,19 +6,20 @@ * * @category Class * @package DocuSign\Monitor - * @author Swagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ /** * Monitor API * - * Use the DocuSign Monitor API to receive a data feed containing atypical security events within your DocuSign account. This data goes directly to an integrated application or website. + * An API for an integrator to access the features of DocuSign Monitor * * OpenAPI spec version: v2.0 * Contact: devcenter@docusign.com * Generated by: https://github.com/swagger-api/swagger-codegen.git - * Swagger Codegen version: 2.4.13-SNAPSHOT + * Swagger Codegen version: 2.4.21-SNAPSHOT */ /** @@ -34,7 +35,8 @@ * * @category Class * @package DocuSign\Monitor - * @author Swagger Codegen team + * @author Swagger Codegen team + * @license The DocuSign PHP Client SDK is licensed under the MIT License. * @link https://github.com/swagger-api/swagger-codegen */ class ObjectSerializer @@ -229,7 +231,6 @@ public static function serializeCollection( * @param mixed $data object or primitive to be deserialized * @param string $class class name is passed as a string * @param array $httpHeaders HTTP headers - * @param string $discriminator discriminator if polymorphism is used * * @return object|array|null an single or an array of $class instances */ diff --git a/test/Docs/private.pem b/test/Docs/private.pem new file mode 100644 index 0000000..e69de29