diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..44a0d49b --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +composer.lock +vendor +.DS_Store +.idea +.phpunit.result.cache \ No newline at end of file diff --git a/.php_cs b/.php_cs new file mode 100644 index 00000000..6b8e23c8 --- /dev/null +++ b/.php_cs @@ -0,0 +1,18 @@ +level(Symfony\CS\FixerInterface::PSR2_LEVEL) + ->setUsingCache(true) + ->fixers( + [ + 'ordered_use', + 'phpdoc_order', + 'short_array_syntax', + 'strict', + 'strict_param' + ] + ) + ->finder( + Symfony\CS\Finder\DefaultFinder::create() + ->in(__DIR__) + ); diff --git a/.travis.yml b/.travis.yml index 8721db3a..9276f1e0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,8 +4,9 @@ branches: language: php sudo: false php: + - 5.4 - 5.5 - 5.6 - 7.0 -before_install: "composer install" -script: "vendor/bin/phpunit --verbose -c test" +before_install: "composer install --ignore-platform-reqs" +script: "cd test && phpunit UnitTests.php && phpunit OAuthTests.php" diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..21002bcf --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,26 @@ +# Change Log +All notable changes to this project will be documented in this file. + +See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes. + +## [4.0.0] - eSignature API v19.1.02 - 2019-06-07 +### BREAKING +* Moved ApiClient and ApiException under Client folder +### Removed +* empty test placeholder files +### Changed +* updated existing test cases to use JWT instead of the legacy auth (still not fully working yet) +### Added +* OAuth models under Client/Auth folder +* new dependency for OAuth support (firebase/php-jwt) +* OAuthTests.php for OAuth support test +### Fixed +* A bug with that could cause the *moveEnvelopes* method call to return a response without a *Content-Type* header. (DCM-2871) + +## [3.0.1] - Fixed the composer version - 2017-10-25 + +## [3.0.0] - Published all the DocuSign API endpoints - 2017-03-15 + +## [2.0.0] - New shiny PHP client - 2017-12-05 + +## [1.0.0] - Old legacy version - 2016-02-18 \ No newline at end of file diff --git a/composer.json b/composer.json index 11d09166..026e6cef 100644 --- a/composer.json +++ b/composer.json @@ -1,33 +1,40 @@ { "name": "docusign/esign-client", - "version": "3.0.1", + "version": "4.0.0", "description": "The DocuSign PHP library makes integrating DocuSign into your websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-php-client repository. Join the eSign revolution!", "keywords": [ - "swagger", + "DocuSign", + "Agreement", + "eSignature", "php", "sdk", "api" ], - "homepage": "https://www.docusign.com/developer-center", + "homepage": "https://developers.docusign.com", "license": "MIT", "authors": [ { "name": "DocuSign", - "homepage": "https://www.docusign.com/developer-center" + "homepage": "https://developers.docusign.com" } ], "require": { - "php": ">=5.5.36", + "php": ">=5.4", "ext-curl": "*", "ext-json": "*", - "ext-mbstring": "*" + "ext-mbstring": "*", + "firebase/php-jwt": "^5.0" }, "require-dev": { - "phpunit/phpunit": "~4.0", - "satooshi/php-coveralls": "~0.6.1", - "squizlabs/php_codesniffer": "~2.0" + "phpunit/phpunit": "~4.8", + "satooshi/php-coveralls": "~1.0", + "squizlabs/php_codesniffer": "~2.6", + "friendsofphp/php-cs-fixer": "*" }, "autoload": { "psr-4": { "DocuSign\\eSign\\" : "src/" } + }, + "autoload-dev": { + "psr-4": { "DocuSign\\eSign\\" : "test/" } } } diff --git a/src/Api/AccountsApi.php b/src/Api/AccountsApi.php index 327b57fb..3171c64c 100644 --- a/src/Api/AccountsApi.php +++ b/src/Api/AccountsApi.php @@ -56,6 +56,34 @@ public function setPreviewBillingPlan($preview_billing_plan) return $this; } } +class CreateCustomFieldOptions +{ + /** + * $apply_to_templates + * @var string + */ + protected $apply_to_templates; + + /** + * Gets apply_to_templates + * @return string + */ + public function getApplyToTemplates() + { + return $this->apply_to_templates; + } + + /** + * Sets apply_to_templates + * @param string $apply_to_templates + * @return $this + */ + public function setApplyToTemplates($apply_to_templates) + { + $this->apply_to_templates = $apply_to_templates; + return $this; + } +} class CreatePermissionProfileOptions { /** @@ -84,6 +112,34 @@ public function setInclude($include) return $this; } } +class DeleteCustomFieldOptions +{ + /** + * $apply_to_templates + * @var string + */ + protected $apply_to_templates; + + /** + * Gets apply_to_templates + * @return string + */ + public function getApplyToTemplates() + { + return $this->apply_to_templates; + } + + /** + * Sets apply_to_templates + * @param string $apply_to_templates + * @return $this + */ + public function setApplyToTemplates($apply_to_templates) + { + $this->apply_to_templates = $apply_to_templates; + return $this; + } +} class GetAccountInformationOptions { /** @@ -514,7 +570,7 @@ public function setItemType($item_type) return $this; } /** - * $search_text This can be used to filter user names in the response. The wild-card ‘*’ (asterisk) can be used around the string. + * $search_text This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string. * @var string */ protected $search_text; @@ -530,7 +586,7 @@ public function getSearchText() /** * Sets search_text - * @param string $search_text This can be used to filter user names in the response. The wild-card ‘*’ (asterisk) can be used around the string. + * @param string $search_text This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string. * @return $this */ public function setSearchText($search_text) @@ -614,6 +670,62 @@ public function setUserIds($user_ids) return $this; } } +class UpdateConsumerDisclosureOptions +{ + /** + * $include_metadata + * @var string + */ + protected $include_metadata; + + /** + * Gets include_metadata + * @return string + */ + public function getIncludeMetadata() + { + return $this->include_metadata; + } + + /** + * Sets include_metadata + * @param string $include_metadata + * @return $this + */ + public function setIncludeMetadata($include_metadata) + { + $this->include_metadata = $include_metadata; + return $this; + } +} +class UpdateCustomFieldOptions +{ + /** + * $apply_to_templates + * @var string + */ + protected $apply_to_templates; + + /** + * Gets apply_to_templates + * @return string + */ + public function getApplyToTemplates() + { + return $this->apply_to_templates; + } + + /** + * Sets apply_to_templates + * @param string $apply_to_templates + * @return $this + */ + public function setApplyToTemplates($apply_to_templates) + { + $this->apply_to_templates = $apply_to_templates; + return $this; + } +} class UpdatePermissionProfileOptions { /** @@ -699,7 +811,7 @@ public function setUserIds($user_ids) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -717,16 +829,16 @@ class AccountsApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -738,7 +850,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -748,11 +860,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return AccountsApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; @@ -949,39 +1061,41 @@ public function createBrandWithHttpInfo($account_id, $brand = null) } /** - * Operation createEMortgageTransaction + * Operation createCustomField * - * Starts a new eMortgage Transaction + * Creates an acount custom field. * * @param string $account_id The external account number (int) or account ID Guid. - * @param \DocuSign\eSign\Model\PostTransactionsRequest $post_transactions_request (optional) + * @param \DocuSign\eSign\Model\CustomField $custom_field (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\PostTransactionsResponse + * @return \DocuSign\eSign\Model\CustomFields */ - public function createEMortgageTransaction($account_id, $post_transactions_request = null) + public function createCustomField($account_id, $custom_field = null, AccountsApi\CreateCustomFieldOptions $options = null) { - list($response) = $this->createEMortgageTransactionWithHttpInfo($account_id, $post_transactions_request); + list($response) = $this->createCustomFieldWithHttpInfo($account_id, $custom_field, $options); return $response; } /** - * Operation createEMortgageTransactionWithHttpInfo + * Operation createCustomFieldWithHttpInfo * - * Starts a new eMortgage Transaction + * Creates an acount custom field. * * @param string $account_id The external account number (int) or account ID Guid. - * @param \DocuSign\eSign\Model\PostTransactionsRequest $post_transactions_request (optional) + * @param \DocuSign\eSign\Model\CustomField $custom_field (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\PostTransactionsResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings) */ - public function createEMortgageTransactionWithHttpInfo($account_id, $post_transactions_request = null) + public function createCustomFieldWithHttpInfo($account_id, $custom_field = null, AccountsApi\CreateCustomFieldOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createEMortgageTransaction'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createCustomField'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/eMortgage/transactions"; + $resourcePath = "/v2/accounts/{accountId}/custom_fields"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -992,6 +1106,14 @@ public function createEMortgageTransactionWithHttpInfo($account_id, $post_transa } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getApplyToTemplates() !== null) { + $queryParams['apply_to_templates'] = $this->apiClient->getSerializer()->toQueryValue($options->getApplyToTemplates()); + } + } // path params if ($account_id !== null) { @@ -1006,8 +1128,8 @@ public function createEMortgageTransactionWithHttpInfo($account_id, $post_transa // body params $_tempBody = null; - if (isset($post_transactions_request)) { - $_tempBody = $post_transactions_request; + if (isset($custom_field)) { + $_tempBody = $custom_field; } // for model (json/xml) @@ -1024,15 +1146,15 @@ public function createEMortgageTransactionWithHttpInfo($account_id, $post_transa $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\PostTransactionsResponse', - '/v2/accounts/{accountId}/eMortgage/transactions' + '\DocuSign\eSign\Model\CustomFields', + '/v2/accounts/{accountId}/custom_fields' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\PostTransactionsResponse', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\CustomFields', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\PostTransactionsResponse', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\CustomFields', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -1661,37 +1783,45 @@ public function deleteCaptiveRecipientWithHttpInfo($account_id, $recipient_part, } /** - * Operation deleteENoteConfiguration + * Operation deleteCustomField * - * Deletes configuration information for the eNote eOriginal integration. + * Delete an existing account custom field. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $custom_field_id + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response * @return void */ - public function deleteENoteConfiguration($account_id) + public function deleteCustomField($account_id, $custom_field_id, AccountsApi\DeleteCustomFieldOptions $options = null) { - list($response) = $this->deleteENoteConfigurationWithHttpInfo($account_id); + list($response) = $this->deleteCustomFieldWithHttpInfo($account_id, $custom_field_id, $options); return $response; } /** - * Operation deleteENoteConfigurationWithHttpInfo + * Operation deleteCustomFieldWithHttpInfo * - * Deletes configuration information for the eNote eOriginal integration. + * Delete an existing account custom field. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $custom_field_id + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function deleteENoteConfigurationWithHttpInfo($account_id) + public function deleteCustomFieldWithHttpInfo($account_id, $custom_field_id, AccountsApi\DeleteCustomFieldOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling deleteENoteConfiguration'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling deleteCustomField'); + } + // verify the required parameter 'custom_field_id' is set + if ($custom_field_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $custom_field_id when calling deleteCustomField'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/settings/enote_configuration"; + $resourcePath = "/v2/accounts/{accountId}/custom_fields/{customFieldId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -1702,6 +1832,14 @@ public function deleteENoteConfigurationWithHttpInfo($account_id) } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getApplyToTemplates() !== null) { + $queryParams['apply_to_templates'] = $this->apiClient->getSerializer()->toQueryValue($options->getApplyToTemplates()); + } + } // path params if ($account_id !== null) { @@ -1711,6 +1849,14 @@ public function deleteENoteConfigurationWithHttpInfo($account_id) $resourcePath ); } + // path params + if ($custom_field_id !== null) { + $resourcePath = str_replace( + "{" . "customFieldId" . "}", + $this->apiClient->getSerializer()->toPathValue($custom_field_id), + $resourcePath + ); + } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -1730,7 +1876,7 @@ public function deleteENoteConfigurationWithHttpInfo($account_id) $httpBody, $headerParams, null, - '/v2/accounts/{accountId}/settings/enote_configuration' + '/v2/accounts/{accountId}/custom_fields/{customFieldId}' ); return [null, $statusCode, $httpHeader]; @@ -1747,43 +1893,37 @@ public function deleteENoteConfigurationWithHttpInfo($account_id) } /** - * Operation deletePermissionProfile + * Operation deleteENoteConfiguration * - * Deletes a permissions profile within the specified account. + * Deletes configuration information for the eNote eOriginal integration. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $permission_profile_id * @throws \DocuSign\eSign\ApiException on non-2xx response * @return void */ - public function deletePermissionProfile($account_id, $permission_profile_id) + public function deleteENoteConfiguration($account_id) { - list($response) = $this->deletePermissionProfileWithHttpInfo($account_id, $permission_profile_id); + list($response) = $this->deleteENoteConfigurationWithHttpInfo($account_id); return $response; } /** - * Operation deletePermissionProfileWithHttpInfo + * Operation deleteENoteConfigurationWithHttpInfo * - * Deletes a permissions profile within the specified account. + * Deletes configuration information for the eNote eOriginal integration. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $permission_profile_id * @throws \DocuSign\eSign\ApiException on non-2xx response * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function deletePermissionProfileWithHttpInfo($account_id, $permission_profile_id) + public function deleteENoteConfigurationWithHttpInfo($account_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling deletePermissionProfile'); - } - // verify the required parameter 'permission_profile_id' is set - if ($permission_profile_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $permission_profile_id when calling deletePermissionProfile'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling deleteENoteConfiguration'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}"; + $resourcePath = "/v2/accounts/{accountId}/settings/enote_configuration"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -1803,14 +1943,6 @@ public function deletePermissionProfileWithHttpInfo($account_id, $permission_pro $resourcePath ); } - // path params - if ($permission_profile_id !== null) { - $resourcePath = str_replace( - "{" . "permissionProfileId" . "}", - $this->apiClient->getSerializer()->toPathValue($permission_profile_id), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -1830,7 +1962,7 @@ public function deletePermissionProfileWithHttpInfo($account_id, $permission_pro $httpBody, $headerParams, null, - '/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}' + '/v2/accounts/{accountId}/settings/enote_configuration' ); return [null, $statusCode, $httpHeader]; @@ -1847,39 +1979,43 @@ public function deletePermissionProfileWithHttpInfo($account_id, $permission_pro } /** - * Operation getAccountInformation + * Operation deletePermissionProfile * - * Retrieves the account information for the specified account. + * Deletes a permissions profile within the specified account. * * @param string $account_id The external account number (int) or account ID Guid. - * @param $options Options for modifying the behavior of the function. (optional) + * @param string $permission_profile_id * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\AccountInformation + * @return void */ - public function getAccountInformation($account_id, AccountsApi\GetAccountInformationOptions $options = null) + public function deletePermissionProfile($account_id, $permission_profile_id) { - list($response) = $this->getAccountInformationWithHttpInfo($account_id, $options); + list($response) = $this->deletePermissionProfileWithHttpInfo($account_id, $permission_profile_id); return $response; } /** - * Operation getAccountInformationWithHttpInfo + * Operation deletePermissionProfileWithHttpInfo * - * Retrieves the account information for the specified account. + * Deletes a permissions profile within the specified account. * * @param string $account_id The external account number (int) or account ID Guid. - * @param $options Options for modifying the behavior of the function. (optional) + * @param string $permission_profile_id * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\AccountInformation, HTTP status code, HTTP response headers (array of strings) + * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function getAccountInformationWithHttpInfo($account_id, AccountsApi\GetAccountInformationOptions $options = null) + public function deletePermissionProfileWithHttpInfo($account_id, $permission_profile_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getAccountInformation'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling deletePermissionProfile'); + } + // verify the required parameter 'permission_profile_id' is set + if ($permission_profile_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $permission_profile_id when calling deletePermissionProfile'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}"; + $resourcePath = "/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -1890,14 +2026,6 @@ public function getAccountInformationWithHttpInfo($account_id, AccountsApi\GetAc } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getIncludeAccountSettings() !== null) { - $queryParams['include_account_settings'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeAccountSettings()); - } - } // path params if ($account_id !== null) { @@ -1907,6 +2035,14 @@ public function getAccountInformationWithHttpInfo($account_id, AccountsApi\GetAc $resourcePath ); } + // path params + if ($permission_profile_id !== null) { + $resourcePath = str_replace( + "{" . "permissionProfileId" . "}", + $this->apiClient->getSerializer()->toPathValue($permission_profile_id), + $resourcePath + ); + } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -1921,21 +2057,17 @@ public function getAccountInformationWithHttpInfo($account_id, AccountsApi\GetAc try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( $resourcePath, - 'GET', + 'DELETE', $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\AccountInformation', - '/v2/accounts/{accountId}' + null, + '/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountInformation', $httpHeader), $statusCode, $httpHeader]; + return [null, $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountInformation', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; case 400: $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); $e->setResponseObject($data); @@ -1947,37 +2079,37 @@ public function getAccountInformationWithHttpInfo($account_id, AccountsApi\GetAc } /** - * Operation getAccountTabSettings + * Operation getAccountIdentityVerification * - * Returns tab settings list for specified account + * Get the list of identity verification options for an account * * @param string $account_id The external account number (int) or account ID Guid. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\TabAccountSettings + * @return \DocuSign\eSign\Model\AccountIdentityVerificationResponse */ - public function getAccountTabSettings($account_id) + public function getAccountIdentityVerification($account_id) { - list($response) = $this->getAccountTabSettingsWithHttpInfo($account_id); + list($response) = $this->getAccountIdentityVerificationWithHttpInfo($account_id); return $response; } /** - * Operation getAccountTabSettingsWithHttpInfo + * Operation getAccountIdentityVerificationWithHttpInfo * - * Returns tab settings list for specified account + * Get the list of identity verification options for an account * * @param string $account_id The external account number (int) or account ID Guid. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\TabAccountSettings, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\AccountIdentityVerificationResponse, HTTP status code, HTTP response headers (array of strings) */ - public function getAccountTabSettingsWithHttpInfo($account_id) + public function getAccountIdentityVerificationWithHttpInfo($account_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getAccountTabSettings'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getAccountIdentityVerification'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/settings/tabs"; + $resourcePath = "/v2/accounts/{accountId}/identity_verification"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2015,15 +2147,15 @@ public function getAccountTabSettingsWithHttpInfo($account_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\TabAccountSettings', - '/v2/accounts/{accountId}/settings/tabs' + '\DocuSign\eSign\Model\AccountIdentityVerificationResponse', + '/v2/accounts/{accountId}/identity_verification' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\TabAccountSettings', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountIdentityVerificationResponse', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\TabAccountSettings', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountIdentityVerificationResponse', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -2037,39 +2169,39 @@ public function getAccountTabSettingsWithHttpInfo($account_id) } /** - * Operation getBillingCharges + * Operation getAccountInformation * - * Gets list of recurring and usage charges for the account. + * Retrieves the account information for the specified account. * * @param string $account_id The external account number (int) or account ID Guid. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\BillingChargeResponse + * @return \DocuSign\eSign\Model\AccountInformation */ - public function getBillingCharges($account_id, AccountsApi\GetBillingChargesOptions $options = null) + public function getAccountInformation($account_id, AccountsApi\GetAccountInformationOptions $options = null) { - list($response) = $this->getBillingChargesWithHttpInfo($account_id, $options); + list($response) = $this->getAccountInformationWithHttpInfo($account_id, $options); return $response; } /** - * Operation getBillingChargesWithHttpInfo + * Operation getAccountInformationWithHttpInfo * - * Gets list of recurring and usage charges for the account. + * Retrieves the account information for the specified account. * * @param string $account_id The external account number (int) or account ID Guid. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\BillingChargeResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\AccountInformation, HTTP status code, HTTP response headers (array of strings) */ - public function getBillingChargesWithHttpInfo($account_id, AccountsApi\GetBillingChargesOptions $options = null) + public function getAccountInformationWithHttpInfo($account_id, AccountsApi\GetAccountInformationOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBillingCharges'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getAccountInformation'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/billing_charges"; + $resourcePath = "/v2/accounts/{accountId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2084,8 +2216,8 @@ public function getBillingChargesWithHttpInfo($account_id, AccountsApi\GetBillin { // query params // query params - if ($options->getIncludeCharges() !== null) { - $queryParams['include_charges'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeCharges()); + if ($options->getIncludeAccountSettings() !== null) { + $queryParams['include_account_settings'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeAccountSettings()); } } @@ -2115,15 +2247,15 @@ public function getBillingChargesWithHttpInfo($account_id, AccountsApi\GetBillin $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\BillingChargeResponse', - '/v2/accounts/{accountId}/billing_charges' + '\DocuSign\eSign\Model\AccountInformation', + '/v2/accounts/{accountId}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\BillingChargeResponse', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountInformation', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\BillingChargeResponse', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountInformation', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -2137,45 +2269,37 @@ public function getBillingChargesWithHttpInfo($account_id, AccountsApi\GetBillin } /** - * Operation getBrand + * Operation getAccountTabSettings * - * Get information for a specific brand. + * Returns tab settings list for specified account * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\Brand + * @return \DocuSign\eSign\Model\TabAccountSettings */ - public function getBrand($account_id, $brand_id, AccountsApi\GetBrandOptions $options = null) + public function getAccountTabSettings($account_id) { - list($response) = $this->getBrandWithHttpInfo($account_id, $brand_id, $options); + list($response) = $this->getAccountTabSettingsWithHttpInfo($account_id); return $response; } /** - * Operation getBrandWithHttpInfo + * Operation getAccountTabSettingsWithHttpInfo * - * Get information for a specific brand. + * Returns tab settings list for specified account * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\Brand, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\TabAccountSettings, HTTP status code, HTTP response headers (array of strings) */ - public function getBrandWithHttpInfo($account_id, $brand_id, AccountsApi\GetBrandOptions $options = null) + public function getAccountTabSettingsWithHttpInfo($account_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBrand'); - } - // verify the required parameter 'brand_id' is set - if ($brand_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling getBrand'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getAccountTabSettings'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}"; + $resourcePath = "/v2/accounts/{accountId}/settings/tabs"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2186,18 +2310,6 @@ public function getBrandWithHttpInfo($account_id, $brand_id, AccountsApi\GetBran } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getIncludeExternalReferences() !== null) { - $queryParams['include_external_references'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeExternalReferences()); - } - // query params - if ($options->getIncludeLogos() !== null) { - $queryParams['include_logos'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeLogos()); - } - } // path params if ($account_id !== null) { @@ -2207,14 +2319,6 @@ public function getBrandWithHttpInfo($account_id, $brand_id, AccountsApi\GetBran $resourcePath ); } - // path params - if ($brand_id !== null) { - $resourcePath = str_replace( - "{" . "brandId" . "}", - $this->apiClient->getSerializer()->toPathValue($brand_id), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -2233,15 +2337,15 @@ public function getBrandWithHttpInfo($account_id, $brand_id, AccountsApi\GetBran $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\Brand', - '/v2/accounts/{accountId}/brands/{brandId}' + '\DocuSign\eSign\Model\TabAccountSettings', + '/v2/accounts/{accountId}/settings/tabs' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Brand', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\TabAccountSettings', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Brand', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\TabAccountSettings', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -2255,49 +2359,37 @@ public function getBrandWithHttpInfo($account_id, $brand_id, AccountsApi\GetBran } /** - * Operation getBrandLogoByType + * Operation getAllPaymentGatewayAccounts * - * Obtains the specified image for a brand. + * Get all payment gateway account for the provided accountId * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. - * @param string $logo_type One of **Primary**, **Secondary** or **Email**. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return void + * @return \DocuSign\eSign\Model\PaymentGatewayAccountsInfo */ - public function getBrandLogoByType($account_id, $brand_id, $logo_type) + public function getAllPaymentGatewayAccounts($account_id) { - list($response) = $this->getBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_type); + list($response) = $this->getAllPaymentGatewayAccountsWithHttpInfo($account_id); return $response; } /** - * Operation getBrandLogoByTypeWithHttpInfo + * Operation getAllPaymentGatewayAccountsWithHttpInfo * - * Obtains the specified image for a brand. + * Get all payment gateway account for the provided accountId * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. - * @param string $logo_type One of **Primary**, **Secondary** or **Email**. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\PaymentGatewayAccountsInfo, HTTP status code, HTTP response headers (array of strings) */ - public function getBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_type) + public function getAllPaymentGatewayAccountsWithHttpInfo($account_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBrandLogoByType'); - } - // verify the required parameter 'brand_id' is set - if ($brand_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling getBrandLogoByType'); - } - // verify the required parameter 'logo_type' is set - if ($logo_type === null) { - throw new \InvalidArgumentException('Missing the required parameter $logo_type when calling getBrandLogoByType'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getAllPaymentGatewayAccounts'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}"; + $resourcePath = "/v2/accounts/{accountId}/payment_gateway_accounts"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2317,22 +2409,6 @@ public function getBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_typ $resourcePath ); } - // path params - if ($brand_id !== null) { - $resourcePath = str_replace( - "{" . "brandId" . "}", - $this->apiClient->getSerializer()->toPathValue($brand_id), - $resourcePath - ); - } - // path params - if ($logo_type !== null) { - $resourcePath = str_replace( - "{" . "logoType" . "}", - $this->apiClient->getSerializer()->toPathValue($logo_type), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -2351,13 +2427,17 @@ public function getBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_typ $queryParams, $httpBody, $headerParams, - null, - '/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}' + '\DocuSign\eSign\Model\PaymentGatewayAccountsInfo', + '/v2/accounts/{accountId}/payment_gateway_accounts' ); - return [null, $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\PaymentGatewayAccountsInfo', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\PaymentGatewayAccountsInfo', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; case 400: $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); $e->setResponseObject($data); @@ -2369,43 +2449,39 @@ public function getBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_typ } /** - * Operation getBrandResources + * Operation getBillingCharges * - * Returns the specified account's list of branding resources (metadata). + * Gets list of recurring and usage charges for the account. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\BrandResourcesList + * @return \DocuSign\eSign\Model\BillingChargeResponse */ - public function getBrandResources($account_id, $brand_id) + public function getBillingCharges($account_id, AccountsApi\GetBillingChargesOptions $options = null) { - list($response) = $this->getBrandResourcesWithHttpInfo($account_id, $brand_id); + list($response) = $this->getBillingChargesWithHttpInfo($account_id, $options); return $response; } /** - * Operation getBrandResourcesWithHttpInfo + * Operation getBillingChargesWithHttpInfo * - * Returns the specified account's list of branding resources (metadata). + * Gets list of recurring and usage charges for the account. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\BrandResourcesList, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\BillingChargeResponse, HTTP status code, HTTP response headers (array of strings) */ - public function getBrandResourcesWithHttpInfo($account_id, $brand_id) + public function getBillingChargesWithHttpInfo($account_id, AccountsApi\GetBillingChargesOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBrandResources'); - } - // verify the required parameter 'brand_id' is set - if ($brand_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling getBrandResources'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBillingCharges'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/resources"; + $resourcePath = "/v2/accounts/{accountId}/billing_charges"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2416,6 +2492,14 @@ public function getBrandResourcesWithHttpInfo($account_id, $brand_id) } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getIncludeCharges() !== null) { + $queryParams['include_charges'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeCharges()); + } + } // path params if ($account_id !== null) { @@ -2425,14 +2509,6 @@ public function getBrandResourcesWithHttpInfo($account_id, $brand_id) $resourcePath ); } - // path params - if ($brand_id !== null) { - $resourcePath = str_replace( - "{" . "brandId" . "}", - $this->apiClient->getSerializer()->toPathValue($brand_id), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -2451,15 +2527,15 @@ public function getBrandResourcesWithHttpInfo($account_id, $brand_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\BrandResourcesList', - '/v2/accounts/{accountId}/brands/{brandId}/resources' + '\DocuSign\eSign\Model\BillingChargeResponse', + '/v2/accounts/{accountId}/billing_charges' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\BrandResourcesList', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\BillingChargeResponse', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\BrandResourcesList', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\BillingChargeResponse', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -2473,51 +2549,45 @@ public function getBrandResourcesWithHttpInfo($account_id, $brand_id) } /** - * Operation getBrandResourcesByContentType + * Operation getBrand * - * Returns the specified branding resource file. + * Get information for a specific brand. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $brand_id The unique identifier of a brand. - * @param string $resource_content_type * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return void + * @return \DocuSign\eSign\Model\Brand */ - public function getBrandResourcesByContentType($account_id, $brand_id, $resource_content_type, AccountsApi\GetBrandResourcesByContentTypeOptions $options = null) + public function getBrand($account_id, $brand_id, AccountsApi\GetBrandOptions $options = null) { - list($response) = $this->getBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_id, $resource_content_type, $options); + list($response) = $this->getBrandWithHttpInfo($account_id, $brand_id, $options); return $response; } /** - * Operation getBrandResourcesByContentTypeWithHttpInfo + * Operation getBrandWithHttpInfo * - * Returns the specified branding resource file. + * Get information for a specific brand. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $brand_id The unique identifier of a brand. - * @param string $resource_content_type * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\Brand, HTTP status code, HTTP response headers (array of strings) */ - public function getBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_id, $resource_content_type, AccountsApi\GetBrandResourcesByContentTypeOptions $options = null) + public function getBrandWithHttpInfo($account_id, $brand_id, AccountsApi\GetBrandOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBrandResourcesByContentType'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBrand'); } // verify the required parameter 'brand_id' is set if ($brand_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling getBrandResourcesByContentType'); - } - // verify the required parameter 'resource_content_type' is set - if ($resource_content_type === null) { - throw new \InvalidArgumentException('Missing the required parameter $resource_content_type when calling getBrandResourcesByContentType'); + throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling getBrand'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}"; + $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2532,12 +2602,12 @@ public function getBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_i { // query params // query params - if ($options->getLangcode() !== null) { - $queryParams['langcode'] = $this->apiClient->getSerializer()->toQueryValue($options->getLangcode()); + if ($options->getIncludeExternalReferences() !== null) { + $queryParams['include_external_references'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeExternalReferences()); } // query params - if ($options->getReturnMaster() !== null) { - $queryParams['return_master'] = $this->apiClient->getSerializer()->toQueryValue($options->getReturnMaster()); + if ($options->getIncludeLogos() !== null) { + $queryParams['include_logos'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeLogos()); } } @@ -2557,14 +2627,6 @@ public function getBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_i $resourcePath ); } - // path params - if ($resource_content_type !== null) { - $resourcePath = str_replace( - "{" . "resourceContentType" . "}", - $this->apiClient->getSerializer()->toPathValue($resource_content_type), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -2583,13 +2645,17 @@ public function getBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_i $queryParams, $httpBody, $headerParams, - null, - '/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}' + '\DocuSign\eSign\Model\Brand', + '/v2/accounts/{accountId}/brands/{brandId}' ); - return [null, $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Brand', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Brand', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; case 400: $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); $e->setResponseObject($data); @@ -2601,43 +2667,43 @@ public function getBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_i } /** - * Operation getConsumerDisclosure + * Operation getBrandExportFile * - * Gets the Electronic Record and Signature Disclosure. + * Export a specific brand. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. + * @param string $brand_id The unique identifier of a brand. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\ConsumerDisclosure + * @return void */ - public function getConsumerDisclosure($account_id, $lang_code) + public function getBrandExportFile($account_id, $brand_id) { - list($response) = $this->getConsumerDisclosureWithHttpInfo($account_id, $lang_code); + list($response) = $this->getBrandExportFileWithHttpInfo($account_id, $brand_id); return $response; } /** - * Operation getConsumerDisclosureWithHttpInfo + * Operation getBrandExportFileWithHttpInfo * - * Gets the Electronic Record and Signature Disclosure. + * Export a specific brand. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. + * @param string $brand_id The unique identifier of a brand. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings) + * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function getConsumerDisclosureWithHttpInfo($account_id, $lang_code) + public function getBrandExportFileWithHttpInfo($account_id, $brand_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getConsumerDisclosure'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBrandExportFile'); } - // verify the required parameter 'lang_code' is set - if ($lang_code === null) { - throw new \InvalidArgumentException('Missing the required parameter $lang_code when calling getConsumerDisclosure'); + // verify the required parameter 'brand_id' is set + if ($brand_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling getBrandExportFile'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/consumer_disclosure/{langCode}"; + $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/file"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2658,10 +2724,10 @@ public function getConsumerDisclosureWithHttpInfo($account_id, $lang_code) ); } // path params - if ($lang_code !== null) { + if ($brand_id !== null) { $resourcePath = str_replace( - "{" . "langCode" . "}", - $this->apiClient->getSerializer()->toPathValue($lang_code), + "{" . "brandId" . "}", + $this->apiClient->getSerializer()->toPathValue($brand_id), $resourcePath ); } @@ -2683,17 +2749,13 @@ public function getConsumerDisclosureWithHttpInfo($account_id, $lang_code) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\ConsumerDisclosure', - '/v2/accounts/{accountId}/consumer_disclosure/{langCode}' + null, + '/v2/accounts/{accountId}/brands/{brandId}/file' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ConsumerDisclosure', $httpHeader), $statusCode, $httpHeader]; + return [null, $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ConsumerDisclosure', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; case 400: $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); $e->setResponseObject($data); @@ -2705,57 +2767,59 @@ public function getConsumerDisclosureWithHttpInfo($account_id, $lang_code) } /** - * Operation getConsumerDisclosureDefault + * Operation getBrandLogoByType * - * Gets the Electronic Record and Signature Disclosure for the account. + * Obtains the specified image for a brand. * * @param string $account_id The external account number (int) or account ID Guid. - * @param $options Options for modifying the behavior of the function. (optional) + * @param string $brand_id The unique identifier of a brand. + * @param string $logo_type One of **Primary**, **Secondary** or **Email**. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\ConsumerDisclosure + * @return \SplFileObject */ - public function getConsumerDisclosureDefault($account_id, AccountsApi\GetConsumerDisclosureDefaultOptions $options = null) + public function getBrandLogoByType($account_id, $brand_id, $logo_type) { - list($response) = $this->getConsumerDisclosureDefaultWithHttpInfo($account_id, $options); + list($response) = $this->getBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_type); return $response; } /** - * Operation getConsumerDisclosureDefaultWithHttpInfo + * Operation getBrandLogoByTypeWithHttpInfo * - * Gets the Electronic Record and Signature Disclosure for the account. + * Obtains the specified image for a brand. * * @param string $account_id The external account number (int) or account ID Guid. - * @param $options Options for modifying the behavior of the function. (optional) + * @param string $brand_id The unique identifier of a brand. + * @param string $logo_type One of **Primary**, **Secondary** or **Email**. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings) + * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) */ - public function getConsumerDisclosureDefaultWithHttpInfo($account_id, AccountsApi\GetConsumerDisclosureDefaultOptions $options = null) + public function getBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_type) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getConsumerDisclosureDefault'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBrandLogoByType'); + } + // verify the required parameter 'brand_id' is set + if ($brand_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling getBrandLogoByType'); + } + // verify the required parameter 'logo_type' is set + if ($logo_type === null) { + throw new \InvalidArgumentException('Missing the required parameter $logo_type when calling getBrandLogoByType'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/consumer_disclosure"; + $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}"; $httpBody = ''; $queryParams = []; $headerParams = []; $formParams = []; - $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + $_header_accept = $this->apiClient->selectHeaderAccept(['image/png']); if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getLangCode() !== null) { - $queryParams['langCode'] = $this->apiClient->getSerializer()->toQueryValue($options->getLangCode()); - } - } // path params if ($account_id !== null) { @@ -2765,6 +2829,22 @@ public function getConsumerDisclosureDefaultWithHttpInfo($account_id, AccountsAp $resourcePath ); } + // path params + if ($brand_id !== null) { + $resourcePath = str_replace( + "{" . "brandId" . "}", + $this->apiClient->getSerializer()->toPathValue($brand_id), + $resourcePath + ); + } + // path params + if ($logo_type !== null) { + $resourcePath = str_replace( + "{" . "logoType" . "}", + $this->apiClient->getSerializer()->toPathValue($logo_type), + $resourcePath + ); + } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -2783,15 +2863,15 @@ public function getConsumerDisclosureDefaultWithHttpInfo($account_id, AccountsAp $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\ConsumerDisclosure', - '/v2/accounts/{accountId}/consumer_disclosure' + '\SplFileObject', + '/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ConsumerDisclosure', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\SplFileObject', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ConsumerDisclosure', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -2805,37 +2885,43 @@ public function getConsumerDisclosureDefaultWithHttpInfo($account_id, AccountsAp } /** - * Operation getENoteConfiguration + * Operation getBrandResources * - * Returns the configuration information for the eNote eOriginal integration. + * Returns the specified account's list of branding resources (metadata). * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $brand_id The unique identifier of a brand. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\ENoteConfiguration + * @return \DocuSign\eSign\Model\BrandResourcesList */ - public function getENoteConfiguration($account_id) + public function getBrandResources($account_id, $brand_id) { - list($response) = $this->getENoteConfigurationWithHttpInfo($account_id); + list($response) = $this->getBrandResourcesWithHttpInfo($account_id, $brand_id); return $response; } /** - * Operation getENoteConfigurationWithHttpInfo + * Operation getBrandResourcesWithHttpInfo * - * Returns the configuration information for the eNote eOriginal integration. + * Returns the specified account's list of branding resources (metadata). * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $brand_id The unique identifier of a brand. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\ENoteConfiguration, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\BrandResourcesList, HTTP status code, HTTP response headers (array of strings) */ - public function getENoteConfigurationWithHttpInfo($account_id) + public function getBrandResourcesWithHttpInfo($account_id, $brand_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getENoteConfiguration'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBrandResources'); + } + // verify the required parameter 'brand_id' is set + if ($brand_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling getBrandResources'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/settings/enote_configuration"; + $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/resources"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2855,6 +2941,14 @@ public function getENoteConfigurationWithHttpInfo($account_id) $resourcePath ); } + // path params + if ($brand_id !== null) { + $resourcePath = str_replace( + "{" . "brandId" . "}", + $this->apiClient->getSerializer()->toPathValue($brand_id), + $resourcePath + ); + } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -2873,15 +2967,15 @@ public function getENoteConfigurationWithHttpInfo($account_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\ENoteConfiguration', - '/v2/accounts/{accountId}/settings/enote_configuration' + '\DocuSign\eSign\Model\BrandResourcesList', + '/v2/accounts/{accountId}/brands/{brandId}/resources' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ENoteConfiguration', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\BrandResourcesList', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ENoteConfiguration', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\BrandResourcesList', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -2895,45 +2989,51 @@ public function getENoteConfigurationWithHttpInfo($account_id) } /** - * Operation getPermissionProfile + * Operation getBrandResourcesByContentType * - * Returns a permissions profile in the specified account. + * Returns the specified branding resource file. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $permission_profile_id + * @param string $brand_id The unique identifier of a brand. + * @param string $resource_content_type * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\PermissionProfile + * @return void */ - public function getPermissionProfile($account_id, $permission_profile_id, AccountsApi\GetPermissionProfileOptions $options = null) + public function getBrandResourcesByContentType($account_id, $brand_id, $resource_content_type, AccountsApi\GetBrandResourcesByContentTypeOptions $options = null) { - list($response) = $this->getPermissionProfileWithHttpInfo($account_id, $permission_profile_id, $options); + list($response) = $this->getBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_id, $resource_content_type, $options); return $response; } /** - * Operation getPermissionProfileWithHttpInfo + * Operation getBrandResourcesByContentTypeWithHttpInfo * - * Returns a permissions profile in the specified account. + * Returns the specified branding resource file. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $permission_profile_id + * @param string $brand_id The unique identifier of a brand. + * @param string $resource_content_type * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\PermissionProfile, HTTP status code, HTTP response headers (array of strings) + * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function getPermissionProfileWithHttpInfo($account_id, $permission_profile_id, AccountsApi\GetPermissionProfileOptions $options = null) + public function getBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_id, $resource_content_type, AccountsApi\GetBrandResourcesByContentTypeOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getPermissionProfile'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getBrandResourcesByContentType'); } - // verify the required parameter 'permission_profile_id' is set - if ($permission_profile_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $permission_profile_id when calling getPermissionProfile'); + // verify the required parameter 'brand_id' is set + if ($brand_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling getBrandResourcesByContentType'); + } + // verify the required parameter 'resource_content_type' is set + if ($resource_content_type === null) { + throw new \InvalidArgumentException('Missing the required parameter $resource_content_type when calling getBrandResourcesByContentType'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}"; + $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2948,8 +3048,12 @@ public function getPermissionProfileWithHttpInfo($account_id, $permission_profil { // query params // query params - if ($options->getInclude() !== null) { - $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); + if ($options->getLangcode() !== null) { + $queryParams['langcode'] = $this->apiClient->getSerializer()->toQueryValue($options->getLangcode()); + } + // query params + if ($options->getReturnMaster() !== null) { + $queryParams['return_master'] = $this->apiClient->getSerializer()->toQueryValue($options->getReturnMaster()); } } @@ -2962,10 +3066,18 @@ public function getPermissionProfileWithHttpInfo($account_id, $permission_profil ); } // path params - if ($permission_profile_id !== null) { + if ($brand_id !== null) { $resourcePath = str_replace( - "{" . "permissionProfileId" . "}", - $this->apiClient->getSerializer()->toPathValue($permission_profile_id), + "{" . "brandId" . "}", + $this->apiClient->getSerializer()->toPathValue($brand_id), + $resourcePath + ); + } + // path params + if ($resource_content_type !== null) { + $resourcePath = str_replace( + "{" . "resourceContentType" . "}", + $this->apiClient->getSerializer()->toPathValue($resource_content_type), $resourcePath ); } @@ -2987,17 +3099,13 @@ public function getPermissionProfileWithHttpInfo($account_id, $permission_profil $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\PermissionProfile', - '/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}' + null, + '/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\PermissionProfile', $httpHeader), $statusCode, $httpHeader]; + return [null, $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\PermissionProfile', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; case 400: $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); $e->setResponseObject($data); @@ -3009,31 +3117,43 @@ public function getPermissionProfileWithHttpInfo($account_id, $permission_profil } /** - * Operation getProvisioning + * Operation getConsumerDisclosure * - * Retrieves the account provisioning information for the account. + * Gets the Electronic Record and Signature Disclosure. * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\ProvisioningInformation + * @return \DocuSign\eSign\Model\ConsumerDisclosure */ - public function getProvisioning() + public function getConsumerDisclosure($account_id, $lang_code) { - list($response) = $this->getProvisioningWithHttpInfo(); + list($response) = $this->getConsumerDisclosureWithHttpInfo($account_id, $lang_code); return $response; } /** - * Operation getProvisioningWithHttpInfo + * Operation getConsumerDisclosureWithHttpInfo * - * Retrieves the account provisioning information for the account. + * Gets the Electronic Record and Signature Disclosure. * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\ProvisioningInformation, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings) */ - public function getProvisioningWithHttpInfo() + public function getConsumerDisclosureWithHttpInfo($account_id, $lang_code) { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getConsumerDisclosure'); + } + // verify the required parameter 'lang_code' is set + if ($lang_code === null) { + throw new \InvalidArgumentException('Missing the required parameter $lang_code when calling getConsumerDisclosure'); + } // parse inputs - $resourcePath = "/v2/accounts/provisioning"; + $resourcePath = "/v2/accounts/{accountId}/consumer_disclosure/{langCode}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3045,6 +3165,22 @@ public function getProvisioningWithHttpInfo() $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($lang_code !== null) { + $resourcePath = str_replace( + "{" . "langCode" . "}", + $this->apiClient->getSerializer()->toPathValue($lang_code), + $resourcePath + ); + } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -3063,15 +3199,15 @@ public function getProvisioningWithHttpInfo() $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\ProvisioningInformation', - '/v2/accounts/provisioning' + '\DocuSign\eSign\Model\ConsumerDisclosure', + '/v2/accounts/{accountId}/consumer_disclosure/{langCode}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ProvisioningInformation', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ConsumerDisclosure', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ProvisioningInformation', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ConsumerDisclosure', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3085,39 +3221,39 @@ public function getProvisioningWithHttpInfo() } /** - * Operation listBrands + * Operation getConsumerDisclosureDefault * - * Gets a list of brand profiles. + * Gets the Electronic Record and Signature Disclosure for the account. * * @param string $account_id The external account number (int) or account ID Guid. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\BrandsResponse + * @return \DocuSign\eSign\Model\ConsumerDisclosure */ - public function listBrands($account_id, AccountsApi\ListBrandsOptions $options = null) + public function getConsumerDisclosureDefault($account_id, AccountsApi\GetConsumerDisclosureDefaultOptions $options = null) { - list($response) = $this->listBrandsWithHttpInfo($account_id, $options); + list($response) = $this->getConsumerDisclosureDefaultWithHttpInfo($account_id, $options); return $response; } /** - * Operation listBrandsWithHttpInfo + * Operation getConsumerDisclosureDefaultWithHttpInfo * - * Gets a list of brand profiles. + * Gets the Electronic Record and Signature Disclosure for the account. * * @param string $account_id The external account number (int) or account ID Guid. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\BrandsResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings) */ - public function listBrandsWithHttpInfo($account_id, AccountsApi\ListBrandsOptions $options = null) + public function getConsumerDisclosureDefaultWithHttpInfo($account_id, AccountsApi\GetConsumerDisclosureDefaultOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listBrands'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getConsumerDisclosureDefault'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/brands"; + $resourcePath = "/v2/accounts/{accountId}/consumer_disclosure"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3132,12 +3268,8 @@ public function listBrandsWithHttpInfo($account_id, AccountsApi\ListBrandsOption { // query params // query params - if ($options->getExcludeDistributorBrand() !== null) { - $queryParams['exclude_distributor_brand'] = $this->apiClient->getSerializer()->toQueryValue($options->getExcludeDistributorBrand()); - } - // query params - if ($options->getIncludeLogos() !== null) { - $queryParams['include_logos'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeLogos()); + if ($options->getLangCode() !== null) { + $queryParams['langCode'] = $this->apiClient->getSerializer()->toQueryValue($options->getLangCode()); } } @@ -3167,15 +3299,15 @@ public function listBrandsWithHttpInfo($account_id, AccountsApi\ListBrandsOption $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\BrandsResponse', - '/v2/accounts/{accountId}/brands' + '\DocuSign\eSign\Model\ConsumerDisclosure', + '/v2/accounts/{accountId}/consumer_disclosure' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\BrandsResponse', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ConsumerDisclosure', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\BrandsResponse', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ConsumerDisclosure', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3189,37 +3321,37 @@ public function listBrandsWithHttpInfo($account_id, AccountsApi\ListBrandsOption } /** - * Operation listCustomFields + * Operation getENoteConfiguration * - * Gets a list of custom fields associated with the account. + * Returns the configuration information for the eNote eOriginal integration. * * @param string $account_id The external account number (int) or account ID Guid. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\CustomFields + * @return \DocuSign\eSign\Model\ENoteConfiguration */ - public function listCustomFields($account_id) + public function getENoteConfiguration($account_id) { - list($response) = $this->listCustomFieldsWithHttpInfo($account_id); + list($response) = $this->getENoteConfigurationWithHttpInfo($account_id); return $response; } /** - * Operation listCustomFieldsWithHttpInfo + * Operation getENoteConfigurationWithHttpInfo * - * Gets a list of custom fields associated with the account. + * Returns the configuration information for the eNote eOriginal integration. * * @param string $account_id The external account number (int) or account ID Guid. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\ENoteConfiguration, HTTP status code, HTTP response headers (array of strings) */ - public function listCustomFieldsWithHttpInfo($account_id) + public function getENoteConfigurationWithHttpInfo($account_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listCustomFields'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getENoteConfiguration'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/custom_fields"; + $resourcePath = "/v2/accounts/{accountId}/settings/enote_configuration"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3257,15 +3389,15 @@ public function listCustomFieldsWithHttpInfo($account_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\CustomFields', - '/v2/accounts/{accountId}/custom_fields' + '\DocuSign\eSign\Model\ENoteConfiguration', + '/v2/accounts/{accountId}/settings/enote_configuration' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\CustomFields', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ENoteConfiguration', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\CustomFields', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ENoteConfiguration', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3279,39 +3411,37 @@ public function listCustomFieldsWithHttpInfo($account_id) } /** - * Operation listPermissions + * Operation getPasswordRules * - * Gets a list of permission profiles. + * Get the password rules * * @param string $account_id The external account number (int) or account ID Guid. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\PermissionProfileInformation + * @return \DocuSign\eSign\Model\AccountPasswordRules */ - public function listPermissions($account_id, AccountsApi\ListPermissionsOptions $options = null) + public function getPasswordRules($account_id) { - list($response) = $this->listPermissionsWithHttpInfo($account_id, $options); + list($response) = $this->getPasswordRulesWithHttpInfo($account_id); return $response; } /** - * Operation listPermissionsWithHttpInfo + * Operation getPasswordRulesWithHttpInfo * - * Gets a list of permission profiles. + * Get the password rules * * @param string $account_id The external account number (int) or account ID Guid. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\PermissionProfileInformation, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\AccountPasswordRules, HTTP status code, HTTP response headers (array of strings) */ - public function listPermissionsWithHttpInfo($account_id, AccountsApi\ListPermissionsOptions $options = null) + public function getPasswordRulesWithHttpInfo($account_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listPermissions'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getPasswordRules'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/permission_profiles"; + $resourcePath = "/v2/accounts/{accountId}/settings/password_rules"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3322,14 +3452,6 @@ public function listPermissionsWithHttpInfo($account_id, AccountsApi\ListPermiss } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getInclude() !== null) { - $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); - } - } // path params if ($account_id !== null) { @@ -3357,15 +3479,15 @@ public function listPermissionsWithHttpInfo($account_id, AccountsApi\ListPermiss $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\PermissionProfileInformation', - '/v2/accounts/{accountId}/permission_profiles' + '\DocuSign\eSign\Model\AccountPasswordRules', + '/v2/accounts/{accountId}/settings/password_rules' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\PermissionProfileInformation', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountPasswordRules', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\PermissionProfileInformation', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountPasswordRules', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3379,39 +3501,31 @@ public function listPermissionsWithHttpInfo($account_id, AccountsApi\ListPermiss } /** - * Operation listRecipientNamesByEmail + * Operation getPasswordRules_0 * - * Gets recipient names associated with an email address. + * Get membership account password rules * - * @param string $account_id The external account number (int) or account ID Guid. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\RecipientNamesResponse + * @return \DocuSign\eSign\Model\UserPasswordRules */ - public function listRecipientNamesByEmail($account_id, AccountsApi\ListRecipientNamesByEmailOptions $options = null) + public function getPasswordRules_0() { - list($response) = $this->listRecipientNamesByEmailWithHttpInfo($account_id, $options); + list($response) = $this->getPasswordRules_0WithHttpInfo(); return $response; } /** - * Operation listRecipientNamesByEmailWithHttpInfo + * Operation getPasswordRules_0WithHttpInfo * - * Gets recipient names associated with an email address. + * Get membership account password rules * - * @param string $account_id The external account number (int) or account ID Guid. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\RecipientNamesResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\UserPasswordRules, HTTP status code, HTTP response headers (array of strings) */ - public function listRecipientNamesByEmailWithHttpInfo($account_id, AccountsApi\ListRecipientNamesByEmailOptions $options = null) + public function getPasswordRules_0WithHttpInfo() { - // verify the required parameter 'account_id' is set - if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listRecipientNamesByEmail'); - } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/recipient_names"; + $resourcePath = "/v2/current_user/password_rules"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3422,23 +3536,7 @@ public function listRecipientNamesByEmailWithHttpInfo($account_id, AccountsApi\L } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getEmail() !== null) { - $queryParams['email'] = $this->apiClient->getSerializer()->toQueryValue($options->getEmail()); - } - } - // path params - if ($account_id !== null) { - $resourcePath = str_replace( - "{" . "accountId" . "}", - $this->apiClient->getSerializer()->toPathValue($account_id), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -3457,15 +3555,15 @@ public function listRecipientNamesByEmailWithHttpInfo($account_id, AccountsApi\L $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\RecipientNamesResponse', - '/v2/accounts/{accountId}/recipient_names' + '\DocuSign\eSign\Model\UserPasswordRules', + '/v2/current_user/password_rules' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\RecipientNamesResponse', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\UserPasswordRules', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\RecipientNamesResponse', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\UserPasswordRules', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3479,37 +3577,45 @@ public function listRecipientNamesByEmailWithHttpInfo($account_id, AccountsApi\L } /** - * Operation listSettings + * Operation getPermissionProfile * - * Gets account settings information. + * Returns a permissions profile in the specified account. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $permission_profile_id + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\AccountSettingsInformation + * @return \DocuSign\eSign\Model\PermissionProfile */ - public function listSettings($account_id) + public function getPermissionProfile($account_id, $permission_profile_id, AccountsApi\GetPermissionProfileOptions $options = null) { - list($response) = $this->listSettingsWithHttpInfo($account_id); + list($response) = $this->getPermissionProfileWithHttpInfo($account_id, $permission_profile_id, $options); return $response; } /** - * Operation listSettingsWithHttpInfo + * Operation getPermissionProfileWithHttpInfo * - * Gets account settings information. + * Returns a permissions profile in the specified account. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $permission_profile_id + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\AccountSettingsInformation, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\PermissionProfile, HTTP status code, HTTP response headers (array of strings) */ - public function listSettingsWithHttpInfo($account_id) + public function getPermissionProfileWithHttpInfo($account_id, $permission_profile_id, AccountsApi\GetPermissionProfileOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listSettings'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getPermissionProfile'); + } + // verify the required parameter 'permission_profile_id' is set + if ($permission_profile_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $permission_profile_id when calling getPermissionProfile'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/settings"; + $resourcePath = "/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3520,6 +3626,14 @@ public function listSettingsWithHttpInfo($account_id) } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getInclude() !== null) { + $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); + } + } // path params if ($account_id !== null) { @@ -3529,6 +3643,14 @@ public function listSettingsWithHttpInfo($account_id) $resourcePath ); } + // path params + if ($permission_profile_id !== null) { + $resourcePath = str_replace( + "{" . "permissionProfileId" . "}", + $this->apiClient->getSerializer()->toPathValue($permission_profile_id), + $resourcePath + ); + } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -3547,15 +3669,15 @@ public function listSettingsWithHttpInfo($account_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\AccountSettingsInformation', - '/v2/accounts/{accountId}/settings' + '\DocuSign\eSign\Model\PermissionProfile', + '/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountSettingsInformation', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\PermissionProfile', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountSettingsInformation', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\PermissionProfile', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3569,39 +3691,31 @@ public function listSettingsWithHttpInfo($account_id) } /** - * Operation listSharedAccess + * Operation getProvisioning * - * Reserved: Gets the shared item status for one or more users. + * Retrieves the account provisioning information for the account. * - * @param string $account_id The external account number (int) or account ID Guid. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\AccountSharedAccess + * @return \DocuSign\eSign\Model\ProvisioningInformation */ - public function listSharedAccess($account_id, AccountsApi\ListSharedAccessOptions $options = null) + public function getProvisioning() { - list($response) = $this->listSharedAccessWithHttpInfo($account_id, $options); + list($response) = $this->getProvisioningWithHttpInfo(); return $response; } /** - * Operation listSharedAccessWithHttpInfo + * Operation getProvisioningWithHttpInfo * - * Reserved: Gets the shared item status for one or more users. + * Retrieves the account provisioning information for the account. * - * @param string $account_id The external account number (int) or account ID Guid. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\AccountSharedAccess, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\ProvisioningInformation, HTTP status code, HTTP response headers (array of strings) */ - public function listSharedAccessWithHttpInfo($account_id, AccountsApi\ListSharedAccessOptions $options = null) + public function getProvisioningWithHttpInfo() { - // verify the required parameter 'account_id' is set - if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listSharedAccess'); - } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/shared_access"; + $resourcePath = "/v2/accounts/provisioning"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3612,51 +3726,7 @@ public function listSharedAccessWithHttpInfo($account_id, AccountsApi\ListShared } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getCount() !== null) { - $queryParams['count'] = $this->apiClient->getSerializer()->toQueryValue($options->getCount()); - } - // query params - if ($options->getEnvelopesNotSharedUserStatus() !== null) { - $queryParams['envelopes_not_shared_user_status'] = $this->apiClient->getSerializer()->toQueryValue($options->getEnvelopesNotSharedUserStatus()); - } - // query params - if ($options->getFolderIds() !== null) { - $queryParams['folder_ids'] = $this->apiClient->getSerializer()->toQueryValue($options->getFolderIds()); - } - // query params - if ($options->getItemType() !== null) { - $queryParams['item_type'] = $this->apiClient->getSerializer()->toQueryValue($options->getItemType()); - } - // query params - if ($options->getSearchText() !== null) { - $queryParams['search_text'] = $this->apiClient->getSerializer()->toQueryValue($options->getSearchText()); - } - // query params - if ($options->getShared() !== null) { - $queryParams['shared'] = $this->apiClient->getSerializer()->toQueryValue($options->getShared()); - } - // query params - if ($options->getStartPosition() !== null) { - $queryParams['start_position'] = $this->apiClient->getSerializer()->toQueryValue($options->getStartPosition()); - } - // query params - if ($options->getUserIds() !== null) { - $queryParams['user_ids'] = $this->apiClient->getSerializer()->toQueryValue($options->getUserIds()); - } - } - // path params - if ($account_id !== null) { - $resourcePath = str_replace( - "{" . "accountId" . "}", - $this->apiClient->getSerializer()->toPathValue($account_id), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -3675,15 +3745,15 @@ public function listSharedAccessWithHttpInfo($account_id, AccountsApi\ListShared $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\AccountSharedAccess', - '/v2/accounts/{accountId}/shared_access' + '\DocuSign\eSign\Model\ProvisioningInformation', + '/v2/accounts/provisioning' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountSharedAccess', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ProvisioningInformation', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountSharedAccess', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ProvisioningInformation', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3697,37 +3767,37 @@ public function listSharedAccessWithHttpInfo($account_id, AccountsApi\ListShared } /** - * Operation listSignatureProviders + * Operation getSupportedLanguages * - * Returns Account available signature providers for specified account. + * Gets list of supported languages for recipient language setting. * * @param string $account_id The external account number (int) or account ID Guid. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\AccountSignatureProviders + * @return \DocuSign\eSign\Model\SupportedLanguages */ - public function listSignatureProviders($account_id) + public function getSupportedLanguages($account_id) { - list($response) = $this->listSignatureProvidersWithHttpInfo($account_id); + list($response) = $this->getSupportedLanguagesWithHttpInfo($account_id); return $response; } /** - * Operation listSignatureProvidersWithHttpInfo + * Operation getSupportedLanguagesWithHttpInfo * - * Returns Account available signature providers for specified account. + * Gets list of supported languages for recipient language setting. * * @param string $account_id The external account number (int) or account ID Guid. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\AccountSignatureProviders, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\SupportedLanguages, HTTP status code, HTTP response headers (array of strings) */ - public function listSignatureProvidersWithHttpInfo($account_id) + public function getSupportedLanguagesWithHttpInfo($account_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listSignatureProviders'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getSupportedLanguages'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/signatureProviders"; + $resourcePath = "/v2/accounts/{accountId}/supported_languages"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3765,15 +3835,15 @@ public function listSignatureProvidersWithHttpInfo($account_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\AccountSignatureProviders', - '/v2/accounts/{accountId}/signatureProviders' + '\DocuSign\eSign\Model\SupportedLanguages', + '/v2/accounts/{accountId}/supported_languages' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountSignatureProviders', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\SupportedLanguages', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountSignatureProviders', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\SupportedLanguages', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3787,37 +3857,37 @@ public function listSignatureProvidersWithHttpInfo($account_id) } /** - * Operation listUnsupportedFileTypes + * Operation getWatermark * - * Gets a list of unsupported file types. + * Get watermark information. * * @param string $account_id The external account number (int) or account ID Guid. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\FileTypeList + * @return \DocuSign\eSign\Model\Watermark */ - public function listUnsupportedFileTypes($account_id) + public function getWatermark($account_id) { - list($response) = $this->listUnsupportedFileTypesWithHttpInfo($account_id); + list($response) = $this->getWatermarkWithHttpInfo($account_id); return $response; } /** - * Operation listUnsupportedFileTypesWithHttpInfo + * Operation getWatermarkWithHttpInfo * - * Gets a list of unsupported file types. + * Get watermark information. * * @param string $account_id The external account number (int) or account ID Guid. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\FileTypeList, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\Watermark, HTTP status code, HTTP response headers (array of strings) */ - public function listUnsupportedFileTypesWithHttpInfo($account_id) + public function getWatermarkWithHttpInfo($account_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listUnsupportedFileTypes'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getWatermark'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/unsupported_file_types"; + $resourcePath = "/v2/accounts/{accountId}/watermark"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3855,15 +3925,15 @@ public function listUnsupportedFileTypesWithHttpInfo($account_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\FileTypeList', - '/v2/accounts/{accountId}/unsupported_file_types' + '\DocuSign\eSign\Model\Watermark', + '/v2/accounts/{accountId}/watermark' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\FileTypeList', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Watermark', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\FileTypeList', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Watermark', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3877,39 +3947,39 @@ public function listUnsupportedFileTypesWithHttpInfo($account_id) } /** - * Operation updateAccountTabSettings + * Operation getWatermarkPreview * - * Modifies tab settings for specified account + * Get watermark preview. * * @param string $account_id The external account number (int) or account ID Guid. - * @param \DocuSign\eSign\Model\TabAccountSettings $tab_account_settings (optional) + * @param \DocuSign\eSign\Model\Watermark $watermark (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\TabAccountSettings + * @return \DocuSign\eSign\Model\Watermark */ - public function updateAccountTabSettings($account_id, $tab_account_settings = null) + public function getWatermarkPreview($account_id, $watermark = null) { - list($response) = $this->updateAccountTabSettingsWithHttpInfo($account_id, $tab_account_settings); + list($response) = $this->getWatermarkPreviewWithHttpInfo($account_id, $watermark); return $response; } /** - * Operation updateAccountTabSettingsWithHttpInfo + * Operation getWatermarkPreviewWithHttpInfo * - * Modifies tab settings for specified account + * Get watermark preview. * * @param string $account_id The external account number (int) or account ID Guid. - * @param \DocuSign\eSign\Model\TabAccountSettings $tab_account_settings (optional) + * @param \DocuSign\eSign\Model\Watermark $watermark (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\TabAccountSettings, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\Watermark, HTTP status code, HTTP response headers (array of strings) */ - public function updateAccountTabSettingsWithHttpInfo($account_id, $tab_account_settings = null) + public function getWatermarkPreviewWithHttpInfo($account_id, $watermark = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateAccountTabSettings'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getWatermarkPreview'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/settings/tabs"; + $resourcePath = "/v2/accounts/{accountId}/watermark/preview"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3934,8 +4004,8 @@ public function updateAccountTabSettingsWithHttpInfo($account_id, $tab_account_s // body params $_tempBody = null; - if (isset($tab_account_settings)) { - $_tempBody = $tab_account_settings; + if (isset($watermark)) { + $_tempBody = $watermark; } // for model (json/xml) @@ -3952,15 +4022,15 @@ public function updateAccountTabSettingsWithHttpInfo($account_id, $tab_account_s $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\TabAccountSettings', - '/v2/accounts/{accountId}/settings/tabs' + '\DocuSign\eSign\Model\Watermark', + '/v2/accounts/{accountId}/watermark/preview' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\TabAccountSettings', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Watermark', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\TabAccountSettings', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Watermark', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3974,45 +4044,1290 @@ public function updateAccountTabSettingsWithHttpInfo($account_id, $tab_account_s } /** - * Operation updateBrand + * Operation listBrands * - * Updates an existing brand. + * Gets a list of brand profiles. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. - * @param \DocuSign\eSign\Model\Brand $brand (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\Brand + * @return \DocuSign\eSign\Model\BrandsResponse */ - public function updateBrand($account_id, $brand_id, $brand = null) + public function listBrands($account_id, AccountsApi\ListBrandsOptions $options = null) { - list($response) = $this->updateBrandWithHttpInfo($account_id, $brand_id, $brand); + list($response) = $this->listBrandsWithHttpInfo($account_id, $options); + return $response; + } + + /** + * Operation listBrandsWithHttpInfo + * + * Gets a list of brand profiles. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\BrandsResponse, HTTP status code, HTTP response headers (array of strings) + */ + public function listBrandsWithHttpInfo($account_id, AccountsApi\ListBrandsOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listBrands'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/brands"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getExcludeDistributorBrand() !== null) { + $queryParams['exclude_distributor_brand'] = $this->apiClient->getSerializer()->toQueryValue($options->getExcludeDistributorBrand()); + } + // query params + if ($options->getIncludeLogos() !== null) { + $queryParams['include_logos'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeLogos()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\BrandsResponse', + '/v2/accounts/{accountId}/brands' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\BrandsResponse', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\BrandsResponse', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation listCustomFields + * + * Gets a list of custom fields associated with the account. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\CustomFields + */ + public function listCustomFields($account_id) + { + list($response) = $this->listCustomFieldsWithHttpInfo($account_id); + return $response; + } + + /** + * Operation listCustomFieldsWithHttpInfo + * + * Gets a list of custom fields associated with the account. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings) + */ + public function listCustomFieldsWithHttpInfo($account_id) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listCustomFields'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/custom_fields"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\CustomFields', + '/v2/accounts/{accountId}/custom_fields' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\CustomFields', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\CustomFields', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation listPermissions + * + * Gets a list of permission profiles. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\PermissionProfileInformation + */ + public function listPermissions($account_id, AccountsApi\ListPermissionsOptions $options = null) + { + list($response) = $this->listPermissionsWithHttpInfo($account_id, $options); + return $response; + } + + /** + * Operation listPermissionsWithHttpInfo + * + * Gets a list of permission profiles. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\PermissionProfileInformation, HTTP status code, HTTP response headers (array of strings) + */ + public function listPermissionsWithHttpInfo($account_id, AccountsApi\ListPermissionsOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listPermissions'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/permission_profiles"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getInclude() !== null) { + $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\PermissionProfileInformation', + '/v2/accounts/{accountId}/permission_profiles' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\PermissionProfileInformation', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\PermissionProfileInformation', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation listRecipientNamesByEmail + * + * Gets recipient names associated with an email address. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\RecipientNamesResponse + */ + public function listRecipientNamesByEmail($account_id, AccountsApi\ListRecipientNamesByEmailOptions $options = null) + { + list($response) = $this->listRecipientNamesByEmailWithHttpInfo($account_id, $options); + return $response; + } + + /** + * Operation listRecipientNamesByEmailWithHttpInfo + * + * Gets recipient names associated with an email address. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\RecipientNamesResponse, HTTP status code, HTTP response headers (array of strings) + */ + public function listRecipientNamesByEmailWithHttpInfo($account_id, AccountsApi\ListRecipientNamesByEmailOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listRecipientNamesByEmail'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/recipient_names"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getEmail() !== null) { + $queryParams['email'] = $this->apiClient->getSerializer()->toQueryValue($options->getEmail()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\RecipientNamesResponse', + '/v2/accounts/{accountId}/recipient_names' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\RecipientNamesResponse', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\RecipientNamesResponse', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation listSettings + * + * Gets account settings information. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\AccountSettingsInformation + */ + public function listSettings($account_id) + { + list($response) = $this->listSettingsWithHttpInfo($account_id); + return $response; + } + + /** + * Operation listSettingsWithHttpInfo + * + * Gets account settings information. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\AccountSettingsInformation, HTTP status code, HTTP response headers (array of strings) + */ + public function listSettingsWithHttpInfo($account_id) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listSettings'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/settings"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\AccountSettingsInformation', + '/v2/accounts/{accountId}/settings' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountSettingsInformation', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountSettingsInformation', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation listSharedAccess + * + * Reserved: Gets the shared item status for one or more users. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\AccountSharedAccess + */ + public function listSharedAccess($account_id, AccountsApi\ListSharedAccessOptions $options = null) + { + list($response) = $this->listSharedAccessWithHttpInfo($account_id, $options); + return $response; + } + + /** + * Operation listSharedAccessWithHttpInfo + * + * Reserved: Gets the shared item status for one or more users. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\AccountSharedAccess, HTTP status code, HTTP response headers (array of strings) + */ + public function listSharedAccessWithHttpInfo($account_id, AccountsApi\ListSharedAccessOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listSharedAccess'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/shared_access"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getCount() !== null) { + $queryParams['count'] = $this->apiClient->getSerializer()->toQueryValue($options->getCount()); + } + // query params + if ($options->getEnvelopesNotSharedUserStatus() !== null) { + $queryParams['envelopes_not_shared_user_status'] = $this->apiClient->getSerializer()->toQueryValue($options->getEnvelopesNotSharedUserStatus()); + } + // query params + if ($options->getFolderIds() !== null) { + $queryParams['folder_ids'] = $this->apiClient->getSerializer()->toQueryValue($options->getFolderIds()); + } + // query params + if ($options->getItemType() !== null) { + $queryParams['item_type'] = $this->apiClient->getSerializer()->toQueryValue($options->getItemType()); + } + // query params + if ($options->getSearchText() !== null) { + $queryParams['search_text'] = $this->apiClient->getSerializer()->toQueryValue($options->getSearchText()); + } + // query params + if ($options->getShared() !== null) { + $queryParams['shared'] = $this->apiClient->getSerializer()->toQueryValue($options->getShared()); + } + // query params + if ($options->getStartPosition() !== null) { + $queryParams['start_position'] = $this->apiClient->getSerializer()->toQueryValue($options->getStartPosition()); + } + // query params + if ($options->getUserIds() !== null) { + $queryParams['user_ids'] = $this->apiClient->getSerializer()->toQueryValue($options->getUserIds()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\AccountSharedAccess', + '/v2/accounts/{accountId}/shared_access' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountSharedAccess', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountSharedAccess', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation listSignatureProviders + * + * Returns Account available signature providers for specified account. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\AccountSignatureProviders + */ + public function listSignatureProviders($account_id) + { + list($response) = $this->listSignatureProvidersWithHttpInfo($account_id); + return $response; + } + + /** + * Operation listSignatureProvidersWithHttpInfo + * + * Returns Account available signature providers for specified account. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\AccountSignatureProviders, HTTP status code, HTTP response headers (array of strings) + */ + public function listSignatureProvidersWithHttpInfo($account_id) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listSignatureProviders'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/signatureProviders"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\AccountSignatureProviders', + '/v2/accounts/{accountId}/signatureProviders' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountSignatureProviders', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountSignatureProviders', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation listUnsupportedFileTypes + * + * Gets a list of unsupported file types. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\FileTypeList + */ + public function listUnsupportedFileTypes($account_id) + { + list($response) = $this->listUnsupportedFileTypesWithHttpInfo($account_id); + return $response; + } + + /** + * Operation listUnsupportedFileTypesWithHttpInfo + * + * Gets a list of unsupported file types. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\FileTypeList, HTTP status code, HTTP response headers (array of strings) + */ + public function listUnsupportedFileTypesWithHttpInfo($account_id) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listUnsupportedFileTypes'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/unsupported_file_types"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\FileTypeList', + '/v2/accounts/{accountId}/unsupported_file_types' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\FileTypeList', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\FileTypeList', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation updateAccountTabSettings + * + * Modifies tab settings for specified account + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param \DocuSign\eSign\Model\TabAccountSettings $tab_account_settings (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\TabAccountSettings + */ + public function updateAccountTabSettings($account_id, $tab_account_settings = null) + { + list($response) = $this->updateAccountTabSettingsWithHttpInfo($account_id, $tab_account_settings); + return $response; + } + + /** + * Operation updateAccountTabSettingsWithHttpInfo + * + * Modifies tab settings for specified account + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param \DocuSign\eSign\Model\TabAccountSettings $tab_account_settings (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\TabAccountSettings, HTTP status code, HTTP response headers (array of strings) + */ + public function updateAccountTabSettingsWithHttpInfo($account_id, $tab_account_settings = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateAccountTabSettings'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/settings/tabs"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + // body params + $_tempBody = null; + if (isset($tab_account_settings)) { + $_tempBody = $tab_account_settings; + } + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'PUT', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\TabAccountSettings', + '/v2/accounts/{accountId}/settings/tabs' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\TabAccountSettings', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\TabAccountSettings', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation updateBrand + * + * Updates an existing brand. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $brand_id The unique identifier of a brand. + * @param \DocuSign\eSign\Model\Brand $brand (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\Brand + */ + public function updateBrand($account_id, $brand_id, $brand = null) + { + list($response) = $this->updateBrandWithHttpInfo($account_id, $brand_id, $brand); + return $response; + } + + /** + * Operation updateBrandWithHttpInfo + * + * Updates an existing brand. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $brand_id The unique identifier of a brand. + * @param \DocuSign\eSign\Model\Brand $brand (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\Brand, HTTP status code, HTTP response headers (array of strings) + */ + public function updateBrandWithHttpInfo($account_id, $brand_id, $brand = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateBrand'); + } + // verify the required parameter 'brand_id' is set + if ($brand_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling updateBrand'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($brand_id !== null) { + $resourcePath = str_replace( + "{" . "brandId" . "}", + $this->apiClient->getSerializer()->toPathValue($brand_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + // body params + $_tempBody = null; + if (isset($brand)) { + $_tempBody = $brand; + } + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'PUT', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\Brand', + '/v2/accounts/{accountId}/brands/{brandId}' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Brand', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Brand', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation updateBrandLogoByType + * + * Put one branding logo. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $brand_id The unique identifier of a brand. + * @param string $logo_type One of **Primary**, **Secondary** or **Email**. + * @param string $logo_file_bytes Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places (required) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return void + */ + public function updateBrandLogoByType($account_id, $brand_id, $logo_type, $logo_file_bytes) + { + list($response) = $this->updateBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_type, $logo_file_bytes); + return $response; + } + + /** + * Operation updateBrandLogoByTypeWithHttpInfo + * + * Put one branding logo. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $brand_id The unique identifier of a brand. + * @param string $logo_type One of **Primary**, **Secondary** or **Email**. + * @param string $logo_file_bytes Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places (required) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of null, HTTP status code, HTTP response headers (array of strings) + */ + public function updateBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_type, $logo_file_bytes) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateBrandLogoByType'); + } + // verify the required parameter 'brand_id' is set + if ($brand_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling updateBrandLogoByType'); + } + // verify the required parameter 'logo_type' is set + if ($logo_type === null) { + throw new \InvalidArgumentException('Missing the required parameter $logo_type when calling updateBrandLogoByType'); + } + // verify the required parameter 'logo_file_bytes' is set + if ($logo_file_bytes === null) { + throw new \InvalidArgumentException('Missing the required parameter $logo_file_bytes when calling updateBrandLogoByType'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['image/png']); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($brand_id !== null) { + $resourcePath = str_replace( + "{" . "brandId" . "}", + $this->apiClient->getSerializer()->toPathValue($brand_id), + $resourcePath + ); + } + // path params + if ($logo_type !== null) { + $resourcePath = str_replace( + "{" . "logoType" . "}", + $this->apiClient->getSerializer()->toPathValue($logo_type), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + // body params + $_tempBody = null; + if (isset($logo_file_bytes)) { + $_tempBody = $logo_file_bytes; + } + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'PUT', + $queryParams, + $httpBody, + $headerParams, + null, + '/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}' + ); + + return [null, $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation updateBrandResourcesByContentType + * + * Uploads a branding resource file. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $brand_id The unique identifier of a brand. + * @param string $resource_content_type + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\BrandResources + */ + public function updateBrandResourcesByContentType($account_id, $brand_id, $resource_content_type) + { + list($response) = $this->updateBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_id, $resource_content_type); + return $response; + } + + /** + * Operation updateBrandResourcesByContentTypeWithHttpInfo + * + * Uploads a branding resource file. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $brand_id The unique identifier of a brand. + * @param string $resource_content_type + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\BrandResources, HTTP status code, HTTP response headers (array of strings) + */ + public function updateBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_id, $resource_content_type) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateBrandResourcesByContentType'); + } + // verify the required parameter 'brand_id' is set + if ($brand_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling updateBrandResourcesByContentType'); + } + // verify the required parameter 'resource_content_type' is set + if ($resource_content_type === null) { + throw new \InvalidArgumentException('Missing the required parameter $resource_content_type when calling updateBrandResourcesByContentType'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($brand_id !== null) { + $resourcePath = str_replace( + "{" . "brandId" . "}", + $this->apiClient->getSerializer()->toPathValue($brand_id), + $resourcePath + ); + } + // path params + if ($resource_content_type !== null) { + $resourcePath = str_replace( + "{" . "resourceContentType" . "}", + $this->apiClient->getSerializer()->toPathValue($resource_content_type), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'PUT', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\BrandResources', + '/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\BrandResources', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\BrandResources', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation updateConsumerDisclosure + * + * Update Consumer Disclosure. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. + * @param \DocuSign\eSign\Model\ConsumerDisclosure $consumer_disclosure (optional) + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\ConsumerDisclosure + */ + public function updateConsumerDisclosure($account_id, $lang_code, $consumer_disclosure = null, AccountsApi\UpdateConsumerDisclosureOptions $options = null) + { + list($response) = $this->updateConsumerDisclosureWithHttpInfo($account_id, $lang_code, $consumer_disclosure, $options); return $response; } /** - * Operation updateBrandWithHttpInfo + * Operation updateConsumerDisclosureWithHttpInfo * - * Updates an existing brand. + * Update Consumer Disclosure. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. - * @param \DocuSign\eSign\Model\Brand $brand (optional) + * @param string $lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. + * @param \DocuSign\eSign\Model\ConsumerDisclosure $consumer_disclosure (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\Brand, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings) */ - public function updateBrandWithHttpInfo($account_id, $brand_id, $brand = null) + public function updateConsumerDisclosureWithHttpInfo($account_id, $lang_code, $consumer_disclosure = null, AccountsApi\UpdateConsumerDisclosureOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateBrand'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateConsumerDisclosure'); } - // verify the required parameter 'brand_id' is set - if ($brand_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling updateBrand'); + // verify the required parameter 'lang_code' is set + if ($lang_code === null) { + throw new \InvalidArgumentException('Missing the required parameter $lang_code when calling updateConsumerDisclosure'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}"; + $resourcePath = "/v2/accounts/{accountId}/consumer_disclosure/{langCode}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -4023,6 +5338,14 @@ public function updateBrandWithHttpInfo($account_id, $brand_id, $brand = null) } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getIncludeMetadata() !== null) { + $queryParams['include_metadata'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeMetadata()); + } + } // path params if ($account_id !== null) { @@ -4033,10 +5356,10 @@ public function updateBrandWithHttpInfo($account_id, $brand_id, $brand = null) ); } // path params - if ($brand_id !== null) { + if ($lang_code !== null) { $resourcePath = str_replace( - "{" . "brandId" . "}", - $this->apiClient->getSerializer()->toPathValue($brand_id), + "{" . "langCode" . "}", + $this->apiClient->getSerializer()->toPathValue($lang_code), $resourcePath ); } @@ -4045,8 +5368,8 @@ public function updateBrandWithHttpInfo($account_id, $brand_id, $brand = null) // body params $_tempBody = null; - if (isset($brand)) { - $_tempBody = $brand; + if (isset($consumer_disclosure)) { + $_tempBody = $consumer_disclosure; } // for model (json/xml) @@ -4063,15 +5386,15 @@ public function updateBrandWithHttpInfo($account_id, $brand_id, $brand = null) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\Brand', - '/v2/accounts/{accountId}/brands/{brandId}' + '\DocuSign\eSign\Model\ConsumerDisclosure', + '/v2/accounts/{accountId}/consumer_disclosure/{langCode}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Brand', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ConsumerDisclosure', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Brand', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ConsumerDisclosure', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -4085,49 +5408,47 @@ public function updateBrandWithHttpInfo($account_id, $brand_id, $brand = null) } /** - * Operation updateBrandLogoByType + * Operation updateCustomField * - * Put one branding logo. + * Updates an existing account custom field. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. - * @param string $logo_type One of **Primary**, **Secondary** or **Email**. + * @param string $custom_field_id + * @param \DocuSign\eSign\Model\CustomField $custom_field (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return void + * @return \DocuSign\eSign\Model\CustomFields */ - public function updateBrandLogoByType($account_id, $brand_id, $logo_type) + public function updateCustomField($account_id, $custom_field_id, $custom_field = null, AccountsApi\UpdateCustomFieldOptions $options = null) { - list($response) = $this->updateBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_type); + list($response) = $this->updateCustomFieldWithHttpInfo($account_id, $custom_field_id, $custom_field, $options); return $response; } /** - * Operation updateBrandLogoByTypeWithHttpInfo + * Operation updateCustomFieldWithHttpInfo * - * Put one branding logo. + * Updates an existing account custom field. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. - * @param string $logo_type One of **Primary**, **Secondary** or **Email**. + * @param string $custom_field_id + * @param \DocuSign\eSign\Model\CustomField $custom_field (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\CustomFields, HTTP status code, HTTP response headers (array of strings) */ - public function updateBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_type) + public function updateCustomFieldWithHttpInfo($account_id, $custom_field_id, $custom_field = null, AccountsApi\UpdateCustomFieldOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateBrandLogoByType'); - } - // verify the required parameter 'brand_id' is set - if ($brand_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling updateBrandLogoByType'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateCustomField'); } - // verify the required parameter 'logo_type' is set - if ($logo_type === null) { - throw new \InvalidArgumentException('Missing the required parameter $logo_type when calling updateBrandLogoByType'); + // verify the required parameter 'custom_field_id' is set + if ($custom_field_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $custom_field_id when calling updateCustomField'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}"; + $resourcePath = "/v2/accounts/{accountId}/custom_fields/{customFieldId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -4138,6 +5459,14 @@ public function updateBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_ } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getApplyToTemplates() !== null) { + $queryParams['apply_to_templates'] = $this->apiClient->getSerializer()->toQueryValue($options->getApplyToTemplates()); + } + } // path params if ($account_id !== null) { @@ -4148,25 +5477,22 @@ public function updateBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_ ); } // path params - if ($brand_id !== null) { - $resourcePath = str_replace( - "{" . "brandId" . "}", - $this->apiClient->getSerializer()->toPathValue($brand_id), - $resourcePath - ); - } - // path params - if ($logo_type !== null) { + if ($custom_field_id !== null) { $resourcePath = str_replace( - "{" . "logoType" . "}", - $this->apiClient->getSerializer()->toPathValue($logo_type), + "{" . "customFieldId" . "}", + $this->apiClient->getSerializer()->toPathValue($custom_field_id), $resourcePath ); } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); - + // body params + $_tempBody = null; + if (isset($custom_field)) { + $_tempBody = $custom_field; + } + // for model (json/xml) if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present @@ -4181,13 +5507,17 @@ public function updateBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_ $queryParams, $httpBody, $headerParams, - null, - '/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}' + '\DocuSign\eSign\Model\CustomFields', + '/v2/accounts/{accountId}/custom_fields/{customFieldId}' ); - return [null, $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\CustomFields', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\CustomFields', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; case 400: $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); $e->setResponseObject($data); @@ -4199,49 +5529,39 @@ public function updateBrandLogoByTypeWithHttpInfo($account_id, $brand_id, $logo_ } /** - * Operation updateBrandResourcesByContentType + * Operation updateENoteConfiguration * - * Uploads a branding resource file. + * Updates configuration information for the eNote eOriginal integration. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. - * @param string $resource_content_type + * @param \DocuSign\eSign\Model\ENoteConfiguration $e_note_configuration (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\BrandResources + * @return \DocuSign\eSign\Model\ENoteConfiguration */ - public function updateBrandResourcesByContentType($account_id, $brand_id, $resource_content_type) + public function updateENoteConfiguration($account_id, $e_note_configuration = null) { - list($response) = $this->updateBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_id, $resource_content_type); + list($response) = $this->updateENoteConfigurationWithHttpInfo($account_id, $e_note_configuration); return $response; } /** - * Operation updateBrandResourcesByContentTypeWithHttpInfo + * Operation updateENoteConfigurationWithHttpInfo * - * Uploads a branding resource file. + * Updates configuration information for the eNote eOriginal integration. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $brand_id The unique identifier of a brand. - * @param string $resource_content_type + * @param \DocuSign\eSign\Model\ENoteConfiguration $e_note_configuration (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\BrandResources, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\ENoteConfiguration, HTTP status code, HTTP response headers (array of strings) */ - public function updateBrandResourcesByContentTypeWithHttpInfo($account_id, $brand_id, $resource_content_type) + public function updateENoteConfigurationWithHttpInfo($account_id, $e_note_configuration = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateBrandResourcesByContentType'); - } - // verify the required parameter 'brand_id' is set - if ($brand_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $brand_id when calling updateBrandResourcesByContentType'); - } - // verify the required parameter 'resource_content_type' is set - if ($resource_content_type === null) { - throw new \InvalidArgumentException('Missing the required parameter $resource_content_type when calling updateBrandResourcesByContentType'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateENoteConfiguration'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}"; + $resourcePath = "/v2/accounts/{accountId}/settings/enote_configuration"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -4261,26 +5581,15 @@ public function updateBrandResourcesByContentTypeWithHttpInfo($account_id, $bran $resourcePath ); } - // path params - if ($brand_id !== null) { - $resourcePath = str_replace( - "{" . "brandId" . "}", - $this->apiClient->getSerializer()->toPathValue($brand_id), - $resourcePath - ); - } - // path params - if ($resource_content_type !== null) { - $resourcePath = str_replace( - "{" . "resourceContentType" . "}", - $this->apiClient->getSerializer()->toPathValue($resource_content_type), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); - + // body params + $_tempBody = null; + if (isset($e_note_configuration)) { + $_tempBody = $e_note_configuration; + } + // for model (json/xml) if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present @@ -4295,15 +5604,15 @@ public function updateBrandResourcesByContentTypeWithHttpInfo($account_id, $bran $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\BrandResources', - '/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}' + '\DocuSign\eSign\Model\ENoteConfiguration', + '/v2/accounts/{accountId}/settings/enote_configuration' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\BrandResources', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ENoteConfiguration', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\BrandResources', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ENoteConfiguration', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -4317,39 +5626,39 @@ public function updateBrandResourcesByContentTypeWithHttpInfo($account_id, $bran } /** - * Operation updateENoteConfiguration + * Operation updatePasswordRules * - * Updates configuration information for the eNote eOriginal integration. + * Update the password rules * * @param string $account_id The external account number (int) or account ID Guid. - * @param \DocuSign\eSign\Model\ENoteConfiguration $e_note_configuration (optional) + * @param \DocuSign\eSign\Model\AccountPasswordRules $account_password_rules (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\ENoteConfiguration + * @return \DocuSign\eSign\Model\AccountPasswordRules */ - public function updateENoteConfiguration($account_id, $e_note_configuration = null) + public function updatePasswordRules($account_id, $account_password_rules = null) { - list($response) = $this->updateENoteConfigurationWithHttpInfo($account_id, $e_note_configuration); + list($response) = $this->updatePasswordRulesWithHttpInfo($account_id, $account_password_rules); return $response; } /** - * Operation updateENoteConfigurationWithHttpInfo + * Operation updatePasswordRulesWithHttpInfo * - * Updates configuration information for the eNote eOriginal integration. + * Update the password rules * * @param string $account_id The external account number (int) or account ID Guid. - * @param \DocuSign\eSign\Model\ENoteConfiguration $e_note_configuration (optional) + * @param \DocuSign\eSign\Model\AccountPasswordRules $account_password_rules (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\ENoteConfiguration, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\AccountPasswordRules, HTTP status code, HTTP response headers (array of strings) */ - public function updateENoteConfigurationWithHttpInfo($account_id, $e_note_configuration = null) + public function updatePasswordRulesWithHttpInfo($account_id, $account_password_rules = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateENoteConfiguration'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updatePasswordRules'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/settings/enote_configuration"; + $resourcePath = "/v2/accounts/{accountId}/settings/password_rules"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -4374,8 +5683,8 @@ public function updateENoteConfigurationWithHttpInfo($account_id, $e_note_config // body params $_tempBody = null; - if (isset($e_note_configuration)) { - $_tempBody = $e_note_configuration; + if (isset($account_password_rules)) { + $_tempBody = $account_password_rules; } // for model (json/xml) @@ -4392,15 +5701,15 @@ public function updateENoteConfigurationWithHttpInfo($account_id, $e_note_config $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\ENoteConfiguration', - '/v2/accounts/{accountId}/settings/enote_configuration' + '\DocuSign\eSign\Model\AccountPasswordRules', + '/v2/accounts/{accountId}/settings/password_rules' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ENoteConfiguration', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountPasswordRules', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ENoteConfiguration', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountPasswordRules', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -4737,4 +6046,101 @@ public function updateSharedAccessWithHttpInfo($account_id, $account_shared_acce throw $e; } } + + /** + * Operation updateWatermark + * + * Update watermark information. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param \DocuSign\eSign\Model\Watermark $watermark (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\Watermark + */ + public function updateWatermark($account_id, $watermark = null) + { + list($response) = $this->updateWatermarkWithHttpInfo($account_id, $watermark); + return $response; + } + + /** + * Operation updateWatermarkWithHttpInfo + * + * Update watermark information. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param \DocuSign\eSign\Model\Watermark $watermark (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\Watermark, HTTP status code, HTTP response headers (array of strings) + */ + public function updateWatermarkWithHttpInfo($account_id, $watermark = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateWatermark'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/watermark"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + // body params + $_tempBody = null; + if (isset($watermark)) { + $_tempBody = $watermark; + } + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'PUT', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\Watermark', + '/v2/accounts/{accountId}/watermark' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Watermark', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Watermark', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } } diff --git a/src/Api/AuthenticationApi.php b/src/Api/AuthenticationApi.php index f90d6cdf..f4f02a61 100644 --- a/src/Api/AuthenticationApi.php +++ b/src/Api/AuthenticationApi.php @@ -135,7 +135,7 @@ public function setLoginSettings($login_settings) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -153,16 +153,16 @@ class AuthenticationApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -174,7 +174,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -184,11 +184,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return AuthenticationApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; diff --git a/src/Api/BillingApi.php b/src/Api/BillingApi.php index 857cbe74..ce7ca328 100644 --- a/src/Api/BillingApi.php +++ b/src/Api/BillingApi.php @@ -244,7 +244,7 @@ public function setPreviewBillingPlan($preview_billing_plan) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -262,16 +262,16 @@ class BillingApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -283,7 +283,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -293,11 +293,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return BillingApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; @@ -393,6 +393,96 @@ public function getBillingPlanWithHttpInfo($billing_plan_id) } } + /** + * Operation getCreditCardInfo + * + * Get metadata for a given credit card. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\CreditCardInformation + */ + public function getCreditCardInfo($account_id) + { + list($response) = $this->getCreditCardInfoWithHttpInfo($account_id); + return $response; + } + + /** + * Operation getCreditCardInfoWithHttpInfo + * + * Get metadata for a given credit card. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\CreditCardInformation, HTTP status code, HTTP response headers (array of strings) + */ + public function getCreditCardInfoWithHttpInfo($account_id) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getCreditCardInfo'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/billing_plan/credit_card"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\CreditCardInformation', + '/v2/accounts/{accountId}/billing_plan/credit_card' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\CreditCardInformation', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\CreditCardInformation', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + /** * Operation getInvoice * diff --git a/src/Api/BulkEnvelopesApi.php b/src/Api/BulkEnvelopesApi.php index c837255c..74ce24f8 100644 --- a/src/Api/BulkEnvelopesApi.php +++ b/src/Api/BulkEnvelopesApi.php @@ -134,7 +134,7 @@ public function setCount($count) return $this; } /** - * $include Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=”failed,queued”) Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent – This only returns entries with a sent status. + * $include Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=”failed,queued”) Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent – This only returns entries with a sent status. * @var string */ protected $include; @@ -150,7 +150,7 @@ public function getInclude() /** * Sets include - * @param string $include Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=”failed,queued”) Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent – This only returns entries with a sent status. + * @param string $include Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=”failed,queued”) Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent – This only returns entries with a sent status. * @return $this */ public function setInclude($include) @@ -241,7 +241,7 @@ public function setStartPosition($start_position) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -259,16 +259,16 @@ class BulkEnvelopesApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -280,7 +280,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -290,11 +290,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return BulkEnvelopesApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; @@ -834,7 +834,7 @@ public function updateRecipientsWithHttpInfo($account_id, $envelope_id, $recipie if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['text/csv']); // path params diff --git a/src/Api/CloudStorageApi.php b/src/Api/CloudStorageApi.php index 84c4e6db..a95a8c7a 100644 --- a/src/Api/CloudStorageApi.php +++ b/src/Api/CloudStorageApi.php @@ -394,7 +394,7 @@ public function setRedirectUrl($redirect_url) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -412,16 +412,16 @@ class CloudStorageApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -433,7 +433,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -443,11 +443,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return CloudStorageApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; diff --git a/src/Api/CommentsApi.php b/src/Api/CommentsApi.php new file mode 100644 index 00000000..67086bde --- /dev/null +++ b/src/Api/CommentsApi.php @@ -0,0 +1,235 @@ +encoding; + } + + /** + * Sets encoding + * @param string $encoding + * @return $this + */ + public function setEncoding($encoding) + { + $this->encoding = $encoding; + return $this; + } +} + + +namespace DocuSign\eSign\Api; + +use \DocuSign\eSign\Client\ApiClient; +use \DocuSign\eSign\ApiException; +use \DocuSign\eSign\Configuration; +use \DocuSign\eSign\ObjectSerializer; + +/** + * CommentsApi Class Doc Comment + * + * @category Class + * @package DocuSign\eSign + * @author Swagger Codegen team + * @link https://github.com/swagger-api/swagger-codegen + */ +class CommentsApi +{ + /** + * API Client + * + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient + */ + protected $apiClient; + + /** + * Constructor + * + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use + */ + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) + { + if ($apiClient === null) { + $apiClient = new ApiClient(); + } + + $this->apiClient = $apiClient; + } + + /** + * Get API client + * + * @return \DocuSign\eSign\Client\ApiClient get the API client + */ + public function getApiClient() + { + return $this->apiClient; + } + + /** + * Set the API client + * + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client + * + * @return CommentsApi + */ + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) + { + $this->apiClient = $apiClient; + return $this; + } + + /** + * Operation getCommentsTranscript + * + * Gets comment transcript for envelope and user + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \SplFileObject + */ + public function getCommentsTranscript($account_id, $envelope_id, CommentsApi\GetCommentsTranscriptOptions $options = null) + { + list($response) = $this->getCommentsTranscriptWithHttpInfo($account_id, $envelope_id, $options); + return $response; + } + + /** + * Operation getCommentsTranscriptWithHttpInfo + * + * Gets comment transcript for envelope and user + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) + */ + public function getCommentsTranscriptWithHttpInfo($account_id, $envelope_id, CommentsApi\GetCommentsTranscriptOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getCommentsTranscript'); + } + // verify the required parameter 'envelope_id' is set + if ($envelope_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getCommentsTranscript'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/pdf']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getEncoding() !== null) { + $queryParams['encoding'] = $this->apiClient->getSerializer()->toQueryValue($options->getEncoding()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($envelope_id !== null) { + $resourcePath = str_replace( + "{" . "envelopeId" . "}", + $this->apiClient->getSerializer()->toPathValue($envelope_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\SplFileObject', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\SplFileObject', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } +} diff --git a/src/Api/ConnectApi.php b/src/Api/ConnectApi.php index 5dc73ed4..8e2c5858 100644 --- a/src/Api/ConnectApi.php +++ b/src/Api/ConnectApi.php @@ -319,7 +319,7 @@ public function setUserNameSubstring($user_name_substring) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -337,16 +337,16 @@ class ConnectApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -358,7 +358,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -368,11 +368,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return ConnectApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; @@ -861,103 +861,6 @@ public function deleteEventLogsWithHttpInfo($account_id) } } - /** - * Operation deleteMobileNotifiers - * - * Reserved - * - * @param string $account_id The external account number (int) or account ID Guid. - * @param \DocuSign\eSign\Model\MobileNotifierConfigurationInformation $mobile_notifier_configuration_information (optional) - * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\MobileNotifierConfigurationInformation - */ - public function deleteMobileNotifiers($account_id, $mobile_notifier_configuration_information = null) - { - list($response) = $this->deleteMobileNotifiersWithHttpInfo($account_id, $mobile_notifier_configuration_information); - return $response; - } - - /** - * Operation deleteMobileNotifiersWithHttpInfo - * - * Reserved - * - * @param string $account_id The external account number (int) or account ID Guid. - * @param \DocuSign\eSign\Model\MobileNotifierConfigurationInformation $mobile_notifier_configuration_information (optional) - * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\MobileNotifierConfigurationInformation, HTTP status code, HTTP response headers (array of strings) - */ - public function deleteMobileNotifiersWithHttpInfo($account_id, $mobile_notifier_configuration_information = null) - { - // verify the required parameter 'account_id' is set - if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling deleteMobileNotifiers'); - } - // parse inputs - $resourcePath = "/v2/accounts/{accountId}/connect/mobile_notifiers"; - $httpBody = ''; - $queryParams = []; - $headerParams = []; - $formParams = []; - $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - - - // path params - if ($account_id !== null) { - $resourcePath = str_replace( - "{" . "accountId" . "}", - $this->apiClient->getSerializer()->toPathValue($account_id), - $resourcePath - ); - } - // default format to json - $resourcePath = str_replace("{format}", "json", $resourcePath); - - // body params - $_tempBody = null; - if (isset($mobile_notifier_configuration_information)) { - $_tempBody = $mobile_notifier_configuration_information; - } - - // 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) - } - // make the API Call - try { - list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( - $resourcePath, - 'DELETE', - $queryParams, - $httpBody, - $headerParams, - '\DocuSign\eSign\Model\MobileNotifierConfigurationInformation', - '/v2/accounts/{accountId}/connect/mobile_notifiers' - ); - - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\MobileNotifierConfigurationInformation', $httpHeader), $statusCode, $httpHeader]; - } catch (ApiException $e) { - switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\MobileNotifierConfigurationInformation', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; - case 400: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; - } - - throw $e; - } - } - /** * Operation getConfiguration * @@ -1474,96 +1377,6 @@ public function listEventLogsWithHttpInfo($account_id, ConnectApi\ListEventLogsO } } - /** - * Operation listMobileNotifiers - * - * Reserved - * - * @param string $account_id The external account number (int) or account ID Guid. - * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\MobileNotifierConfigurationInformation - */ - public function listMobileNotifiers($account_id) - { - list($response) = $this->listMobileNotifiersWithHttpInfo($account_id); - return $response; - } - - /** - * Operation listMobileNotifiersWithHttpInfo - * - * Reserved - * - * @param string $account_id The external account number (int) or account ID Guid. - * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\MobileNotifierConfigurationInformation, HTTP status code, HTTP response headers (array of strings) - */ - public function listMobileNotifiersWithHttpInfo($account_id) - { - // verify the required parameter 'account_id' is set - if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling listMobileNotifiers'); - } - // parse inputs - $resourcePath = "/v2/accounts/{accountId}/connect/mobile_notifiers"; - $httpBody = ''; - $queryParams = []; - $headerParams = []; - $formParams = []; - $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - - - // path params - if ($account_id !== null) { - $resourcePath = str_replace( - "{" . "accountId" . "}", - $this->apiClient->getSerializer()->toPathValue($account_id), - $resourcePath - ); - } - // default format to json - $resourcePath = str_replace("{format}", "json", $resourcePath); - - - // 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) - } - // make the API Call - try { - list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( - $resourcePath, - 'GET', - $queryParams, - $httpBody, - $headerParams, - '\DocuSign\eSign\Model\MobileNotifierConfigurationInformation', - '/v2/accounts/{accountId}/connect/mobile_notifiers' - ); - - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\MobileNotifierConfigurationInformation', $httpHeader), $statusCode, $httpHeader]; - } catch (ApiException $e) { - switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\MobileNotifierConfigurationInformation', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; - case 400: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; - } - - throw $e; - } - } - /** * Operation listUsers * @@ -1995,101 +1808,4 @@ public function updateConfigurationWithHttpInfo($account_id, $connect_custom_con throw $e; } } - - /** - * Operation updateMobileNotifiers - * - * Reserved - * - * @param string $account_id The external account number (int) or account ID Guid. - * @param \DocuSign\eSign\Model\MobileNotifierConfigurationInformation $mobile_notifier_configuration_information (optional) - * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\MobileNotifierConfigurationInformation - */ - public function updateMobileNotifiers($account_id, $mobile_notifier_configuration_information = null) - { - list($response) = $this->updateMobileNotifiersWithHttpInfo($account_id, $mobile_notifier_configuration_information); - return $response; - } - - /** - * Operation updateMobileNotifiersWithHttpInfo - * - * Reserved - * - * @param string $account_id The external account number (int) or account ID Guid. - * @param \DocuSign\eSign\Model\MobileNotifierConfigurationInformation $mobile_notifier_configuration_information (optional) - * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\MobileNotifierConfigurationInformation, HTTP status code, HTTP response headers (array of strings) - */ - public function updateMobileNotifiersWithHttpInfo($account_id, $mobile_notifier_configuration_information = null) - { - // verify the required parameter 'account_id' is set - if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateMobileNotifiers'); - } - // parse inputs - $resourcePath = "/v2/accounts/{accountId}/connect/mobile_notifiers"; - $httpBody = ''; - $queryParams = []; - $headerParams = []; - $formParams = []; - $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - - - // path params - if ($account_id !== null) { - $resourcePath = str_replace( - "{" . "accountId" . "}", - $this->apiClient->getSerializer()->toPathValue($account_id), - $resourcePath - ); - } - // default format to json - $resourcePath = str_replace("{format}", "json", $resourcePath); - - // body params - $_tempBody = null; - if (isset($mobile_notifier_configuration_information)) { - $_tempBody = $mobile_notifier_configuration_information; - } - - // 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) - } - // make the API Call - try { - list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( - $resourcePath, - 'PUT', - $queryParams, - $httpBody, - $headerParams, - '\DocuSign\eSign\Model\MobileNotifierConfigurationInformation', - '/v2/accounts/{accountId}/connect/mobile_notifiers' - ); - - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\MobileNotifierConfigurationInformation', $httpHeader), $statusCode, $httpHeader]; - } catch (ApiException $e) { - switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\MobileNotifierConfigurationInformation', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; - case 400: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; - } - - throw $e; - } - } } diff --git a/src/Api/CustomTabsApi.php b/src/Api/CustomTabsApi.php index 0fea17c6..8b1ae640 100644 --- a/src/Api/CustomTabsApi.php +++ b/src/Api/CustomTabsApi.php @@ -60,7 +60,7 @@ public function setCustomTabOnly($custom_tab_only) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -78,16 +78,16 @@ class CustomTabsApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -99,7 +99,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -109,11 +109,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return CustomTabsApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; diff --git a/src/Api/DiagnosticsApi.php b/src/Api/DiagnosticsApi.php index 3175337b..eaff5560 100644 --- a/src/Api/DiagnosticsApi.php +++ b/src/Api/DiagnosticsApi.php @@ -60,7 +60,7 @@ public function setEncoding($encoding) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -78,16 +78,16 @@ class DiagnosticsApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -99,7 +99,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -109,11 +109,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return DiagnosticsApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; diff --git a/src/Api/EnvelopesApi.php b/src/Api/EnvelopesApi.php index 3cfcd0fd..fd4c4469 100644 --- a/src/Api/EnvelopesApi.php +++ b/src/Api/EnvelopesApi.php @@ -55,6 +55,31 @@ public function setCdseMode($cdse_mode) $this->cdse_mode = $cdse_mode; return $this; } + /** + * $change_routing_order + * @var string + */ + protected $change_routing_order; + + /** + * Gets change_routing_order + * @return string + */ + public function getChangeRoutingOrder() + { + return $this->change_routing_order; + } + + /** + * Sets change_routing_order + * @param string $change_routing_order + * @return $this + */ + public function setChangeRoutingOrder($change_routing_order) + { + $this->change_routing_order = $change_routing_order; + return $this; + } /** * $completed_documents_only If set to true then we want to set the sourceEnvelopeId to indicate that this is a\"forward\" envelope action * @var string @@ -109,7 +134,7 @@ public function setMergeRolesOnDraft($merge_roles_on_draft) class CreateRecipientOptions { /** - * $resend_envelope When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope’s next recipient. + * $resend_envelope When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. * @var string */ protected $resend_envelope; @@ -125,7 +150,7 @@ public function getResendEnvelope() /** * Sets resend_envelope - * @param string $resend_envelope When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope’s next recipient. + * @param string $resend_envelope When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. * @return $this */ public function setResendEnvelope($resend_envelope) @@ -499,6 +524,34 @@ public function setShowChanges($show_changes) return $this; } } +class GetDocumentTabsOptions +{ + /** + * $page_numbers + * @var string + */ + protected $page_numbers; + + /** + * Gets page_numbers + * @return string + */ + public function getPageNumbers() + { + return $this->page_numbers; + } + + /** + * Sets page_numbers + * @param string $page_numbers + * @return $this + */ + public function setPageNumbers($page_numbers) + { + $this->page_numbers = $page_numbers; + return $this; + } +} class GetEnvelopeOptions { /** @@ -552,324 +605,346 @@ public function setInclude($include) return $this; } } -class GetRecipientInitialsImageOptions +class GetPagesOptions { /** - * $include_chrome The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. + * $count * @var string */ - protected $include_chrome; + protected $count; /** - * Gets include_chrome + * Gets count * @return string */ - public function getIncludeChrome() + public function getCount() { - return $this->include_chrome; + return $this->count; } /** - * Sets include_chrome - * @param string $include_chrome The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. + * Sets count + * @param string $count * @return $this */ - public function setIncludeChrome($include_chrome) + public function setCount($count) { - $this->include_chrome = $include_chrome; + $this->count = $count; return $this; } -} -class GetRecipientSignatureImageOptions -{ /** - * $include_chrome When set to **true**, indicates the chromed version of the signature image should be retrieved. + * $dpi * @var string */ - protected $include_chrome; + protected $dpi; /** - * Gets include_chrome + * Gets dpi * @return string */ - public function getIncludeChrome() + public function getDpi() { - return $this->include_chrome; + return $this->dpi; } /** - * Sets include_chrome - * @param string $include_chrome When set to **true**, indicates the chromed version of the signature image should be retrieved. + * Sets dpi + * @param string $dpi * @return $this */ - public function setIncludeChrome($include_chrome) + public function setDpi($dpi) { - $this->include_chrome = $include_chrome; + $this->dpi = $dpi; return $this; } -} -class ListDocumentsOptions -{ /** - * $include_metadata + * $max_height * @var string */ - protected $include_metadata; + protected $max_height; /** - * Gets include_metadata + * Gets max_height * @return string */ - public function getIncludeMetadata() + public function getMaxHeight() { - return $this->include_metadata; + return $this->max_height; } /** - * Sets include_metadata - * @param string $include_metadata + * Sets max_height + * @param string $max_height * @return $this */ - public function setIncludeMetadata($include_metadata) + public function setMaxHeight($max_height) { - $this->include_metadata = $include_metadata; + $this->max_height = $max_height; return $this; } -} -class ListRecipientsOptions -{ /** - * $include_anchor_tab_locations When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. + * $max_width * @var string */ - protected $include_anchor_tab_locations; + protected $max_width; /** - * Gets include_anchor_tab_locations + * Gets max_width * @return string */ - public function getIncludeAnchorTabLocations() + public function getMaxWidth() { - return $this->include_anchor_tab_locations; + return $this->max_width; } /** - * Sets include_anchor_tab_locations - * @param string $include_anchor_tab_locations When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. + * Sets max_width + * @param string $max_width * @return $this */ - public function setIncludeAnchorTabLocations($include_anchor_tab_locations) + public function setMaxWidth($max_width) { - $this->include_anchor_tab_locations = $include_anchor_tab_locations; + $this->max_width = $max_width; return $this; } /** - * $include_extended When set to **true**, the extended properties are included in the response. + * $nocache * @var string */ - protected $include_extended; + protected $nocache; /** - * Gets include_extended + * Gets nocache * @return string */ - public function getIncludeExtended() + public function getNocache() { - return $this->include_extended; + return $this->nocache; } /** - * Sets include_extended - * @param string $include_extended When set to **true**, the extended properties are included in the response. + * Sets nocache + * @param string $nocache * @return $this */ - public function setIncludeExtended($include_extended) + public function setNocache($nocache) { - $this->include_extended = $include_extended; + $this->nocache = $nocache; return $this; } /** - * $include_metadata + * $show_changes * @var string */ - protected $include_metadata; + protected $show_changes; /** - * Gets include_metadata + * Gets show_changes * @return string */ - public function getIncludeMetadata() + public function getShowChanges() { - return $this->include_metadata; + return $this->show_changes; } /** - * Sets include_metadata - * @param string $include_metadata + * Sets show_changes + * @param string $show_changes * @return $this */ - public function setIncludeMetadata($include_metadata) + public function setShowChanges($show_changes) { - $this->include_metadata = $include_metadata; + $this->show_changes = $show_changes; return $this; } /** - * $include_tabs When set to **true**, the tab information associated with the recipient is included in the response. + * $start_position * @var string */ - protected $include_tabs; + protected $start_position; /** - * Gets include_tabs + * Gets start_position * @return string */ - public function getIncludeTabs() + public function getStartPosition() { - return $this->include_tabs; + return $this->start_position; } /** - * Sets include_tabs - * @param string $include_tabs When set to **true**, the tab information associated with the recipient is included in the response. + * Sets start_position + * @param string $start_position * @return $this */ - public function setIncludeTabs($include_tabs) + public function setStartPosition($start_position) { - $this->include_tabs = $include_tabs; + $this->start_position = $start_position; return $this; } } -class ListStatusOptions +class GetRecipientInitialsImageOptions { /** - * $email + * $include_chrome The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. * @var string */ - protected $email; + protected $include_chrome; /** - * Gets email + * Gets include_chrome * @return string */ - public function getEmail() + public function getIncludeChrome() { - return $this->email; + return $this->include_chrome; } /** - * Sets email - * @param string $email + * Sets include_chrome + * @param string $include_chrome The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. * @return $this */ - public function setEmail($email) + public function setIncludeChrome($include_chrome) { - $this->email = $email; + $this->include_chrome = $include_chrome; return $this; } +} +class GetRecipientSignatureImageOptions +{ /** - * $from_date + * $include_chrome When set to **true**, indicates the chromed version of the signature image should be retrieved. * @var string */ - protected $from_date; + protected $include_chrome; /** - * Gets from_date + * Gets include_chrome * @return string */ - public function getFromDate() + public function getIncludeChrome() { - return $this->from_date; + return $this->include_chrome; } /** - * Sets from_date - * @param string $from_date + * Sets include_chrome + * @param string $include_chrome When set to **true**, indicates the chromed version of the signature image should be retrieved. * @return $this */ - public function setFromDate($from_date) + public function setIncludeChrome($include_chrome) { - $this->from_date = $from_date; + $this->include_chrome = $include_chrome; return $this; } +} +class ListRecipientsOptions +{ /** - * $start_position + * $include_anchor_tab_locations When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. * @var string */ - protected $start_position; + protected $include_anchor_tab_locations; /** - * Gets start_position + * Gets include_anchor_tab_locations * @return string */ - public function getStartPosition() + public function getIncludeAnchorTabLocations() { - return $this->start_position; + return $this->include_anchor_tab_locations; } /** - * Sets start_position - * @param string $start_position + * Sets include_anchor_tab_locations + * @param string $include_anchor_tab_locations When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. * @return $this */ - public function setStartPosition($start_position) + public function setIncludeAnchorTabLocations($include_anchor_tab_locations) { - $this->start_position = $start_position; + $this->include_anchor_tab_locations = $include_anchor_tab_locations; return $this; } /** - * $to_date + * $include_extended When set to **true**, the extended properties are included in the response. * @var string */ - protected $to_date; + protected $include_extended; /** - * Gets to_date + * Gets include_extended * @return string */ - public function getToDate() + public function getIncludeExtended() { - return $this->to_date; + return $this->include_extended; } /** - * Sets to_date - * @param string $to_date + * Sets include_extended + * @param string $include_extended When set to **true**, the extended properties are included in the response. * @return $this */ - public function setToDate($to_date) + public function setIncludeExtended($include_extended) { - $this->to_date = $to_date; + $this->include_extended = $include_extended; return $this; } -} -class ListStatusChangesOptions -{ /** - * $ac_status Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. + * $include_tabs When set to **true**, the tab information associated with the recipient is included in the response. * @var string */ - protected $ac_status; + protected $include_tabs; /** - * Gets ac_status + * Gets include_tabs * @return string */ - public function getAcStatus() + public function getIncludeTabs() { - return $this->ac_status; + return $this->include_tabs; } /** - * Sets ac_status - * @param string $ac_status Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. + * Sets include_tabs + * @param string $include_tabs When set to **true**, the tab information associated with the recipient is included in the response. * @return $this */ - public function setAcStatus($ac_status) + public function setIncludeTabs($include_tabs) { - $this->ac_status = $ac_status; + $this->include_tabs = $include_tabs; return $this; } - /** +} +class ListStatusOptions +{ + /** + * $ac_status + * @var string + */ + protected $ac_status; + + /** + * Gets ac_status + * @return string + */ + public function getAcStatus() + { + return $this->ac_status; + } + + /** + * Sets ac_status + * @param string $ac_status + * @return $this + */ + public function setAcStatus($ac_status) + { + $this->ac_status = $ac_status; + return $this; + } + /** * $block * @var string */ @@ -919,31 +994,6 @@ public function setCount($count) $this->count = $count; return $this; } - /** - * $custom_field This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\" - * @var string - */ - protected $custom_field; - - /** - * Gets custom_field - * @return string - */ - public function getCustomField() - { - return $this->custom_field; - } - - /** - * Sets custom_field - * @param string $custom_field This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\" - * @return $this - */ - public function setCustomField($custom_field) - { - $this->custom_field = $custom_field; - return $this; - } /** * $email * @var string @@ -995,428 +1045,481 @@ public function setEnvelopeIds($envelope_ids) return $this; } /** - * $exclude + * $from_date * @var string */ - protected $exclude; + protected $from_date; /** - * Gets exclude + * Gets from_date * @return string */ - public function getExclude() + public function getFromDate() { - return $this->exclude; + return $this->from_date; } /** - * Sets exclude - * @param string $exclude + * Sets from_date + * @param string $from_date * @return $this */ - public function setExclude($exclude) + public function setFromDate($from_date) { - $this->exclude = $exclude; + $this->from_date = $from_date; return $this; } /** - * $folder_ids + * $from_to_status * @var string */ - protected $folder_ids; + protected $from_to_status; /** - * Gets folder_ids + * Gets from_to_status * @return string */ - public function getFolderIds() + public function getFromToStatus() { - return $this->folder_ids; + return $this->from_to_status; } /** - * Sets folder_ids - * @param string $folder_ids + * Sets from_to_status + * @param string $from_to_status * @return $this */ - public function setFolderIds($folder_ids) + public function setFromToStatus($from_to_status) { - $this->folder_ids = $folder_ids; + $this->from_to_status = $from_to_status; return $this; } /** - * $folder_types + * $start_position * @var string */ - protected $folder_types; + protected $start_position; /** - * Gets folder_types + * Gets start_position * @return string */ - public function getFolderTypes() + public function getStartPosition() { - return $this->folder_types; + return $this->start_position; } /** - * Sets folder_types - * @param string $folder_types + * Sets start_position + * @param string $start_position * @return $this */ - public function setFolderTypes($folder_types) + public function setStartPosition($start_position) { - $this->folder_types = $folder_types; + $this->start_position = $start_position; return $this; } /** - * $from_date The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used. + * $status * @var string */ - protected $from_date; + protected $status; /** - * Gets from_date + * Gets status * @return string */ - public function getFromDate() + public function getStatus() { - return $this->from_date; + return $this->status; } /** - * Sets from_date - * @param string $from_date The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used. + * Sets status + * @param string $status * @return $this */ - public function setFromDate($from_date) + public function setStatus($status) { - $this->from_date = $from_date; + $this->status = $status; return $this; } /** - * $from_to_status This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. + * $to_date * @var string */ - protected $from_to_status; + protected $to_date; /** - * Gets from_to_status + * Gets to_date * @return string */ - public function getFromToStatus() + public function getToDate() { - return $this->from_to_status; + return $this->to_date; } /** - * Sets from_to_status - * @param string $from_to_status This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. + * Sets to_date + * @param string $to_date * @return $this */ - public function setFromToStatus($from_to_status) + public function setToDate($to_date) { - $this->from_to_status = $from_to_status; + $this->to_date = $to_date; return $this; } /** - * $include + * $transaction_ids * @var string */ - protected $include; + protected $transaction_ids; /** - * Gets include + * Gets transaction_ids * @return string */ - public function getInclude() + public function getTransactionIds() { - return $this->include; + return $this->transaction_ids; } /** - * Sets include - * @param string $include + * Sets transaction_ids + * @param string $transaction_ids * @return $this */ - public function setInclude($include) + public function setTransactionIds($transaction_ids) { - $this->include = $include; + $this->transaction_ids = $transaction_ids; return $this; } /** - * $intersecting_folder_ids + * $user_name * @var string */ - protected $intersecting_folder_ids; + protected $user_name; /** - * Gets intersecting_folder_ids + * Gets user_name * @return string */ - public function getIntersectingFolderIds() + public function getUserName() { - return $this->intersecting_folder_ids; + return $this->user_name; } /** - * Sets intersecting_folder_ids - * @param string $intersecting_folder_ids + * Sets user_name + * @param string $user_name * @return $this */ - public function setIntersectingFolderIds($intersecting_folder_ids) + public function setUserName($user_name) { - $this->intersecting_folder_ids = $intersecting_folder_ids; + $this->user_name = $user_name; return $this; } +} +class ListStatusChangesOptions +{ /** - * $order + * $ac_status Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. * @var string */ - protected $order; + protected $ac_status; /** - * Gets order + * Gets ac_status * @return string */ - public function getOrder() + public function getAcStatus() { - return $this->order; + return $this->ac_status; } /** - * Sets order - * @param string $order + * Sets ac_status + * @param string $ac_status Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. * @return $this */ - public function setOrder($order) + public function setAcStatus($ac_status) { - $this->order = $order; + $this->ac_status = $ac_status; return $this; } /** - * $order_by + * $block * @var string */ - protected $order_by; + protected $block; /** - * Gets order_by + * Gets block * @return string */ - public function getOrderBy() + public function getBlock() { - return $this->order_by; + return $this->block; } /** - * Sets order_by - * @param string $order_by + * Sets block + * @param string $block * @return $this */ - public function setOrderBy($order_by) + public function setBlock($block) { - $this->order_by = $order_by; + $this->block = $block; return $this; } /** - * $powerformids + * $count * @var string */ - protected $powerformids; + protected $count; /** - * Gets powerformids + * Gets count * @return string */ - public function getPowerformids() + public function getCount() { - return $this->powerformids; + return $this->count; } /** - * Sets powerformids - * @param string $powerformids + * Sets count + * @param string $count * @return $this */ - public function setPowerformids($powerformids) + public function setCount($count) { - $this->powerformids = $powerformids; + $this->count = $count; return $this; } /** - * $search_text + * $custom_field This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\" * @var string */ - protected $search_text; + protected $custom_field; /** - * Gets search_text + * Gets custom_field * @return string */ - public function getSearchText() + public function getCustomField() { - return $this->search_text; + return $this->custom_field; } /** - * Sets search_text - * @param string $search_text + * Sets custom_field + * @param string $custom_field This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\" * @return $this */ - public function setSearchText($search_text) + public function setCustomField($custom_field) { - $this->search_text = $search_text; + $this->custom_field = $custom_field; return $this; } /** - * $start_position + * $email * @var string */ - protected $start_position; + protected $email; /** - * Gets start_position + * Gets email * @return string */ - public function getStartPosition() + public function getEmail() { - return $this->start_position; + return $this->email; } /** - * Sets start_position - * @param string $start_position + * Sets email + * @param string $email * @return $this */ - public function setStartPosition($start_position) + public function setEmail($email) { - $this->start_position = $start_position; + $this->email = $email; return $this; } /** - * $status The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. + * $envelope_ids * @var string */ - protected $status; + protected $envelope_ids; /** - * Gets status + * Gets envelope_ids * @return string */ - public function getStatus() + public function getEnvelopeIds() { - return $this->status; + return $this->envelope_ids; } /** - * Sets status - * @param string $status The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. + * Sets envelope_ids + * @param string $envelope_ids * @return $this */ - public function setStatus($status) + public function setEnvelopeIds($envelope_ids) { - $this->status = $status; + $this->envelope_ids = $envelope_ids; return $this; } /** - * $to_date Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`. + * $from_date The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used. * @var string */ - protected $to_date; + protected $from_date; /** - * Gets to_date + * Gets from_date * @return string */ - public function getToDate() + public function getFromDate() { - return $this->to_date; + return $this->from_date; } /** - * Sets to_date - * @param string $to_date Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`. + * Sets from_date + * @param string $from_date The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used. * @return $this */ - public function setToDate($to_date) + public function setFromDate($from_date) { - $this->to_date = $to_date; + $this->from_date = $from_date; return $this; } /** - * $transaction_ids If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days. + * $from_to_status This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. * @var string */ - protected $transaction_ids; + protected $from_to_status; /** - * Gets transaction_ids + * Gets from_to_status * @return string */ - public function getTransactionIds() + public function getFromToStatus() { - return $this->transaction_ids; + return $this->from_to_status; } /** - * Sets transaction_ids - * @param string $transaction_ids If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days. + * Sets from_to_status + * @param string $from_to_status This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. * @return $this */ - public function setTransactionIds($transaction_ids) + public function setFromToStatus($from_to_status) { - $this->transaction_ids = $transaction_ids; + $this->from_to_status = $from_to_status; return $this; } /** - * $user_filter + * $start_position * @var string */ - protected $user_filter; + protected $start_position; /** - * Gets user_filter + * Gets start_position * @return string */ - public function getUserFilter() + public function getStartPosition() { - return $this->user_filter; + return $this->start_position; } /** - * Sets user_filter - * @param string $user_filter + * Sets start_position + * @param string $start_position * @return $this */ - public function setUserFilter($user_filter) + public function setStartPosition($start_position) { - $this->user_filter = $user_filter; + $this->start_position = $start_position; return $this; } /** - * $user_id + * $status The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. + * @var string + */ + protected $status; + + /** + * Gets status + * @return string + */ + public function getStatus() + { + return $this->status; + } + + /** + * Sets status + * @param string $status The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. + * @return $this + */ + public function setStatus($status) + { + $this->status = $status; + return $this; + } + /** + * $to_date Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`. + * @var string + */ + protected $to_date; + + /** + * Gets to_date + * @return string + */ + public function getToDate() + { + return $this->to_date; + } + + /** + * Sets to_date + * @param string $to_date Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`. + * @return $this + */ + public function setToDate($to_date) + { + $this->to_date = $to_date; + return $this; + } + /** + * $transaction_ids If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days. * @var string */ - protected $user_id; + protected $transaction_ids; /** - * Gets user_id + * Gets transaction_ids * @return string */ - public function getUserId() + public function getTransactionIds() { - return $this->user_id; + return $this->transaction_ids; } /** - * Sets user_id - * @param string $user_id + * Sets transaction_ids + * @param string $transaction_ids If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days. * @return $this */ - public function setUserId($user_id) + public function setTransactionIds($transaction_ids) { - $this->user_id = $user_id; + $this->transaction_ids = $transaction_ids; return $this; } /** @@ -1501,7 +1604,7 @@ public function setIncludeMetadata($include_metadata) class ListTemplatesOptions { /** - * $include The possible values are: matching_applied – This returns template matching information for the template. + * $include The possible values are: matching_applied - This returns template matching information for the template. * @var string */ protected $include; @@ -1517,7 +1620,7 @@ public function getInclude() /** * Sets include - * @param string $include The possible values are: matching_applied – This returns template matching information for the template. + * @param string $include The possible values are: matching_applied - This returns template matching information for the template. * @return $this */ public function setInclude($include) @@ -1690,11 +1793,61 @@ public function setApplyDocumentFields($apply_document_fields) $this->apply_document_fields = $apply_document_fields; return $this; } + /** + * $persist_tabs + * @var string + */ + protected $persist_tabs; + + /** + * Gets persist_tabs + * @return string + */ + public function getPersistTabs() + { + return $this->persist_tabs; + } + + /** + * Sets persist_tabs + * @param string $persist_tabs + * @return $this + */ + public function setPersistTabs($persist_tabs) + { + $this->persist_tabs = $persist_tabs; + return $this; + } } class UpdateRecipientsOptions { /** - * $resend_envelope When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope’s next recipient. + * $offline_signing + * @var string + */ + protected $offline_signing; + + /** + * Gets offline_signing + * @return string + */ + public function getOfflineSigning() + { + return $this->offline_signing; + } + + /** + * Sets offline_signing + * @param string $offline_signing + * @return $this + */ + public function setOfflineSigning($offline_signing) + { + $this->offline_signing = $offline_signing; + return $this; + } + /** + * $resend_envelope When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. * @var string */ protected $resend_envelope; @@ -1710,7 +1863,7 @@ public function getResendEnvelope() /** * Sets resend_envelope - * @param string $resend_envelope When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope’s next recipient. + * @param string $resend_envelope When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. * @return $this */ public function setResendEnvelope($resend_envelope) @@ -1723,7 +1876,7 @@ public function setResendEnvelope($resend_envelope) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -1741,16 +1894,16 @@ class EnvelopesApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -1762,7 +1915,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -1772,11 +1925,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return EnvelopesApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; @@ -2559,6 +2712,131 @@ public function createDocumentFieldsWithHttpInfo($account_id, $document_id, $env } } + /** + * Operation createDocumentResponsiveHtmlPreview + * + * Get Responsive HTML Preview for a document in an envelope. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $document_html_definition (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\DocumentHtmlDefinitions + */ + public function createDocumentResponsiveHtmlPreview($account_id, $document_id, $envelope_id, $document_html_definition = null) + { + list($response) = $this->createDocumentResponsiveHtmlPreviewWithHttpInfo($account_id, $document_id, $envelope_id, $document_html_definition); + return $response; + } + + /** + * Operation createDocumentResponsiveHtmlPreviewWithHttpInfo + * + * Get Responsive HTML Preview for a document in an envelope. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $document_html_definition (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\DocumentHtmlDefinitions, HTTP status code, HTTP response headers (array of strings) + */ + public function createDocumentResponsiveHtmlPreviewWithHttpInfo($account_id, $document_id, $envelope_id, $document_html_definition = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createDocumentResponsiveHtmlPreview'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling createDocumentResponsiveHtmlPreview'); + } + // verify the required parameter 'envelope_id' is set + if ($envelope_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createDocumentResponsiveHtmlPreview'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params + if ($envelope_id !== null) { + $resourcePath = str_replace( + "{" . "envelopeId" . "}", + $this->apiClient->getSerializer()->toPathValue($envelope_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + // body params + $_tempBody = null; + if (isset($document_html_definition)) { + $_tempBody = $document_html_definition; + } + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'POST', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\DocumentHtmlDefinitions', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\DocumentHtmlDefinitions', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 201: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\DocumentHtmlDefinitions', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + /** * Operation createEditView * @@ -2835,6 +3113,10 @@ public function createEnvelopeWithHttpInfo($account_id, $envelope_definition = n $queryParams['cdse_mode'] = $this->apiClient->getSerializer()->toQueryValue($options->getCdseMode()); } // query params + if ($options->getChangeRoutingOrder() !== null) { + $queryParams['change_routing_order'] = $this->apiClient->getSerializer()->toQueryValue($options->getChangeRoutingOrder()); + } + // query params if ($options->getCompletedDocumentsOnly() !== null) { $queryParams['completed_documents_only'] = $this->apiClient->getSerializer()->toQueryValue($options->getCompletedDocumentsOnly()); } @@ -2897,45 +3179,45 @@ public function createEnvelopeWithHttpInfo($account_id, $envelope_definition = n } /** - * Operation createLock + * Operation createEnvelopeRecipientSharedView * - * Lock an envelope. + * Provides a URL to start a shared recipient view of the Envelope UI * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param \DocuSign\eSign\Model\LockRequest $lock_request (optional) + * @param \DocuSign\eSign\Model\RecipientViewRequest $recipient_view_request (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\LockInformation + * @return \DocuSign\eSign\Model\ViewUrl */ - public function createLock($account_id, $envelope_id, $lock_request = null) + public function createEnvelopeRecipientSharedView($account_id, $envelope_id, $recipient_view_request = null) { - list($response) = $this->createLockWithHttpInfo($account_id, $envelope_id, $lock_request); + list($response) = $this->createEnvelopeRecipientSharedViewWithHttpInfo($account_id, $envelope_id, $recipient_view_request); return $response; } /** - * Operation createLockWithHttpInfo + * Operation createEnvelopeRecipientSharedViewWithHttpInfo * - * Lock an envelope. + * Provides a URL to start a shared recipient view of the Envelope UI * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param \DocuSign\eSign\Model\LockRequest $lock_request (optional) + * @param \DocuSign\eSign\Model\RecipientViewRequest $recipient_view_request (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings) */ - public function createLockWithHttpInfo($account_id, $envelope_id, $lock_request = null) + public function createEnvelopeRecipientSharedViewWithHttpInfo($account_id, $envelope_id, $recipient_view_request = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createLock'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createEnvelopeRecipientSharedView'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createLock'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createEnvelopeRecipientSharedView'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/lock"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/shared"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2968,8 +3250,8 @@ public function createLockWithHttpInfo($account_id, $envelope_id, $lock_request // body params $_tempBody = null; - if (isset($lock_request)) { - $_tempBody = $lock_request; + if (isset($recipient_view_request)) { + $_tempBody = $recipient_view_request; } // for model (json/xml) @@ -2986,15 +3268,15 @@ public function createLockWithHttpInfo($account_id, $envelope_id, $lock_request $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\LockInformation', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/lock' + '\DocuSign\eSign\Model\ViewUrl', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/views/shared' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\LockInformation', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ViewUrl', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\LockInformation', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ViewUrl', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3008,47 +3290,158 @@ public function createLockWithHttpInfo($account_id, $envelope_id, $lock_request } /** - * Operation createRecipient + * Operation createLock * - * Adds one or more recipients to an envelope. + * Lock an envelope. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param \DocuSign\eSign\Model\Recipients $recipients (optional) - * @param $options Options for modifying the behavior of the function. (optional) + * @param \DocuSign\eSign\Model\LockRequest $lock_request (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\Recipients + * @return \DocuSign\eSign\Model\LockInformation */ - public function createRecipient($account_id, $envelope_id, $recipients = null, EnvelopesApi\CreateRecipientOptions $options = null) + public function createLock($account_id, $envelope_id, $lock_request = null) { - list($response) = $this->createRecipientWithHttpInfo($account_id, $envelope_id, $recipients, $options); + list($response) = $this->createLockWithHttpInfo($account_id, $envelope_id, $lock_request); return $response; } /** - * Operation createRecipientWithHttpInfo + * Operation createLockWithHttpInfo * - * Adds one or more recipients to an envelope. + * Lock an envelope. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param \DocuSign\eSign\Model\Recipients $recipients (optional) - * @param $options Options for modifying the behavior of the function. (optional) + * @param \DocuSign\eSign\Model\LockRequest $lock_request (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\Recipients, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings) */ - public function createRecipientWithHttpInfo($account_id, $envelope_id, $recipients = null, EnvelopesApi\CreateRecipientOptions $options = null) + public function createLockWithHttpInfo($account_id, $envelope_id, $lock_request = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createRecipient'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createLock'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createRecipient'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createLock'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/lock"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($envelope_id !== null) { + $resourcePath = str_replace( + "{" . "envelopeId" . "}", + $this->apiClient->getSerializer()->toPathValue($envelope_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + // body params + $_tempBody = null; + if (isset($lock_request)) { + $_tempBody = $lock_request; + } + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'POST', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\LockInformation', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/lock' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\LockInformation', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 201: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\LockInformation', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation createRecipient + * + * Adds one or more recipients to an envelope. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param \DocuSign\eSign\Model\Recipients $recipients (optional) + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\Recipients + */ + public function createRecipient($account_id, $envelope_id, $recipients = null, EnvelopesApi\CreateRecipientOptions $options = null) + { + list($response) = $this->createRecipientWithHttpInfo($account_id, $envelope_id, $recipients, $options); + return $response; + } + + /** + * Operation createRecipientWithHttpInfo + * + * Adds one or more recipients to an envelope. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param \DocuSign\eSign\Model\Recipients $recipients (optional) + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\Recipients, HTTP status code, HTTP response headers (array of strings) + */ + public function createRecipientWithHttpInfo($account_id, $envelope_id, $recipients = null, EnvelopesApi\CreateRecipientOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createRecipient'); + } + // verify the required parameter 'envelope_id' is set + if ($envelope_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createRecipient'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3240,45 +3633,45 @@ public function createRecipientViewWithHttpInfo($account_id, $envelope_id, $reci } /** - * Operation createSenderView + * Operation createResponsiveHtmlPreview * - * Returns a URL to the sender view UI. + * Get Responsive HTML Preview for all documents in an envelope. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param \DocuSign\eSign\Model\ReturnUrlRequest $return_url_request (optional) + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $document_html_definition (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\ViewUrl + * @return \DocuSign\eSign\Model\DocumentHtmlDefinitions */ - public function createSenderView($account_id, $envelope_id, $return_url_request = null) + public function createResponsiveHtmlPreview($account_id, $envelope_id, $document_html_definition = null) { - list($response) = $this->createSenderViewWithHttpInfo($account_id, $envelope_id, $return_url_request); + list($response) = $this->createResponsiveHtmlPreviewWithHttpInfo($account_id, $envelope_id, $document_html_definition); return $response; } /** - * Operation createSenderViewWithHttpInfo + * Operation createResponsiveHtmlPreviewWithHttpInfo * - * Returns a URL to the sender view UI. + * Get Responsive HTML Preview for all documents in an envelope. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param \DocuSign\eSign\Model\ReturnUrlRequest $return_url_request (optional) + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $document_html_definition (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\DocumentHtmlDefinitions, HTTP status code, HTTP response headers (array of strings) */ - public function createSenderViewWithHttpInfo($account_id, $envelope_id, $return_url_request = null) + public function createResponsiveHtmlPreviewWithHttpInfo($account_id, $envelope_id, $document_html_definition = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createSenderView'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createResponsiveHtmlPreview'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createSenderView'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createResponsiveHtmlPreview'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/sender"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3311,8 +3704,8 @@ public function createSenderViewWithHttpInfo($account_id, $envelope_id, $return_ // body params $_tempBody = null; - if (isset($return_url_request)) { - $_tempBody = $return_url_request; + if (isset($document_html_definition)) { + $_tempBody = $document_html_definition; } // for model (json/xml) @@ -3329,15 +3722,15 @@ public function createSenderViewWithHttpInfo($account_id, $envelope_id, $return_ $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\ViewUrl', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/views/sender' + '\DocuSign\eSign\Model\DocumentHtmlDefinitions', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ViewUrl', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\DocumentHtmlDefinitions', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ViewUrl', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\DocumentHtmlDefinitions', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3351,51 +3744,45 @@ public function createSenderViewWithHttpInfo($account_id, $envelope_id, $return_ } /** - * Operation createTabs + * Operation createSenderView * - * Adds tabs for a recipient. + * Returns a URL to the sender view UI. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param string $recipient_id The ID of the recipient being accessed. - * @param \DocuSign\eSign\Model\Tabs $tabs (optional) + * @param \DocuSign\eSign\Model\ReturnUrlRequest $return_url_request (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\Tabs + * @return \DocuSign\eSign\Model\ViewUrl */ - public function createTabs($account_id, $envelope_id, $recipient_id, $tabs = null) + public function createSenderView($account_id, $envelope_id, $return_url_request = null) { - list($response) = $this->createTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, $tabs); + list($response) = $this->createSenderViewWithHttpInfo($account_id, $envelope_id, $return_url_request); return $response; } /** - * Operation createTabsWithHttpInfo + * Operation createSenderViewWithHttpInfo * - * Adds tabs for a recipient. + * Returns a URL to the sender view UI. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param string $recipient_id The ID of the recipient being accessed. - * @param \DocuSign\eSign\Model\Tabs $tabs (optional) + * @param \DocuSign\eSign\Model\ReturnUrlRequest $return_url_request (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings) */ - public function createTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, $tabs = null) + public function createSenderViewWithHttpInfo($account_id, $envelope_id, $return_url_request = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createTabs'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createSenderView'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createTabs'); - } - // verify the required parameter 'recipient_id' is set - if ($recipient_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $recipient_id when calling createTabs'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createSenderView'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/sender"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3423,21 +3810,13 @@ public function createTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, $resourcePath ); } - // path params - if ($recipient_id !== null) { - $resourcePath = str_replace( - "{" . "recipientId" . "}", - $this->apiClient->getSerializer()->toPathValue($recipient_id), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); // body params $_tempBody = null; - if (isset($tabs)) { - $_tempBody = $tabs; + if (isset($return_url_request)) { + $_tempBody = $return_url_request; } // for model (json/xml) @@ -3454,15 +3833,15 @@ public function createTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\Tabs', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs' + '\DocuSign\eSign\Model\ViewUrl', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/views/sender' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Tabs', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ViewUrl', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Tabs', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ViewUrl', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3476,45 +3855,51 @@ public function createTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, } /** - * Operation createViewLink + * Operation createTabs * - * Reserved: Returns a URL to the secure link view UI. + * Adds tabs for a recipient. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param \DocuSign\eSign\Model\ViewLinkRequest $view_link_request (optional) + * @param string $recipient_id The ID of the recipient being accessed. + * @param \DocuSign\eSign\Model\Tabs $tabs (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\ViewUrl + * @return \DocuSign\eSign\Model\Tabs */ - public function createViewLink($account_id, $envelope_id, $view_link_request = null) + public function createTabs($account_id, $envelope_id, $recipient_id, $tabs = null) { - list($response) = $this->createViewLinkWithHttpInfo($account_id, $envelope_id, $view_link_request); + list($response) = $this->createTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, $tabs); return $response; } /** - * Operation createViewLinkWithHttpInfo + * Operation createTabsWithHttpInfo * - * Reserved: Returns a URL to the secure link view UI. + * Adds tabs for a recipient. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param \DocuSign\eSign\Model\ViewLinkRequest $view_link_request (optional) + * @param string $recipient_id The ID of the recipient being accessed. + * @param \DocuSign\eSign\Model\Tabs $tabs (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\ViewUrl, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings) */ - public function createViewLinkWithHttpInfo($account_id, $envelope_id, $view_link_request = null) + public function createTabsWithHttpInfo($account_id, $envelope_id, $recipient_id, $tabs = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createViewLink'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createTabs'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createViewLink'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling createTabs'); + } + // verify the required parameter 'recipient_id' is set + if ($recipient_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $recipient_id when calling createTabs'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/viewlink"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3542,13 +3927,21 @@ public function createViewLinkWithHttpInfo($account_id, $envelope_id, $view_link $resourcePath ); } + // path params + if ($recipient_id !== null) { + $resourcePath = str_replace( + "{" . "recipientId" . "}", + $this->apiClient->getSerializer()->toPathValue($recipient_id), + $resourcePath + ); + } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); // body params $_tempBody = null; - if (isset($view_link_request)) { - $_tempBody = $view_link_request; + if (isset($tabs)) { + $_tempBody = $tabs; } // for model (json/xml) @@ -3565,15 +3958,15 @@ public function createViewLinkWithHttpInfo($account_id, $envelope_id, $view_link $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\ViewUrl', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/views/viewlink' + '\DocuSign\eSign\Model\Tabs', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ViewUrl', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Tabs', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ViewUrl', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Tabs', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -4967,43 +5360,49 @@ public function deleteTemplatesFromDocumentWithHttpInfo($account_id, $document_i } /** - * Operation deleteViewLink + * Operation getAttachment * - * Reserved: Expires a secure view link. + * Retrieves an attachment from the envelope. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $attachment_id * @param string $envelope_id The envelopeId Guid of the envelope being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response * @return void */ - public function deleteViewLink($account_id, $envelope_id) + public function getAttachment($account_id, $attachment_id, $envelope_id) { - list($response) = $this->deleteViewLinkWithHttpInfo($account_id, $envelope_id); + list($response) = $this->getAttachmentWithHttpInfo($account_id, $attachment_id, $envelope_id); return $response; } /** - * Operation deleteViewLinkWithHttpInfo + * Operation getAttachmentWithHttpInfo * - * Reserved: Expires a secure view link. + * Retrieves an attachment from the envelope. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $attachment_id * @param string $envelope_id The envelopeId Guid of the envelope being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function deleteViewLinkWithHttpInfo($account_id, $envelope_id) + public function getAttachmentWithHttpInfo($account_id, $attachment_id, $envelope_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling deleteViewLink'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getAttachment'); + } + // verify the required parameter 'attachment_id' is set + if ($attachment_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $attachment_id when calling getAttachment'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling deleteViewLink'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getAttachment'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/views/viewlink"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -5024,6 +5423,14 @@ public function deleteViewLinkWithHttpInfo($account_id, $envelope_id) ); } // path params + if ($attachment_id !== null) { + $resourcePath = str_replace( + "{" . "attachmentId" . "}", + $this->apiClient->getSerializer()->toPathValue($attachment_id), + $resourcePath + ); + } + // path params if ($envelope_id !== null) { $resourcePath = str_replace( "{" . "envelopeId" . "}", @@ -5045,12 +5452,12 @@ public function deleteViewLinkWithHttpInfo($account_id, $envelope_id) try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( $resourcePath, - 'DELETE', + 'GET', $queryParams, $httpBody, $headerParams, null, - '/v2/accounts/{accountId}/envelopes/{envelopeId}/views/viewlink' + '/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}' ); return [null, $statusCode, $httpHeader]; @@ -5067,49 +5474,43 @@ public function deleteViewLinkWithHttpInfo($account_id, $envelope_id) } /** - * Operation getAttachment + * Operation getAttachments * - * Retrieves an attachment from the envelope. + * Returns a list of attachments associated with the specified envelope * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $attachment_id * @param string $envelope_id The envelopeId Guid of the envelope being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return void + * @return \DocuSign\eSign\Model\EnvelopeAttachmentsResult */ - public function getAttachment($account_id, $attachment_id, $envelope_id) + public function getAttachments($account_id, $envelope_id) { - list($response) = $this->getAttachmentWithHttpInfo($account_id, $attachment_id, $envelope_id); + list($response) = $this->getAttachmentsWithHttpInfo($account_id, $envelope_id); return $response; } /** - * Operation getAttachmentWithHttpInfo + * Operation getAttachmentsWithHttpInfo * - * Retrieves an attachment from the envelope. + * Returns a list of attachments associated with the specified envelope * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $attachment_id * @param string $envelope_id The envelopeId Guid of the envelope being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\EnvelopeAttachmentsResult, HTTP status code, HTTP response headers (array of strings) */ - public function getAttachmentWithHttpInfo($account_id, $attachment_id, $envelope_id) + public function getAttachmentsWithHttpInfo($account_id, $envelope_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getAttachment'); - } - // verify the required parameter 'attachment_id' is set - if ($attachment_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $attachment_id when calling getAttachment'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getAttachments'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getAttachment'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getAttachments'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -5130,14 +5531,6 @@ public function getAttachmentWithHttpInfo($account_id, $attachment_id, $envelope ); } // path params - if ($attachment_id !== null) { - $resourcePath = str_replace( - "{" . "attachmentId" . "}", - $this->apiClient->getSerializer()->toPathValue($attachment_id), - $resourcePath - ); - } - // path params if ($envelope_id !== null) { $resourcePath = str_replace( "{" . "envelopeId" . "}", @@ -5163,13 +5556,17 @@ public function getAttachmentWithHttpInfo($account_id, $attachment_id, $envelope $queryParams, $httpBody, $headerParams, - null, - '/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}' + '\DocuSign\eSign\Model\EnvelopeAttachmentsResult', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments' ); - return [null, $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\EnvelopeAttachmentsResult', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\EnvelopeAttachmentsResult', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; case 400: $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); $e->setResponseObject($data); @@ -5181,43 +5578,45 @@ public function getAttachmentWithHttpInfo($account_id, $attachment_id, $envelope } /** - * Operation getAttachments + * Operation getChunkedUpload * - * Returns a list of attachments associated with the specified envelope + * Retrieves the current metadata of a ChunkedUpload. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param string $chunked_upload_id + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\EnvelopeAttachmentsResult + * @return \DocuSign\eSign\Model\ChunkedUploadResponse */ - public function getAttachments($account_id, $envelope_id) + public function getChunkedUpload($account_id, $chunked_upload_id, EnvelopesApi\GetChunkedUploadOptions $options = null) { - list($response) = $this->getAttachmentsWithHttpInfo($account_id, $envelope_id); + list($response) = $this->getChunkedUploadWithHttpInfo($account_id, $chunked_upload_id, $options); return $response; } /** - * Operation getAttachmentsWithHttpInfo + * Operation getChunkedUploadWithHttpInfo * - * Returns a list of attachments associated with the specified envelope + * Retrieves the current metadata of a ChunkedUpload. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param string $chunked_upload_id + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\EnvelopeAttachmentsResult, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\ChunkedUploadResponse, HTTP status code, HTTP response headers (array of strings) */ - public function getAttachmentsWithHttpInfo($account_id, $envelope_id) + public function getChunkedUploadWithHttpInfo($account_id, $chunked_upload_id, EnvelopesApi\GetChunkedUploadOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getAttachments'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getChunkedUpload'); } - // verify the required parameter 'envelope_id' is set - if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getAttachments'); + // verify the required parameter 'chunked_upload_id' is set + if ($chunked_upload_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $chunked_upload_id when calling getChunkedUpload'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments"; + $resourcePath = "/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -5228,6 +5627,14 @@ public function getAttachmentsWithHttpInfo($account_id, $envelope_id) } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getInclude() !== null) { + $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); + } + } // path params if ($account_id !== null) { @@ -5238,10 +5645,10 @@ public function getAttachmentsWithHttpInfo($account_id, $envelope_id) ); } // path params - if ($envelope_id !== null) { + if ($chunked_upload_id !== null) { $resourcePath = str_replace( - "{" . "envelopeId" . "}", - $this->apiClient->getSerializer()->toPathValue($envelope_id), + "{" . "chunkedUploadId" . "}", + $this->apiClient->getSerializer()->toPathValue($chunked_upload_id), $resourcePath ); } @@ -5263,15 +5670,15 @@ public function getAttachmentsWithHttpInfo($account_id, $envelope_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\EnvelopeAttachmentsResult', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/attachments' + '\DocuSign\eSign\Model\ChunkedUploadResponse', + '/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\EnvelopeAttachmentsResult', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ChunkedUploadResponse', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\EnvelopeAttachmentsResult', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ChunkedUploadResponse', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -5285,45 +5692,57 @@ public function getAttachmentsWithHttpInfo($account_id, $envelope_id) } /** - * Operation getChunkedUpload + * Operation getConsumerDisclosure * - * Retrieves the current metadata of a ChunkedUpload. + * Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $chunked_upload_id + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param string $lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. + * @param string $recipient_id The ID of the recipient being accessed. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\ChunkedUploadResponse + * @return \DocuSign\eSign\Model\ConsumerDisclosure */ - public function getChunkedUpload($account_id, $chunked_upload_id, EnvelopesApi\GetChunkedUploadOptions $options = null) + public function getConsumerDisclosure($account_id, $envelope_id, $lang_code, $recipient_id, EnvelopesApi\GetConsumerDisclosureOptions $options = null) { - list($response) = $this->getChunkedUploadWithHttpInfo($account_id, $chunked_upload_id, $options); + list($response) = $this->getConsumerDisclosureWithHttpInfo($account_id, $envelope_id, $lang_code, $recipient_id, $options); return $response; } /** - * Operation getChunkedUploadWithHttpInfo + * Operation getConsumerDisclosureWithHttpInfo * - * Retrieves the current metadata of a ChunkedUpload. + * Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $chunked_upload_id + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param string $lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. + * @param string $recipient_id The ID of the recipient being accessed. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\ChunkedUploadResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings) */ - public function getChunkedUploadWithHttpInfo($account_id, $chunked_upload_id, EnvelopesApi\GetChunkedUploadOptions $options = null) + public function getConsumerDisclosureWithHttpInfo($account_id, $envelope_id, $lang_code, $recipient_id, EnvelopesApi\GetConsumerDisclosureOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getChunkedUpload'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getConsumerDisclosure'); } - // verify the required parameter 'chunked_upload_id' is set - if ($chunked_upload_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $chunked_upload_id when calling getChunkedUpload'); + // verify the required parameter 'envelope_id' is set + if ($envelope_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getConsumerDisclosure'); + } + // verify the required parameter 'lang_code' is set + if ($lang_code === null) { + throw new \InvalidArgumentException('Missing the required parameter $lang_code when calling getConsumerDisclosure'); + } + // verify the required parameter 'recipient_id' is set + if ($recipient_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $recipient_id when calling getConsumerDisclosure'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -5338,8 +5757,8 @@ public function getChunkedUploadWithHttpInfo($account_id, $chunked_upload_id, En { // query params // query params - if ($options->getInclude() !== null) { - $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); + if ($options->getLangCode2() !== null) { + $queryParams['langCode'] = $this->apiClient->getSerializer()->toQueryValue($options->getLangCode2()); } } @@ -5352,10 +5771,26 @@ public function getChunkedUploadWithHttpInfo($account_id, $chunked_upload_id, En ); } // path params - if ($chunked_upload_id !== null) { + if ($envelope_id !== null) { $resourcePath = str_replace( - "{" . "chunkedUploadId" . "}", - $this->apiClient->getSerializer()->toPathValue($chunked_upload_id), + "{" . "envelopeId" . "}", + $this->apiClient->getSerializer()->toPathValue($envelope_id), + $resourcePath + ); + } + // path params + if ($lang_code !== null) { + $resourcePath = str_replace( + "{" . "langCode" . "}", + $this->apiClient->getSerializer()->toPathValue($lang_code), + $resourcePath + ); + } + // path params + if ($recipient_id !== null) { + $resourcePath = str_replace( + "{" . "recipientId" . "}", + $this->apiClient->getSerializer()->toPathValue($recipient_id), $resourcePath ); } @@ -5377,15 +5812,15 @@ public function getChunkedUploadWithHttpInfo($account_id, $chunked_upload_id, En $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\ChunkedUploadResponse', - '/v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}' + '\DocuSign\eSign\Model\ConsumerDisclosure', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ChunkedUploadResponse', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ConsumerDisclosure', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ChunkedUploadResponse', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ConsumerDisclosure', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -5399,57 +5834,605 @@ public function getChunkedUploadWithHttpInfo($account_id, $chunked_upload_id, En } /** - * Operation getConsumerDisclosure + * Operation getConsumerDisclosureDefault * - * Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. + * Gets the Electronic Record and Signature Disclosure associated with the account. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param string $lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. * @param string $recipient_id The ID of the recipient being accessed. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response * @return \DocuSign\eSign\Model\ConsumerDisclosure */ - public function getConsumerDisclosure($account_id, $envelope_id, $lang_code, $recipient_id, EnvelopesApi\GetConsumerDisclosureOptions $options = null) + public function getConsumerDisclosureDefault($account_id, $envelope_id, $recipient_id, EnvelopesApi\GetConsumerDisclosureDefaultOptions $options = null) { - list($response) = $this->getConsumerDisclosureWithHttpInfo($account_id, $envelope_id, $lang_code, $recipient_id, $options); + list($response) = $this->getConsumerDisclosureDefaultWithHttpInfo($account_id, $envelope_id, $recipient_id, $options); return $response; } /** - * Operation getConsumerDisclosureWithHttpInfo + * Operation getConsumerDisclosureDefaultWithHttpInfo * - * Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. + * Gets the Electronic Record and Signature Disclosure associated with the account. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param string $lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. * @param string $recipient_id The ID of the recipient being accessed. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response * @return array of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings) */ - public function getConsumerDisclosureWithHttpInfo($account_id, $envelope_id, $lang_code, $recipient_id, EnvelopesApi\GetConsumerDisclosureOptions $options = null) + public function getConsumerDisclosureDefaultWithHttpInfo($account_id, $envelope_id, $recipient_id, EnvelopesApi\GetConsumerDisclosureDefaultOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getConsumerDisclosure'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getConsumerDisclosureDefault'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getConsumerDisclosure'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getConsumerDisclosureDefault'); } - // verify the required parameter 'lang_code' is set - if ($lang_code === null) { - throw new \InvalidArgumentException('Missing the required parameter $lang_code when calling getConsumerDisclosure'); + // verify the required parameter 'recipient_id' is set + if ($recipient_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $recipient_id when calling getConsumerDisclosureDefault'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getLangCode() !== null) { + $queryParams['langCode'] = $this->apiClient->getSerializer()->toQueryValue($options->getLangCode()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($envelope_id !== null) { + $resourcePath = str_replace( + "{" . "envelopeId" . "}", + $this->apiClient->getSerializer()->toPathValue($envelope_id), + $resourcePath + ); + } + // path params + if ($recipient_id !== null) { + $resourcePath = str_replace( + "{" . "recipientId" . "}", + $this->apiClient->getSerializer()->toPathValue($recipient_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\ConsumerDisclosure', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ConsumerDisclosure', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ConsumerDisclosure', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation getDocument + * + * Gets a document from an envelope. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \SplFileObject + */ + public function getDocument($account_id, $document_id, $envelope_id, EnvelopesApi\GetDocumentOptions $options = null) + { + list($response) = $this->getDocumentWithHttpInfo($account_id, $document_id, $envelope_id, $options); + return $response; + } + + /** + * Operation getDocumentWithHttpInfo + * + * Gets a document from an envelope. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) + */ + public function getDocumentWithHttpInfo($account_id, $document_id, $envelope_id, EnvelopesApi\GetDocumentOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getDocument'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getDocument'); + } + // verify the required parameter 'envelope_id' is set + if ($envelope_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getDocument'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/pdf']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getCertificate() !== null) { + $queryParams['certificate'] = $this->apiClient->getSerializer()->toQueryValue($options->getCertificate()); + } + // query params + if ($options->getEncoding() !== null) { + $queryParams['encoding'] = $this->apiClient->getSerializer()->toQueryValue($options->getEncoding()); + } + // query params + if ($options->getEncrypt() !== null) { + $queryParams['encrypt'] = $this->apiClient->getSerializer()->toQueryValue($options->getEncrypt()); + } + // query params + if ($options->getLanguage() !== null) { + $queryParams['language'] = $this->apiClient->getSerializer()->toQueryValue($options->getLanguage()); + } + // query params + if ($options->getRecipientId() !== null) { + $queryParams['recipient_id'] = $this->apiClient->getSerializer()->toQueryValue($options->getRecipientId()); + } + // query params + if ($options->getShowChanges() !== null) { + $queryParams['show_changes'] = $this->apiClient->getSerializer()->toQueryValue($options->getShowChanges()); + } + // query params + if ($options->getWatermark() !== null) { + $queryParams['watermark'] = $this->apiClient->getSerializer()->toQueryValue($options->getWatermark()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params + if ($envelope_id !== null) { + $resourcePath = str_replace( + "{" . "envelopeId" . "}", + $this->apiClient->getSerializer()->toPathValue($envelope_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\SplFileObject', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\SplFileObject', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation getDocumentPageImage + * + * Gets a page image from an envelope for display. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param string $page_number The page number being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \SplFileObject + */ + public function getDocumentPageImage($account_id, $document_id, $envelope_id, $page_number, EnvelopesApi\GetDocumentPageImageOptions $options = null) + { + list($response) = $this->getDocumentPageImageWithHttpInfo($account_id, $document_id, $envelope_id, $page_number, $options); + return $response; + } + + /** + * Operation getDocumentPageImageWithHttpInfo + * + * Gets a page image from an envelope for display. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param string $page_number The page number being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) + */ + public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $envelope_id, $page_number, EnvelopesApi\GetDocumentPageImageOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getDocumentPageImage'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getDocumentPageImage'); + } + // verify the required parameter 'envelope_id' is set + if ($envelope_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getDocumentPageImage'); + } + // verify the required parameter 'page_number' is set + if ($page_number === null) { + throw new \InvalidArgumentException('Missing the required parameter $page_number when calling getDocumentPageImage'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['image/png']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getDpi() !== null) { + $queryParams['dpi'] = $this->apiClient->getSerializer()->toQueryValue($options->getDpi()); + } + // query params + if ($options->getMaxHeight() !== null) { + $queryParams['max_height'] = $this->apiClient->getSerializer()->toQueryValue($options->getMaxHeight()); + } + // query params + if ($options->getMaxWidth() !== null) { + $queryParams['max_width'] = $this->apiClient->getSerializer()->toQueryValue($options->getMaxWidth()); + } + // query params + if ($options->getShowChanges() !== null) { + $queryParams['show_changes'] = $this->apiClient->getSerializer()->toQueryValue($options->getShowChanges()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params + if ($envelope_id !== null) { + $resourcePath = str_replace( + "{" . "envelopeId" . "}", + $this->apiClient->getSerializer()->toPathValue($envelope_id), + $resourcePath + ); + } + // path params + if ($page_number !== null) { + $resourcePath = str_replace( + "{" . "pageNumber" . "}", + $this->apiClient->getSerializer()->toPathValue($page_number), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\SplFileObject', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\SplFileObject', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation getDocumentTabs + * + * Returns tabs on the document. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\Tabs + */ + public function getDocumentTabs($account_id, $document_id, $envelope_id, EnvelopesApi\GetDocumentTabsOptions $options = null) + { + list($response) = $this->getDocumentTabsWithHttpInfo($account_id, $document_id, $envelope_id, $options); + return $response; + } + + /** + * Operation getDocumentTabsWithHttpInfo + * + * Returns tabs on the document. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings) + */ + public function getDocumentTabsWithHttpInfo($account_id, $document_id, $envelope_id, EnvelopesApi\GetDocumentTabsOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getDocumentTabs'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getDocumentTabs'); + } + // verify the required parameter 'envelope_id' is set + if ($envelope_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getDocumentTabs'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getPageNumbers() !== null) { + $queryParams['page_numbers'] = $this->apiClient->getSerializer()->toQueryValue($options->getPageNumbers()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params + if ($envelope_id !== null) { + $resourcePath = str_replace( + "{" . "envelopeId" . "}", + $this->apiClient->getSerializer()->toPathValue($envelope_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\Tabs', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Tabs', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Tabs', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation getEmailSettings + * + * Gets the email setting overrides for an envelope. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\EmailSettings + */ + public function getEmailSettings($account_id, $envelope_id) + { + list($response) = $this->getEmailSettingsWithHttpInfo($account_id, $envelope_id); + return $response; + } + + /** + * Operation getEmailSettingsWithHttpInfo + * + * Gets the email setting overrides for an envelope. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\EmailSettings, HTTP status code, HTTP response headers (array of strings) + */ + public function getEmailSettingsWithHttpInfo($account_id, $envelope_id) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getEmailSettings'); } - // verify the required parameter 'recipient_id' is set - if ($recipient_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $recipient_id when calling getConsumerDisclosure'); + // verify the required parameter 'envelope_id' is set + if ($envelope_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getEmailSettings'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -5460,14 +6443,6 @@ public function getConsumerDisclosureWithHttpInfo($account_id, $envelope_id, $la } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getLangCode2() !== null) { - $queryParams['langCode'] = $this->apiClient->getSerializer()->toQueryValue($options->getLangCode2()); - } - } // path params if ($account_id !== null) { @@ -5485,22 +6460,6 @@ public function getConsumerDisclosureWithHttpInfo($account_id, $envelope_id, $la $resourcePath ); } - // path params - if ($lang_code !== null) { - $resourcePath = str_replace( - "{" . "langCode" . "}", - $this->apiClient->getSerializer()->toPathValue($lang_code), - $resourcePath - ); - } - // path params - if ($recipient_id !== null) { - $resourcePath = str_replace( - "{" . "recipientId" . "}", - $this->apiClient->getSerializer()->toPathValue($recipient_id), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -5519,15 +6478,15 @@ public function getConsumerDisclosureWithHttpInfo($account_id, $envelope_id, $la $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\ConsumerDisclosure', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}' + '\DocuSign\eSign\Model\EmailSettings', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ConsumerDisclosure', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\EmailSettings', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ConsumerDisclosure', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\EmailSettings', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -5541,51 +6500,45 @@ public function getConsumerDisclosureWithHttpInfo($account_id, $envelope_id, $la } /** - * Operation getConsumerDisclosureDefault + * Operation getEnvelope * - * Gets the Electronic Record and Signature Disclosure associated with the account. + * Gets the status of a envelope. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param string $recipient_id The ID of the recipient being accessed. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\ConsumerDisclosure + * @return \DocuSign\eSign\Model\Envelope */ - public function getConsumerDisclosureDefault($account_id, $envelope_id, $recipient_id, EnvelopesApi\GetConsumerDisclosureDefaultOptions $options = null) + public function getEnvelope($account_id, $envelope_id, EnvelopesApi\GetEnvelopeOptions $options = null) { - list($response) = $this->getConsumerDisclosureDefaultWithHttpInfo($account_id, $envelope_id, $recipient_id, $options); + list($response) = $this->getEnvelopeWithHttpInfo($account_id, $envelope_id, $options); return $response; } /** - * Operation getConsumerDisclosureDefaultWithHttpInfo + * Operation getEnvelopeWithHttpInfo * - * Gets the Electronic Record and Signature Disclosure associated with the account. + * Gets the status of a envelope. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param string $recipient_id The ID of the recipient being accessed. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\ConsumerDisclosure, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\Envelope, HTTP status code, HTTP response headers (array of strings) */ - public function getConsumerDisclosureDefaultWithHttpInfo($account_id, $envelope_id, $recipient_id, EnvelopesApi\GetConsumerDisclosureDefaultOptions $options = null) + public function getEnvelopeWithHttpInfo($account_id, $envelope_id, EnvelopesApi\GetEnvelopeOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getConsumerDisclosureDefault'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getEnvelope'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getConsumerDisclosureDefault'); - } - // verify the required parameter 'recipient_id' is set - if ($recipient_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $recipient_id when calling getConsumerDisclosureDefault'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getEnvelope'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -5600,8 +6553,12 @@ public function getConsumerDisclosureDefaultWithHttpInfo($account_id, $envelope_ { // query params // query params - if ($options->getLangCode() !== null) { - $queryParams['langCode'] = $this->apiClient->getSerializer()->toQueryValue($options->getLangCode()); + if ($options->getAdvancedUpdate() !== null) { + $queryParams['advanced_update'] = $this->apiClient->getSerializer()->toQueryValue($options->getAdvancedUpdate()); + } + // query params + if ($options->getInclude() !== null) { + $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); } } @@ -5621,14 +6578,6 @@ public function getConsumerDisclosureDefaultWithHttpInfo($account_id, $envelope_ $resourcePath ); } - // path params - if ($recipient_id !== null) { - $resourcePath = str_replace( - "{" . "recipientId" . "}", - $this->apiClient->getSerializer()->toPathValue($recipient_id), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -5647,15 +6596,15 @@ public function getConsumerDisclosureDefaultWithHttpInfo($account_id, $envelope_ $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\ConsumerDisclosure', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure' + '\DocuSign\eSign\Model\Envelope', + '/v2/accounts/{accountId}/envelopes/{envelopeId}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\ConsumerDisclosure', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Envelope', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ConsumerDisclosure', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Envelope', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -5669,93 +6618,59 @@ public function getConsumerDisclosureDefaultWithHttpInfo($account_id, $envelope_ } /** - * Operation getDocument + * Operation getEnvelopeDocumentHtmlDefinitions * - * Gets a document from an envelope. + * Get the Original HTML Definition used to generate the Responsive HTML for a given document. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $document_id The ID of the document being accessed. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \SplFileObject + * @return \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals */ - public function getDocument($account_id, $document_id, $envelope_id, EnvelopesApi\GetDocumentOptions $options = null) + public function getEnvelopeDocumentHtmlDefinitions($account_id, $document_id, $envelope_id) { - list($response) = $this->getDocumentWithHttpInfo($account_id, $document_id, $envelope_id, $options); + list($response) = $this->getEnvelopeDocumentHtmlDefinitionsWithHttpInfo($account_id, $document_id, $envelope_id); return $response; } /** - * Operation getDocumentWithHttpInfo + * Operation getEnvelopeDocumentHtmlDefinitionsWithHttpInfo * - * Gets a document from an envelope. + * Get the Original HTML Definition used to generate the Responsive HTML for a given document. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $document_id The ID of the document being accessed. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals, HTTP status code, HTTP response headers (array of strings) */ - public function getDocumentWithHttpInfo($account_id, $document_id, $envelope_id, EnvelopesApi\GetDocumentOptions $options = null) + public function getEnvelopeDocumentHtmlDefinitionsWithHttpInfo($account_id, $document_id, $envelope_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getDocument'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getEnvelopeDocumentHtmlDefinitions'); } // verify the required parameter 'document_id' is set if ($document_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getDocument'); + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getEnvelopeDocumentHtmlDefinitions'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getDocument'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getEnvelopeDocumentHtmlDefinitions'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions"; $httpBody = ''; $queryParams = []; $headerParams = []; $formParams = []; - $_header_accept = $this->apiClient->selectHeaderAccept(['application/pdf']); + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getCertificate() !== null) { - $queryParams['certificate'] = $this->apiClient->getSerializer()->toQueryValue($options->getCertificate()); - } - // query params - if ($options->getEncoding() !== null) { - $queryParams['encoding'] = $this->apiClient->getSerializer()->toQueryValue($options->getEncoding()); - } - // query params - if ($options->getEncrypt() !== null) { - $queryParams['encrypt'] = $this->apiClient->getSerializer()->toQueryValue($options->getEncrypt()); - } - // query params - if ($options->getLanguage() !== null) { - $queryParams['language'] = $this->apiClient->getSerializer()->toQueryValue($options->getLanguage()); - } - // query params - if ($options->getRecipientId() !== null) { - $queryParams['recipient_id'] = $this->apiClient->getSerializer()->toQueryValue($options->getRecipientId()); - } - // query params - if ($options->getShowChanges() !== null) { - $queryParams['show_changes'] = $this->apiClient->getSerializer()->toQueryValue($options->getShowChanges()); - } - // query params - if ($options->getWatermark() !== null) { - $queryParams['watermark'] = $this->apiClient->getSerializer()->toQueryValue($options->getWatermark()); - } - } // path params if ($account_id !== null) { @@ -5799,15 +6714,15 @@ public function getDocumentWithHttpInfo($account_id, $document_id, $envelope_id, $queryParams, $httpBody, $headerParams, - '\SplFileObject', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}' + '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\SplFileObject', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -5821,87 +6736,53 @@ public function getDocumentWithHttpInfo($account_id, $document_id, $envelope_id, } /** - * Operation getDocumentPageImage + * Operation getEnvelopeHtmlDefinitions * - * Gets a page image from an envelope for display. + * Get the Original HTML Definition used to generate the Responsive HTML for the envelope. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $document_id The ID of the document being accessed. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param string $page_number The page number being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \SplFileObject + * @return \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals */ - public function getDocumentPageImage($account_id, $document_id, $envelope_id, $page_number, EnvelopesApi\GetDocumentPageImageOptions $options = null) + public function getEnvelopeHtmlDefinitions($account_id, $envelope_id) { - list($response) = $this->getDocumentPageImageWithHttpInfo($account_id, $document_id, $envelope_id, $page_number, $options); + list($response) = $this->getEnvelopeHtmlDefinitionsWithHttpInfo($account_id, $envelope_id); return $response; } /** - * Operation getDocumentPageImageWithHttpInfo + * Operation getEnvelopeHtmlDefinitionsWithHttpInfo * - * Gets a page image from an envelope for display. + * Get the Original HTML Definition used to generate the Responsive HTML for the envelope. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $document_id The ID of the document being accessed. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param string $page_number The page number being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals, HTTP status code, HTTP response headers (array of strings) */ - public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $envelope_id, $page_number, EnvelopesApi\GetDocumentPageImageOptions $options = null) + public function getEnvelopeHtmlDefinitionsWithHttpInfo($account_id, $envelope_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getDocumentPageImage'); - } - // verify the required parameter 'document_id' is set - if ($document_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getDocumentPageImage'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getEnvelopeHtmlDefinitions'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getDocumentPageImage'); - } - // verify the required parameter 'page_number' is set - if ($page_number === null) { - throw new \InvalidArgumentException('Missing the required parameter $page_number when calling getDocumentPageImage'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getEnvelopeHtmlDefinitions'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/html_definitions"; $httpBody = ''; $queryParams = []; $headerParams = []; $formParams = []; - $_header_accept = $this->apiClient->selectHeaderAccept(['image/png']); + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getDpi() !== null) { - $queryParams['dpi'] = $this->apiClient->getSerializer()->toQueryValue($options->getDpi()); - } - // query params - if ($options->getMaxHeight() !== null) { - $queryParams['max_height'] = $this->apiClient->getSerializer()->toQueryValue($options->getMaxHeight()); - } - // query params - if ($options->getMaxWidth() !== null) { - $queryParams['max_width'] = $this->apiClient->getSerializer()->toQueryValue($options->getMaxWidth()); - } - // query params - if ($options->getShowChanges() !== null) { - $queryParams['show_changes'] = $this->apiClient->getSerializer()->toQueryValue($options->getShowChanges()); - } - } // path params if ($account_id !== null) { @@ -5912,14 +6793,6 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $env ); } // path params - if ($document_id !== null) { - $resourcePath = str_replace( - "{" . "documentId" . "}", - $this->apiClient->getSerializer()->toPathValue($document_id), - $resourcePath - ); - } - // path params if ($envelope_id !== null) { $resourcePath = str_replace( "{" . "envelopeId" . "}", @@ -5927,14 +6800,6 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $env $resourcePath ); } - // path params - if ($page_number !== null) { - $resourcePath = str_replace( - "{" . "pageNumber" . "}", - $this->apiClient->getSerializer()->toPathValue($page_number), - $resourcePath - ); - } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -5953,15 +6818,15 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $env $queryParams, $httpBody, $headerParams, - '\SplFileObject', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image' + '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/html_definitions' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\SplFileObject', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -5975,43 +6840,43 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $env } /** - * Operation getEmailSettings + * Operation getFormData * - * Gets the email setting overrides for an envelope. + * Returns envelope form data for an existing envelope. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\EmailSettings + * @return \DocuSign\eSign\Model\EnvelopeFormData */ - public function getEmailSettings($account_id, $envelope_id) + public function getFormData($account_id, $envelope_id) { - list($response) = $this->getEmailSettingsWithHttpInfo($account_id, $envelope_id); + list($response) = $this->getFormDataWithHttpInfo($account_id, $envelope_id); return $response; } /** - * Operation getEmailSettingsWithHttpInfo + * Operation getFormDataWithHttpInfo * - * Gets the email setting overrides for an envelope. + * Returns envelope form data for an existing envelope. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\EmailSettings, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\EnvelopeFormData, HTTP status code, HTTP response headers (array of strings) */ - public function getEmailSettingsWithHttpInfo($account_id, $envelope_id) + public function getFormDataWithHttpInfo($account_id, $envelope_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getEmailSettings'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getFormData'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getEmailSettings'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getFormData'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/form_data"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -6057,15 +6922,15 @@ public function getEmailSettingsWithHttpInfo($account_id, $envelope_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\EmailSettings', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings' + '\DocuSign\eSign\Model\EnvelopeFormData', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/form_data' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\EmailSettings', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\EnvelopeFormData', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\EmailSettings', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\EnvelopeFormData', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -6079,45 +6944,43 @@ public function getEmailSettingsWithHttpInfo($account_id, $envelope_id) } /** - * Operation getEnvelope + * Operation getLock * - * Gets the status of a envelope. + * Gets envelope lock information. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\Envelope + * @return \DocuSign\eSign\Model\LockInformation */ - public function getEnvelope($account_id, $envelope_id, EnvelopesApi\GetEnvelopeOptions $options = null) + public function getLock($account_id, $envelope_id) { - list($response) = $this->getEnvelopeWithHttpInfo($account_id, $envelope_id, $options); + list($response) = $this->getLockWithHttpInfo($account_id, $envelope_id); return $response; } /** - * Operation getEnvelopeWithHttpInfo + * Operation getLockWithHttpInfo * - * Gets the status of a envelope. + * Gets envelope lock information. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\Envelope, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings) */ - public function getEnvelopeWithHttpInfo($account_id, $envelope_id, EnvelopesApi\GetEnvelopeOptions $options = null) + public function getLockWithHttpInfo($account_id, $envelope_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getEnvelope'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getLock'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getEnvelope'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getLock'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/lock"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -6128,18 +6991,6 @@ public function getEnvelopeWithHttpInfo($account_id, $envelope_id, EnvelopesApi\ } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getAdvancedUpdate() !== null) { - $queryParams['advanced_update'] = $this->apiClient->getSerializer()->toQueryValue($options->getAdvancedUpdate()); - } - // query params - if ($options->getInclude() !== null) { - $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); - } - } // path params if ($account_id !== null) { @@ -6175,15 +7026,15 @@ public function getEnvelopeWithHttpInfo($account_id, $envelope_id, EnvelopesApi\ $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\Envelope', - '/v2/accounts/{accountId}/envelopes/{envelopeId}' + '\DocuSign\eSign\Model\LockInformation', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/lock' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Envelope', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\LockInformation', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Envelope', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\LockInformation', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -6197,43 +7048,43 @@ public function getEnvelopeWithHttpInfo($account_id, $envelope_id, EnvelopesApi\ } /** - * Operation getFormData + * Operation getNotificationSettings * - * Returns envelope form data for an existing envelope. + * Gets envelope notification information. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\EnvelopeFormData + * @return \DocuSign\eSign\Model\Notification */ - public function getFormData($account_id, $envelope_id) + public function getNotificationSettings($account_id, $envelope_id) { - list($response) = $this->getFormDataWithHttpInfo($account_id, $envelope_id); + list($response) = $this->getNotificationSettingsWithHttpInfo($account_id, $envelope_id); return $response; } /** - * Operation getFormDataWithHttpInfo + * Operation getNotificationSettingsWithHttpInfo * - * Returns envelope form data for an existing envelope. + * Gets envelope notification information. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\EnvelopeFormData, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\Notification, HTTP status code, HTTP response headers (array of strings) */ - public function getFormDataWithHttpInfo($account_id, $envelope_id) + public function getNotificationSettingsWithHttpInfo($account_id, $envelope_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getFormData'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getNotificationSettings'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getFormData'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getNotificationSettings'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/form_data"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/notification"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -6279,15 +7130,15 @@ public function getFormDataWithHttpInfo($account_id, $envelope_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\EnvelopeFormData', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/form_data' + '\DocuSign\eSign\Model\Notification', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/notification' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\EnvelopeFormData', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Notification', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\EnvelopeFormData', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Notification', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -6301,43 +7152,55 @@ public function getFormDataWithHttpInfo($account_id, $envelope_id) } /** - * Operation getLock + * Operation getPageTabs * - * Gets envelope lock information. + * Returns tabs on the specified page. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param string $page_number The page number being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\LockInformation + * @return \DocuSign\eSign\Model\Tabs */ - public function getLock($account_id, $envelope_id) + public function getPageTabs($account_id, $document_id, $envelope_id, $page_number) { - list($response) = $this->getLockWithHttpInfo($account_id, $envelope_id); + list($response) = $this->getPageTabsWithHttpInfo($account_id, $document_id, $envelope_id, $page_number); return $response; } /** - * Operation getLockWithHttpInfo + * Operation getPageTabsWithHttpInfo * - * Gets envelope lock information. + * Returns tabs on the specified page. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param string $page_number The page number being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings) */ - public function getLockWithHttpInfo($account_id, $envelope_id) + public function getPageTabsWithHttpInfo($account_id, $document_id, $envelope_id, $page_number) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getLock'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getPageTabs'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getPageTabs'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getLock'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getPageTabs'); + } + // verify the required parameter 'page_number' is set + if ($page_number === null) { + throw new \InvalidArgumentException('Missing the required parameter $page_number when calling getPageTabs'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/lock"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -6358,6 +7221,14 @@ public function getLockWithHttpInfo($account_id, $envelope_id) ); } // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params if ($envelope_id !== null) { $resourcePath = str_replace( "{" . "envelopeId" . "}", @@ -6365,6 +7236,14 @@ public function getLockWithHttpInfo($account_id, $envelope_id) $resourcePath ); } + // path params + if ($page_number !== null) { + $resourcePath = str_replace( + "{" . "pageNumber" . "}", + $this->apiClient->getSerializer()->toPathValue($page_number), + $resourcePath + ); + } // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); @@ -6383,15 +7262,15 @@ public function getLockWithHttpInfo($account_id, $envelope_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\LockInformation', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/lock' + '\DocuSign\eSign\Model\Tabs', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\LockInformation', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Tabs', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\LockInformation', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Tabs', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -6405,43 +7284,51 @@ public function getLockWithHttpInfo($account_id, $envelope_id) } /** - * Operation getNotificationSettings + * Operation getPages * - * Gets envelope notification information. + * Returns document page image(s) based on input. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\Notification + * @return \DocuSign\eSign\Model\PageImages */ - public function getNotificationSettings($account_id, $envelope_id) + public function getPages($account_id, $document_id, $envelope_id, EnvelopesApi\GetPagesOptions $options = null) { - list($response) = $this->getNotificationSettingsWithHttpInfo($account_id, $envelope_id); + list($response) = $this->getPagesWithHttpInfo($account_id, $document_id, $envelope_id, $options); return $response; } /** - * Operation getNotificationSettingsWithHttpInfo + * Operation getPagesWithHttpInfo * - * Gets envelope notification information. + * Returns document page image(s) based on input. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\Notification, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\PageImages, HTTP status code, HTTP response headers (array of strings) */ - public function getNotificationSettingsWithHttpInfo($account_id, $envelope_id) + public function getPagesWithHttpInfo($account_id, $document_id, $envelope_id, EnvelopesApi\GetPagesOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getNotificationSettings'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getPages'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getPages'); } // verify the required parameter 'envelope_id' is set if ($envelope_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getNotificationSettings'); + throw new \InvalidArgumentException('Missing the required parameter $envelope_id when calling getPages'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/notification"; + $resourcePath = "/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -6452,6 +7339,38 @@ public function getNotificationSettingsWithHttpInfo($account_id, $envelope_id) } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getCount() !== null) { + $queryParams['count'] = $this->apiClient->getSerializer()->toQueryValue($options->getCount()); + } + // query params + if ($options->getDpi() !== null) { + $queryParams['dpi'] = $this->apiClient->getSerializer()->toQueryValue($options->getDpi()); + } + // query params + if ($options->getMaxHeight() !== null) { + $queryParams['max_height'] = $this->apiClient->getSerializer()->toQueryValue($options->getMaxHeight()); + } + // query params + if ($options->getMaxWidth() !== null) { + $queryParams['max_width'] = $this->apiClient->getSerializer()->toQueryValue($options->getMaxWidth()); + } + // query params + if ($options->getNocache() !== null) { + $queryParams['nocache'] = $this->apiClient->getSerializer()->toQueryValue($options->getNocache()); + } + // query params + if ($options->getShowChanges() !== null) { + $queryParams['show_changes'] = $this->apiClient->getSerializer()->toQueryValue($options->getShowChanges()); + } + // query params + if ($options->getStartPosition() !== null) { + $queryParams['start_position'] = $this->apiClient->getSerializer()->toQueryValue($options->getStartPosition()); + } + } // path params if ($account_id !== null) { @@ -6462,6 +7381,14 @@ public function getNotificationSettingsWithHttpInfo($account_id, $envelope_id) ); } // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params if ($envelope_id !== null) { $resourcePath = str_replace( "{" . "envelopeId" . "}", @@ -6487,15 +7414,15 @@ public function getNotificationSettingsWithHttpInfo($account_id, $envelope_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\Notification', - '/v2/accounts/{accountId}/envelopes/{envelopeId}/notification' + '\DocuSign\eSign\Model\PageImages', + '/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Notification', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\PageImages', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Notification', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\PageImages', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -7451,13 +8378,12 @@ public function listDocumentFieldsWithHttpInfo($account_id, $document_id, $envel * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response * @return \DocuSign\eSign\Model\EnvelopeDocumentsResult */ - public function listDocuments($account_id, $envelope_id, EnvelopesApi\ListDocumentsOptions $options = null) + public function listDocuments($account_id, $envelope_id) { - list($response) = $this->listDocumentsWithHttpInfo($account_id, $envelope_id, $options); + list($response) = $this->listDocumentsWithHttpInfo($account_id, $envelope_id); return $response; } @@ -7468,11 +8394,10 @@ public function listDocuments($account_id, $envelope_id, EnvelopesApi\ListDocume * * @param string $account_id The external account number (int) or account ID Guid. * @param string $envelope_id The envelopeId Guid of the envelope being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response * @return array of \DocuSign\eSign\Model\EnvelopeDocumentsResult, HTTP status code, HTTP response headers (array of strings) */ - public function listDocumentsWithHttpInfo($account_id, $envelope_id, EnvelopesApi\ListDocumentsOptions $options = null) + public function listDocumentsWithHttpInfo($account_id, $envelope_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { @@ -7494,14 +8419,6 @@ public function listDocumentsWithHttpInfo($account_id, $envelope_id, EnvelopesAp } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getIncludeMetadata() !== null) { - $queryParams['include_metadata'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeMetadata()); - } - } // path params if ($account_id !== null) { @@ -7620,10 +8537,6 @@ public function listRecipientsWithHttpInfo($account_id, $envelope_id, EnvelopesA $queryParams['include_extended'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeExtended()); } // query params - if ($options->getIncludeMetadata() !== null) { - $queryParams['include_metadata'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeMetadata()); - } - // query params if ($options->getIncludeTabs() !== null) { $queryParams['include_tabs'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeTabs()); } @@ -7734,21 +8647,53 @@ public function listStatusWithHttpInfo($account_id, $envelope_ids_request = null { // query params // query params + if ($options->getAcStatus() !== null) { + $queryParams['ac_status'] = $this->apiClient->getSerializer()->toQueryValue($options->getAcStatus()); + } + // query params + if ($options->getBlock() !== null) { + $queryParams['block'] = $this->apiClient->getSerializer()->toQueryValue($options->getBlock()); + } + // query params + if ($options->getCount() !== null) { + $queryParams['count'] = $this->apiClient->getSerializer()->toQueryValue($options->getCount()); + } + // query params if ($options->getEmail() !== null) { $queryParams['email'] = $this->apiClient->getSerializer()->toQueryValue($options->getEmail()); } // query params + if ($options->getEnvelopeIds() !== null) { + $queryParams['envelope_ids'] = $this->apiClient->getSerializer()->toQueryValue($options->getEnvelopeIds()); + } + // query params if ($options->getFromDate() !== null) { $queryParams['from_date'] = $this->apiClient->getSerializer()->toQueryValue($options->getFromDate()); } // query params + if ($options->getFromToStatus() !== null) { + $queryParams['from_to_status'] = $this->apiClient->getSerializer()->toQueryValue($options->getFromToStatus()); + } + // query params if ($options->getStartPosition() !== null) { $queryParams['start_position'] = $this->apiClient->getSerializer()->toQueryValue($options->getStartPosition()); } // query params + if ($options->getStatus() !== null) { + $queryParams['status'] = $this->apiClient->getSerializer()->toQueryValue($options->getStatus()); + } + // query params if ($options->getToDate() !== null) { $queryParams['to_date'] = $this->apiClient->getSerializer()->toQueryValue($options->getToDate()); } + // query params + if ($options->getTransactionIds() !== null) { + $queryParams['transaction_ids'] = $this->apiClient->getSerializer()->toQueryValue($options->getTransactionIds()); + } + // query params + if ($options->getUserName() !== null) { + $queryParams['user_name'] = $this->apiClient->getSerializer()->toQueryValue($options->getUserName()); + } } // path params @@ -7875,18 +8820,6 @@ public function listStatusChangesWithHttpInfo($account_id, EnvelopesApi\ListStat $queryParams['envelope_ids'] = $this->apiClient->getSerializer()->toQueryValue($options->getEnvelopeIds()); } // query params - if ($options->getExclude() !== null) { - $queryParams['exclude'] = $this->apiClient->getSerializer()->toQueryValue($options->getExclude()); - } - // query params - if ($options->getFolderIds() !== null) { - $queryParams['folder_ids'] = $this->apiClient->getSerializer()->toQueryValue($options->getFolderIds()); - } - // query params - if ($options->getFolderTypes() !== null) { - $queryParams['folder_types'] = $this->apiClient->getSerializer()->toQueryValue($options->getFolderTypes()); - } - // query params if ($options->getFromDate() !== null) { $queryParams['from_date'] = $this->apiClient->getSerializer()->toQueryValue($options->getFromDate()); } @@ -7895,30 +8828,6 @@ public function listStatusChangesWithHttpInfo($account_id, EnvelopesApi\ListStat $queryParams['from_to_status'] = $this->apiClient->getSerializer()->toQueryValue($options->getFromToStatus()); } // query params - if ($options->getInclude() !== null) { - $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); - } - // query params - if ($options->getIntersectingFolderIds() !== null) { - $queryParams['intersecting_folder_ids'] = $this->apiClient->getSerializer()->toQueryValue($options->getIntersectingFolderIds()); - } - // query params - if ($options->getOrder() !== null) { - $queryParams['order'] = $this->apiClient->getSerializer()->toQueryValue($options->getOrder()); - } - // query params - if ($options->getOrderBy() !== null) { - $queryParams['order_by'] = $this->apiClient->getSerializer()->toQueryValue($options->getOrderBy()); - } - // query params - if ($options->getPowerformids() !== null) { - $queryParams['powerformids'] = $this->apiClient->getSerializer()->toQueryValue($options->getPowerformids()); - } - // query params - if ($options->getSearchText() !== null) { - $queryParams['search_text'] = $this->apiClient->getSerializer()->toQueryValue($options->getSearchText()); - } - // query params if ($options->getStartPosition() !== null) { $queryParams['start_position'] = $this->apiClient->getSerializer()->toQueryValue($options->getStartPosition()); } @@ -7935,14 +8844,6 @@ public function listStatusChangesWithHttpInfo($account_id, EnvelopesApi\ListStat $queryParams['transaction_ids'] = $this->apiClient->getSerializer()->toQueryValue($options->getTransactionIds()); } // query params - if ($options->getUserFilter() !== null) { - $queryParams['user_filter'] = $this->apiClient->getSerializer()->toQueryValue($options->getUserFilter()); - } - // query params - if ($options->getUserId() !== null) { - $queryParams['user_id'] = $this->apiClient->getSerializer()->toQueryValue($options->getUserId()); - } - // query params if ($options->getUserName() !== null) { $queryParams['user_name'] = $this->apiClient->getSerializer()->toQueryValue($options->getUserName()); } @@ -9523,6 +10424,10 @@ public function updateDocumentsWithHttpInfo($account_id, $envelope_id, $envelope if ($options->getApplyDocumentFields() !== null) { $queryParams['apply_document_fields'] = $this->apiClient->getSerializer()->toQueryValue($options->getApplyDocumentFields()); } + // query params + if ($options->getPersistTabs() !== null) { + $queryParams['persist_tabs'] = $this->apiClient->getSerializer()->toQueryValue($options->getPersistTabs()); + } } // path params @@ -10095,7 +11000,7 @@ public function updateRecipientInitialsImageWithHttpInfo($account_id, $envelope_ if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['image/gif']); // path params @@ -10209,7 +11114,7 @@ public function updateRecipientSignatureImageWithHttpInfo($account_id, $envelope if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['image/gif']); // path params @@ -10327,6 +11232,10 @@ public function updateRecipientsWithHttpInfo($account_id, $envelope_id, $recipie { // query params // query params + if ($options->getOfflineSigning() !== null) { + $queryParams['offline_signing'] = $this->apiClient->getSerializer()->toQueryValue($options->getOfflineSigning()); + } + // query params if ($options->getResendEnvelope() !== null) { $queryParams['resend_envelope'] = $this->apiClient->getSerializer()->toQueryValue($options->getResendEnvelope()); } diff --git a/src/Api/FoldersApi.php b/src/Api/FoldersApi.php index 15e1bc35..d2b88e65 100644 --- a/src/Api/FoldersApi.php +++ b/src/Api/FoldersApi.php @@ -55,31 +55,6 @@ public function setInclude($include) $this->include = $include; return $this; } - /** - * $include_items - * @var string - */ - protected $include_items; - - /** - * Gets include_items - * @return string - */ - public function getIncludeItems() - { - return $this->include_items; - } - - /** - * Sets include_items - * @param string $include_items - * @return $this - */ - public function setIncludeItems($include_items) - { - $this->include_items = $include_items; - return $this; - } /** * $start_position * @var string @@ -183,31 +158,6 @@ public function setFromDate($from_date) $this->from_date = $from_date; return $this; } - /** - * $include_items - * @var string - */ - protected $include_items; - - /** - * Gets include_items - * @return string - */ - public function getIncludeItems() - { - return $this->include_items; - } - - /** - * Sets include_items - * @param string $include_items - * @return $this - */ - public function setIncludeItems($include_items) - { - $this->include_items = $include_items; - return $this; - } /** * $owner_email The email of the folder owner. * @var string @@ -566,7 +516,7 @@ public function setToDate($to_date) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -584,16 +534,16 @@ class FoldersApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -605,7 +555,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -615,11 +565,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return FoldersApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; @@ -677,10 +627,6 @@ public function callListWithHttpInfo($account_id, FoldersApi\ListOptions $option $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); } // query params - if ($options->getIncludeItems() !== null) { - $queryParams['include_items'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeItems()); - } - // query params if ($options->getStartPosition() !== null) { $queryParams['start_position'] = $this->apiClient->getSerializer()->toQueryValue($options->getStartPosition()); } @@ -799,10 +745,6 @@ public function listItemsWithHttpInfo($account_id, $folder_id, FoldersApi\ListIt $queryParams['from_date'] = $this->apiClient->getSerializer()->toQueryValue($options->getFromDate()); } // query params - if ($options->getIncludeItems() !== null) { - $queryParams['include_items'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeItems()); - } - // query params if ($options->getOwnerEmail() !== null) { $queryParams['owner_email'] = $this->apiClient->getSerializer()->toQueryValue($options->getOwnerEmail()); } @@ -892,7 +834,7 @@ public function listItemsWithHttpInfo($account_id, $folder_id, FoldersApi\ListIt * @param string $folder_id The ID of the folder being accessed. * @param \DocuSign\eSign\Model\FoldersRequest $folders_request (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\FoldersResponse + * @return void */ public function moveEnvelopes($account_id, $folder_id, $folders_request = null) { @@ -909,7 +851,7 @@ public function moveEnvelopes($account_id, $folder_id, $folders_request = null) * @param string $folder_id The ID of the folder being accessed. * @param \DocuSign\eSign\Model\FoldersRequest $folders_request (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\FoldersResponse, HTTP status code, HTTP response headers (array of strings) + * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function moveEnvelopesWithHttpInfo($account_id, $folder_id, $folders_request = null) { @@ -973,17 +915,13 @@ public function moveEnvelopesWithHttpInfo($account_id, $folder_id, $folders_requ $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\FoldersResponse', + null, '/v2/accounts/{accountId}/folders/{folderId}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\FoldersResponse', $httpHeader), $statusCode, $httpHeader]; + return [null, $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\FoldersResponse', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; case 400: $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); $e->setResponseObject($data); diff --git a/src/Api/GroupsApi.php b/src/Api/GroupsApi.php index e3b0f921..54589129 100644 --- a/src/Api/GroupsApi.php +++ b/src/Api/GroupsApi.php @@ -108,31 +108,6 @@ public function setCount($count) $this->count = $count; return $this; } - /** - * $group_name Filters the groups returned by the group name or a sub-string of group name. - * @var string - */ - protected $group_name; - - /** - * Gets group_name - * @return string - */ - public function getGroupName() - { - return $this->group_name; - } - - /** - * Sets group_name - * @param string $group_name Filters the groups returned by the group name or a sub-string of group name. - * @return $this - */ - public function setGroupName($group_name) - { - $this->group_name = $group_name; - return $this; - } /** * $group_type * @var string @@ -213,7 +188,7 @@ public function setStartPosition($start_position) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -231,16 +206,16 @@ class GroupsApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -252,7 +227,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -262,11 +237,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return GroupsApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; @@ -962,10 +937,6 @@ public function listGroupsWithHttpInfo($account_id, GroupsApi\ListGroupsOptions $queryParams['count'] = $this->apiClient->getSerializer()->toQueryValue($options->getCount()); } // query params - if ($options->getGroupName() !== null) { - $queryParams['group_name'] = $this->apiClient->getSerializer()->toQueryValue($options->getGroupName()); - } - // query params if ($options->getGroupType() !== null) { $queryParams['group_type'] = $this->apiClient->getSerializer()->toQueryValue($options->getGroupType()); } diff --git a/src/Api/NotaryApi.php b/src/Api/NotaryApi.php new file mode 100644 index 00000000..41f51b0f --- /dev/null +++ b/src/Api/NotaryApi.php @@ -0,0 +1,265 @@ +count; + } + + /** + * Sets count + * @param string $count + * @return $this + */ + public function setCount($count) + { + $this->count = $count; + return $this; + } + /** + * $search_text + * @var string + */ + protected $search_text; + + /** + * Gets search_text + * @return string + */ + public function getSearchText() + { + return $this->search_text; + } + + /** + * Sets search_text + * @param string $search_text + * @return $this + */ + public function setSearchText($search_text) + { + $this->search_text = $search_text; + return $this; + } + /** + * $start_position + * @var string + */ + protected $start_position; + + /** + * Gets start_position + * @return string + */ + public function getStartPosition() + { + return $this->start_position; + } + + /** + * Sets start_position + * @param string $start_position + * @return $this + */ + public function setStartPosition($start_position) + { + $this->start_position = $start_position; + return $this; + } +} + + +namespace DocuSign\eSign\Api; + +use \DocuSign\eSign\Client\ApiClient; +use \DocuSign\eSign\ApiException; +use \DocuSign\eSign\Configuration; +use \DocuSign\eSign\ObjectSerializer; + +/** + * NotaryApi Class Doc Comment + * + * @category Class + * @package DocuSign\eSign + * @author Swagger Codegen team + * @link https://github.com/swagger-api/swagger-codegen + */ +class NotaryApi +{ + /** + * API Client + * + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient + */ + protected $apiClient; + + /** + * Constructor + * + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use + */ + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) + { + if ($apiClient === null) { + $apiClient = new ApiClient(); + } + + $this->apiClient = $apiClient; + } + + /** + * Get API client + * + * @return \DocuSign\eSign\Client\ApiClient get the API client + */ + public function getApiClient() + { + return $this->apiClient; + } + + /** + * Set the API client + * + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client + * + * @return NotaryApi + */ + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) + { + $this->apiClient = $apiClient; + return $this; + } + + /** + * Operation listNotaryJournals + * + * Get notary jurisdictions for a user + * + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\NotaryJournalList + */ + public function listNotaryJournals(NotaryApi\ListNotaryJournalsOptions $options = null) + { + list($response) = $this->listNotaryJournalsWithHttpInfo($options); + return $response; + } + + /** + * Operation listNotaryJournalsWithHttpInfo + * + * Get notary jurisdictions for a user + * + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\NotaryJournalList, HTTP status code, HTTP response headers (array of strings) + */ + public function listNotaryJournalsWithHttpInfo(NotaryApi\ListNotaryJournalsOptions $options = null) + { + // parse inputs + $resourcePath = "/v2/current_user/notary/journals"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getCount() !== null) { + $queryParams['count'] = $this->apiClient->getSerializer()->toQueryValue($options->getCount()); + } + // query params + if ($options->getSearchText() !== null) { + $queryParams['search_text'] = $this->apiClient->getSerializer()->toQueryValue($options->getSearchText()); + } + // query params + if ($options->getStartPosition() !== null) { + $queryParams['start_position'] = $this->apiClient->getSerializer()->toQueryValue($options->getStartPosition()); + } + } + + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\NotaryJournalList', + '/v2/current_user/notary/journals' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\NotaryJournalList', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\NotaryJournalList', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } +} diff --git a/src/Api/PowerFormsApi.php b/src/Api/PowerFormsApi.php index b57f1118..3bbff279 100644 --- a/src/Api/PowerFormsApi.php +++ b/src/Api/PowerFormsApi.php @@ -30,6 +30,31 @@ class GetPowerFormDataOptions { + /** + * $data_layout + * @var string + */ + protected $data_layout; + + /** + * Gets data_layout + * @return string + */ + public function getDataLayout() + { + return $this->data_layout; + } + + /** + * Sets data_layout + * @param string $data_layout + * @return $this + */ + public function setDataLayout($data_layout) + { + $this->data_layout = $data_layout; + return $this; + } /** * $from_date * @var string @@ -216,7 +241,7 @@ public function setToDate($to_date) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -234,16 +259,16 @@ class PowerFormsApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -255,7 +280,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -265,11 +290,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return PowerFormsApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; @@ -727,6 +752,10 @@ public function getPowerFormDataWithHttpInfo($account_id, $power_form_id, PowerF { // query params // query params + if ($options->getDataLayout() !== null) { + $queryParams['data_layout'] = $this->apiClient->getSerializer()->toQueryValue($options->getDataLayout()); + } + // query params if ($options->getFromDate() !== null) { $queryParams['from_date'] = $this->apiClient->getSerializer()->toQueryValue($options->getFromDate()); } diff --git a/src/Api/SigningGroupsApi.php b/src/Api/SigningGroupsApi.php index 478ea131..5bf89268 100644 --- a/src/Api/SigningGroupsApi.php +++ b/src/Api/SigningGroupsApi.php @@ -85,7 +85,7 @@ public function setIncludeUsers($include_users) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -103,16 +103,16 @@ class SigningGroupsApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -124,7 +124,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -134,11 +134,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return SigningGroupsApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; diff --git a/src/Api/TemplatesApi.php b/src/Api/TemplatesApi.php index 87b980d1..d0af67b8 100644 --- a/src/Api/TemplatesApi.php +++ b/src/Api/TemplatesApi.php @@ -240,6 +240,212 @@ public function setShowChanges($show_changes) return $this; } } +class GetDocumentTabsOptions +{ + /** + * $page_numbers + * @var string + */ + protected $page_numbers; + + /** + * Gets page_numbers + * @return string + */ + public function getPageNumbers() + { + return $this->page_numbers; + } + + /** + * Sets page_numbers + * @param string $page_numbers + * @return $this + */ + public function setPageNumbers($page_numbers) + { + $this->page_numbers = $page_numbers; + return $this; + } +} +class GetPagesOptions +{ + /** + * $count + * @var string + */ + protected $count; + + /** + * Gets count + * @return string + */ + public function getCount() + { + return $this->count; + } + + /** + * Sets count + * @param string $count + * @return $this + */ + public function setCount($count) + { + $this->count = $count; + return $this; + } + /** + * $dpi + * @var string + */ + protected $dpi; + + /** + * Gets dpi + * @return string + */ + public function getDpi() + { + return $this->dpi; + } + + /** + * Sets dpi + * @param string $dpi + * @return $this + */ + public function setDpi($dpi) + { + $this->dpi = $dpi; + return $this; + } + /** + * $max_height + * @var string + */ + protected $max_height; + + /** + * Gets max_height + * @return string + */ + public function getMaxHeight() + { + return $this->max_height; + } + + /** + * Sets max_height + * @param string $max_height + * @return $this + */ + public function setMaxHeight($max_height) + { + $this->max_height = $max_height; + return $this; + } + /** + * $max_width + * @var string + */ + protected $max_width; + + /** + * Gets max_width + * @return string + */ + public function getMaxWidth() + { + return $this->max_width; + } + + /** + * Sets max_width + * @param string $max_width + * @return $this + */ + public function setMaxWidth($max_width) + { + $this->max_width = $max_width; + return $this; + } + /** + * $nocache + * @var string + */ + protected $nocache; + + /** + * Gets nocache + * @return string + */ + public function getNocache() + { + return $this->nocache; + } + + /** + * Sets nocache + * @param string $nocache + * @return $this + */ + public function setNocache($nocache) + { + $this->nocache = $nocache; + return $this; + } + /** + * $show_changes + * @var string + */ + protected $show_changes; + + /** + * Gets show_changes + * @return string + */ + public function getShowChanges() + { + return $this->show_changes; + } + + /** + * Sets show_changes + * @param string $show_changes + * @return $this + */ + public function setShowChanges($show_changes) + { + $this->show_changes = $show_changes; + return $this; + } + /** + * $start_position + * @var string + */ + protected $start_position; + + /** + * Gets start_position + * @return string + */ + public function getStartPosition() + { + return $this->start_position; + } + + /** + * Sets start_position + * @param string $start_position + * @return $this + */ + public function setStartPosition($start_position) + { + $this->start_position = $start_position; + return $this; + } +} class ListBulkRecipientsOptions { /** @@ -551,6 +757,56 @@ public function setInclude($include) $this->include = $include; return $this; } + /** + * $modified_from_date + * @var string + */ + protected $modified_from_date; + + /** + * Gets modified_from_date + * @return string + */ + public function getModifiedFromDate() + { + return $this->modified_from_date; + } + + /** + * Sets modified_from_date + * @param string $modified_from_date + * @return $this + */ + public function setModifiedFromDate($modified_from_date) + { + $this->modified_from_date = $modified_from_date; + return $this; + } + /** + * $modified_to_date + * @var string + */ + protected $modified_to_date; + + /** + * Gets modified_to_date + * @return string + */ + public function getModifiedToDate() + { + return $this->modified_to_date; + } + + /** + * Sets modified_to_date + * @param string $modified_to_date + * @return $this + */ + public function setModifiedToDate($modified_to_date) + { + $this->modified_to_date = $modified_to_date; + return $this; + } /** * $order Sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a) * @var string @@ -626,31 +882,6 @@ public function setSearchText($search_text) $this->search_text = $search_text; return $this; } - /** - * $shared - * @var string - */ - protected $shared; - - /** - * Gets shared - * @return string - */ - public function getShared() - { - return $this->shared; - } - - /** - * Sets shared - * @param string $shared - * @return $this - */ - public function setShared($shared) - { - $this->shared = $shared; - return $this; - } /** * $shared_by_me If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected. * @var string @@ -801,6 +1032,31 @@ public function setUserFilter($user_filter) $this->user_filter = $user_filter; return $this; } + /** + * $user_id + * @var string + */ + protected $user_id; + + /** + * Gets user_id + * @return string + */ + public function getUserId() + { + return $this->user_id; + } + + /** + * Sets user_id + * @param string $user_id + * @return $this + */ + public function setUserId($user_id) + { + $this->user_id = $user_id; + return $this; + } } class UpdateDocumentOptions { @@ -882,22 +1138,47 @@ public function setApplyDocumentFields($apply_document_fields) $this->apply_document_fields = $apply_document_fields; return $this; } -} -class UpdateRecipientsOptions -{ /** - * $resend_envelope + * $persist_tabs * @var string */ - protected $resend_envelope; + protected $persist_tabs; /** - * Gets resend_envelope + * Gets persist_tabs * @return string */ - public function getResendEnvelope() + public function getPersistTabs() { - return $this->resend_envelope; + return $this->persist_tabs; + } + + /** + * Sets persist_tabs + * @param string $persist_tabs + * @return $this + */ + public function setPersistTabs($persist_tabs) + { + $this->persist_tabs = $persist_tabs; + return $this; + } +} +class UpdateRecipientsOptions +{ + /** + * $resend_envelope + * @var string + */ + protected $resend_envelope; + + /** + * Gets resend_envelope + * @return string + */ + public function getResendEnvelope() + { + return $this->resend_envelope; } /** @@ -915,7 +1196,7 @@ public function setResendEnvelope($resend_envelope) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -933,16 +1214,16 @@ class TemplatesApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -954,7 +1235,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -964,11 +1245,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return TemplatesApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; @@ -1775,6 +2056,242 @@ public function createTemplateWithHttpInfo($account_id, $envelope_template = nul } } + /** + * Operation createTemplateDocumentResponsiveHtmlPreview + * + * Post Responsive HTML Preview for a document in a template. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $template_id The ID of the template being accessed. + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $document_html_definition (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\DocumentHtmlDefinitions + */ + public function createTemplateDocumentResponsiveHtmlPreview($account_id, $document_id, $template_id, $document_html_definition = null) + { + list($response) = $this->createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo($account_id, $document_id, $template_id, $document_html_definition); + return $response; + } + + /** + * Operation createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo + * + * Post Responsive HTML Preview for a document in a template. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $template_id The ID of the template being accessed. + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $document_html_definition (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\DocumentHtmlDefinitions, HTTP status code, HTTP response headers (array of strings) + */ + public function createTemplateDocumentResponsiveHtmlPreviewWithHttpInfo($account_id, $document_id, $template_id, $document_html_definition = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createTemplateDocumentResponsiveHtmlPreview'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling createTemplateDocumentResponsiveHtmlPreview'); + } + // verify the required parameter 'template_id' is set + if ($template_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling createTemplateDocumentResponsiveHtmlPreview'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params + if ($template_id !== null) { + $resourcePath = str_replace( + "{" . "templateId" . "}", + $this->apiClient->getSerializer()->toPathValue($template_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + // body params + $_tempBody = null; + if (isset($document_html_definition)) { + $_tempBody = $document_html_definition; + } + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'POST', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\DocumentHtmlDefinitions', + '/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\DocumentHtmlDefinitions', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 201: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\DocumentHtmlDefinitions', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation createTemplateResponsiveHtmlPreview + * + * Get Responsive HTML Preview for all documents in a template. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $template_id The ID of the template being accessed. + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $document_html_definition (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\DocumentHtmlDefinitions + */ + public function createTemplateResponsiveHtmlPreview($account_id, $template_id, $document_html_definition = null) + { + list($response) = $this->createTemplateResponsiveHtmlPreviewWithHttpInfo($account_id, $template_id, $document_html_definition); + return $response; + } + + /** + * Operation createTemplateResponsiveHtmlPreviewWithHttpInfo + * + * Get Responsive HTML Preview for all documents in a template. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $template_id The ID of the template being accessed. + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $document_html_definition (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\DocumentHtmlDefinitions, HTTP status code, HTTP response headers (array of strings) + */ + public function createTemplateResponsiveHtmlPreviewWithHttpInfo($account_id, $template_id, $document_html_definition = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling createTemplateResponsiveHtmlPreview'); + } + // verify the required parameter 'template_id' is set + if ($template_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling createTemplateResponsiveHtmlPreview'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/responsive_html_preview"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($template_id !== null) { + $resourcePath = str_replace( + "{" . "templateId" . "}", + $this->apiClient->getSerializer()->toPathValue($template_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + // body params + $_tempBody = null; + if (isset($document_html_definition)) { + $_tempBody = $document_html_definition; + } + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'POST', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\DocumentHtmlDefinitions', + '/v2/accounts/{accountId}/templates/{templateId}/responsive_html_preview' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\DocumentHtmlDefinitions', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 201: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\DocumentHtmlDefinitions', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + /** * Operation deleteBulkRecipients * @@ -2826,15 +3343,668 @@ public function deleteRecipientsWithHttpInfo($account_id, $template_id, $templat $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\Recipients', - '/v2/accounts/{accountId}/templates/{templateId}/recipients' + '\DocuSign\eSign\Model\Recipients', + '/v2/accounts/{accountId}/templates/{templateId}/recipients' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Recipients', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Recipients', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation deleteTabs + * + * Deletes the tabs associated with a recipient in a template. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $recipient_id The ID of the recipient being accessed. + * @param string $template_id The ID of the template being accessed. + * @param \DocuSign\eSign\Model\TemplateTabs $template_tabs (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\Tabs + */ + public function deleteTabs($account_id, $recipient_id, $template_id, $template_tabs = null) + { + list($response) = $this->deleteTabsWithHttpInfo($account_id, $recipient_id, $template_id, $template_tabs); + return $response; + } + + /** + * Operation deleteTabsWithHttpInfo + * + * Deletes the tabs associated with a recipient in a template. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $recipient_id The ID of the recipient being accessed. + * @param string $template_id The ID of the template being accessed. + * @param \DocuSign\eSign\Model\TemplateTabs $template_tabs (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings) + */ + public function deleteTabsWithHttpInfo($account_id, $recipient_id, $template_id, $template_tabs = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling deleteTabs'); + } + // verify the required parameter 'recipient_id' is set + if ($recipient_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $recipient_id when calling deleteTabs'); + } + // verify the required parameter 'template_id' is set + if ($template_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling deleteTabs'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($recipient_id !== null) { + $resourcePath = str_replace( + "{" . "recipientId" . "}", + $this->apiClient->getSerializer()->toPathValue($recipient_id), + $resourcePath + ); + } + // path params + if ($template_id !== null) { + $resourcePath = str_replace( + "{" . "templateId" . "}", + $this->apiClient->getSerializer()->toPathValue($template_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + // body params + $_tempBody = null; + if (isset($template_tabs)) { + $_tempBody = $template_tabs; + } + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'DELETE', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\Tabs', + '/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Tabs', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Tabs', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation get + * + * Gets a list of templates for a specified account. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $template_id The ID of the template being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\EnvelopeTemplate + */ + public function get($account_id, $template_id, TemplatesApi\GetOptions $options = null) + { + list($response) = $this->getWithHttpInfo($account_id, $template_id, $options); + return $response; + } + + /** + * Operation getWithHttpInfo + * + * Gets a list of templates for a specified account. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $template_id The ID of the template being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\EnvelopeTemplate, HTTP status code, HTTP response headers (array of strings) + */ + public function getWithHttpInfo($account_id, $template_id, TemplatesApi\GetOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling get'); + } + // verify the required parameter 'template_id' is set + if ($template_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling get'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getInclude() !== null) { + $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($template_id !== null) { + $resourcePath = str_replace( + "{" . "templateId" . "}", + $this->apiClient->getSerializer()->toPathValue($template_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\EnvelopeTemplate', + '/v2/accounts/{accountId}/templates/{templateId}' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\EnvelopeTemplate', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\EnvelopeTemplate', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation getDocument + * + * Gets PDF documents from a template. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $template_id The ID of the template being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \SplFileObject + */ + public function getDocument($account_id, $document_id, $template_id, TemplatesApi\GetDocumentOptions $options = null) + { + list($response) = $this->getDocumentWithHttpInfo($account_id, $document_id, $template_id, $options); + return $response; + } + + /** + * Operation getDocumentWithHttpInfo + * + * Gets PDF documents from a template. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $template_id The ID of the template being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) + */ + public function getDocumentWithHttpInfo($account_id, $document_id, $template_id, TemplatesApi\GetDocumentOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getDocument'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getDocument'); + } + // verify the required parameter 'template_id' is set + if ($template_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getDocument'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/pdf']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getEncrypt() !== null) { + $queryParams['encrypt'] = $this->apiClient->getSerializer()->toQueryValue($options->getEncrypt()); + } + // query params + if ($options->getShowChanges() !== null) { + $queryParams['show_changes'] = $this->apiClient->getSerializer()->toQueryValue($options->getShowChanges()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params + if ($template_id !== null) { + $resourcePath = str_replace( + "{" . "templateId" . "}", + $this->apiClient->getSerializer()->toPathValue($template_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\SplFileObject', + '/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\SplFileObject', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation getDocumentPageImage + * + * Gets a page image from a template for display. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $page_number The page number being accessed. + * @param string $template_id The ID of the template being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \SplFileObject + */ + public function getDocumentPageImage($account_id, $document_id, $page_number, $template_id, TemplatesApi\GetDocumentPageImageOptions $options = null) + { + list($response) = $this->getDocumentPageImageWithHttpInfo($account_id, $document_id, $page_number, $template_id, $options); + return $response; + } + + /** + * Operation getDocumentPageImageWithHttpInfo + * + * Gets a page image from a template for display. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $page_number The page number being accessed. + * @param string $template_id The ID of the template being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) + */ + public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $page_number, $template_id, TemplatesApi\GetDocumentPageImageOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getDocumentPageImage'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getDocumentPageImage'); + } + // verify the required parameter 'page_number' is set + if ($page_number === null) { + throw new \InvalidArgumentException('Missing the required parameter $page_number when calling getDocumentPageImage'); + } + // verify the required parameter 'template_id' is set + if ($template_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getDocumentPageImage'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['image/png']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getDpi() !== null) { + $queryParams['dpi'] = $this->apiClient->getSerializer()->toQueryValue($options->getDpi()); + } + // query params + if ($options->getMaxHeight() !== null) { + $queryParams['max_height'] = $this->apiClient->getSerializer()->toQueryValue($options->getMaxHeight()); + } + // query params + if ($options->getMaxWidth() !== null) { + $queryParams['max_width'] = $this->apiClient->getSerializer()->toQueryValue($options->getMaxWidth()); + } + // query params + if ($options->getShowChanges() !== null) { + $queryParams['show_changes'] = $this->apiClient->getSerializer()->toQueryValue($options->getShowChanges()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params + if ($page_number !== null) { + $resourcePath = str_replace( + "{" . "pageNumber" . "}", + $this->apiClient->getSerializer()->toPathValue($page_number), + $resourcePath + ); + } + // path params + if ($template_id !== null) { + $resourcePath = str_replace( + "{" . "templateId" . "}", + $this->apiClient->getSerializer()->toPathValue($template_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\SplFileObject', + '/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\SplFileObject', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + + /** + * Operation getDocumentTabs + * + * Returns tabs on the document. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $template_id The ID of the template being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\Tabs + */ + public function getDocumentTabs($account_id, $document_id, $template_id, TemplatesApi\GetDocumentTabsOptions $options = null) + { + list($response) = $this->getDocumentTabsWithHttpInfo($account_id, $document_id, $template_id, $options); + return $response; + } + + /** + * Operation getDocumentTabsWithHttpInfo + * + * Returns tabs on the document. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. + * @param string $template_id The ID of the template being accessed. + * @param $options Options for modifying the behavior of the function. (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings) + */ + public function getDocumentTabsWithHttpInfo($account_id, $document_id, $template_id, TemplatesApi\GetDocumentTabsOptions $options = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getDocumentTabs'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getDocumentTabs'); + } + // verify the required parameter 'template_id' is set + if ($template_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getDocumentTabs'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + if ($options != null) + { + // query params + // query params + if ($options->getPageNumbers() !== null) { + $queryParams['page_numbers'] = $this->apiClient->getSerializer()->toQueryValue($options->getPageNumbers()); + } + } + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params + if ($template_id !== null) { + $resourcePath = str_replace( + "{" . "templateId" . "}", + $this->apiClient->getSerializer()->toPathValue($template_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\Tabs', + '/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Recipients', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Tabs', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Recipients', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Tabs', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -2848,51 +4018,43 @@ public function deleteRecipientsWithHttpInfo($account_id, $template_id, $templat } /** - * Operation deleteTabs + * Operation getLock * - * Deletes the tabs associated with a recipient in a template. + * Gets template lock information. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $recipient_id The ID of the recipient being accessed. * @param string $template_id The ID of the template being accessed. - * @param \DocuSign\eSign\Model\TemplateTabs $template_tabs (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\Tabs + * @return \DocuSign\eSign\Model\LockInformation */ - public function deleteTabs($account_id, $recipient_id, $template_id, $template_tabs = null) + public function getLock($account_id, $template_id) { - list($response) = $this->deleteTabsWithHttpInfo($account_id, $recipient_id, $template_id, $template_tabs); + list($response) = $this->getLockWithHttpInfo($account_id, $template_id); return $response; } /** - * Operation deleteTabsWithHttpInfo + * Operation getLockWithHttpInfo * - * Deletes the tabs associated with a recipient in a template. + * Gets template lock information. * * @param string $account_id The external account number (int) or account ID Guid. - * @param string $recipient_id The ID of the recipient being accessed. * @param string $template_id The ID of the template being accessed. - * @param \DocuSign\eSign\Model\TemplateTabs $template_tabs (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings) */ - public function deleteTabsWithHttpInfo($account_id, $recipient_id, $template_id, $template_tabs = null) + public function getLockWithHttpInfo($account_id, $template_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling deleteTabs'); - } - // verify the required parameter 'recipient_id' is set - if ($recipient_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $recipient_id when calling deleteTabs'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getLock'); } // verify the required parameter 'template_id' is set if ($template_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $template_id when calling deleteTabs'); + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getLock'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs"; + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/lock"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -2913,14 +4075,6 @@ public function deleteTabsWithHttpInfo($account_id, $recipient_id, $template_id, ); } // path params - if ($recipient_id !== null) { - $resourcePath = str_replace( - "{" . "recipientId" . "}", - $this->apiClient->getSerializer()->toPathValue($recipient_id), - $resourcePath - ); - } - // path params if ($template_id !== null) { $resourcePath = str_replace( "{" . "templateId" . "}", @@ -2931,12 +4085,7 @@ public function deleteTabsWithHttpInfo($account_id, $recipient_id, $template_id, // default format to json $resourcePath = str_replace("{format}", "json", $resourcePath); - // body params - $_tempBody = null; - if (isset($template_tabs)) { - $_tempBody = $template_tabs; - } - + // for model (json/xml) if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present @@ -2947,19 +4096,19 @@ public function deleteTabsWithHttpInfo($account_id, $recipient_id, $template_id, try { list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( $resourcePath, - 'DELETE', + 'GET', $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\Tabs', - '/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs' + '\DocuSign\eSign\Model\LockInformation', + '/v2/accounts/{accountId}/templates/{templateId}/lock' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Tabs', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\LockInformation', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Tabs', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\LockInformation', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -2973,45 +4122,43 @@ public function deleteTabsWithHttpInfo($account_id, $recipient_id, $template_id, } /** - * Operation get + * Operation getNotificationSettings * - * Gets a list of templates for a specified account. + * Gets template notification information. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $template_id The ID of the template being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\EnvelopeTemplate + * @return \DocuSign\eSign\Model\Notification */ - public function get($account_id, $template_id, TemplatesApi\GetOptions $options = null) + public function getNotificationSettings($account_id, $template_id) { - list($response) = $this->getWithHttpInfo($account_id, $template_id, $options); + list($response) = $this->getNotificationSettingsWithHttpInfo($account_id, $template_id); return $response; } /** - * Operation getWithHttpInfo + * Operation getNotificationSettingsWithHttpInfo * - * Gets a list of templates for a specified account. + * Gets template notification information. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $template_id The ID of the template being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\EnvelopeTemplate, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\Notification, HTTP status code, HTTP response headers (array of strings) */ - public function getWithHttpInfo($account_id, $template_id, TemplatesApi\GetOptions $options = null) + public function getNotificationSettingsWithHttpInfo($account_id, $template_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling get'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getNotificationSettings'); } // verify the required parameter 'template_id' is set if ($template_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $template_id when calling get'); + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getNotificationSettings'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}"; + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/notification"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3022,14 +4169,6 @@ public function getWithHttpInfo($account_id, $template_id, TemplatesApi\GetOptio } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getInclude() !== null) { - $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); - } - } // path params if ($account_id !== null) { @@ -3065,15 +4204,15 @@ public function getWithHttpInfo($account_id, $template_id, TemplatesApi\GetOptio $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\EnvelopeTemplate', - '/v2/accounts/{accountId}/templates/{templateId}' + '\DocuSign\eSign\Model\Notification', + '/v2/accounts/{accountId}/templates/{templateId}/notification' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\EnvelopeTemplate', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Notification', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\EnvelopeTemplate', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Notification', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3087,73 +4226,65 @@ public function getWithHttpInfo($account_id, $template_id, TemplatesApi\GetOptio } /** - * Operation getDocument + * Operation getPageTabs * - * Gets PDF documents from a template. + * Returns tabs on the specified page. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $document_id The ID of the document being accessed. + * @param string $page_number The page number being accessed. * @param string $template_id The ID of the template being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \SplFileObject + * @return \DocuSign\eSign\Model\Tabs */ - public function getDocument($account_id, $document_id, $template_id, TemplatesApi\GetDocumentOptions $options = null) + public function getPageTabs($account_id, $document_id, $page_number, $template_id) { - list($response) = $this->getDocumentWithHttpInfo($account_id, $document_id, $template_id, $options); + list($response) = $this->getPageTabsWithHttpInfo($account_id, $document_id, $page_number, $template_id); return $response; } /** - * Operation getDocumentWithHttpInfo + * Operation getPageTabsWithHttpInfo * - * Gets PDF documents from a template. + * Returns tabs on the specified page. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $document_id The ID of the document being accessed. + * @param string $page_number The page number being accessed. * @param string $template_id The ID of the template being accessed. - * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\Tabs, HTTP status code, HTTP response headers (array of strings) */ - public function getDocumentWithHttpInfo($account_id, $document_id, $template_id, TemplatesApi\GetDocumentOptions $options = null) + public function getPageTabsWithHttpInfo($account_id, $document_id, $page_number, $template_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getDocument'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getPageTabs'); } // verify the required parameter 'document_id' is set if ($document_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getDocument'); + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getPageTabs'); + } + // verify the required parameter 'page_number' is set + if ($page_number === null) { + throw new \InvalidArgumentException('Missing the required parameter $page_number when calling getPageTabs'); } // verify the required parameter 'template_id' is set if ($template_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getDocument'); + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getPageTabs'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}"; + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs"; $httpBody = ''; $queryParams = []; $headerParams = []; $formParams = []; - $_header_accept = $this->apiClient->selectHeaderAccept(['application/pdf']); + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); - if ($options != null) - { - // query params - // query params - if ($options->getEncrypt() !== null) { - $queryParams['encrypt'] = $this->apiClient->getSerializer()->toQueryValue($options->getEncrypt()); - } - // query params - if ($options->getShowChanges() !== null) { - $queryParams['show_changes'] = $this->apiClient->getSerializer()->toQueryValue($options->getShowChanges()); - } - } // path params if ($account_id !== null) { @@ -3172,6 +4303,14 @@ public function getDocumentWithHttpInfo($account_id, $document_id, $template_id, ); } // path params + if ($page_number !== null) { + $resourcePath = str_replace( + "{" . "pageNumber" . "}", + $this->apiClient->getSerializer()->toPathValue($page_number), + $resourcePath + ); + } + // path params if ($template_id !== null) { $resourcePath = str_replace( "{" . "templateId" . "}", @@ -3197,15 +4336,15 @@ public function getDocumentWithHttpInfo($account_id, $document_id, $template_id, $queryParams, $httpBody, $headerParams, - '\SplFileObject', - '/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}' + '\DocuSign\eSign\Model\Tabs', + '/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\SplFileObject', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Tabs', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Tabs', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3219,62 +4358,56 @@ public function getDocumentWithHttpInfo($account_id, $document_id, $template_id, } /** - * Operation getDocumentPageImage + * Operation getPages * - * Gets a page image from a template for display. + * Returns document page image(s) based on input. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $document_id The ID of the document being accessed. - * @param string $page_number The page number being accessed. * @param string $template_id The ID of the template being accessed. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \SplFileObject + * @return \DocuSign\eSign\Model\PageImages */ - public function getDocumentPageImage($account_id, $document_id, $page_number, $template_id, TemplatesApi\GetDocumentPageImageOptions $options = null) + public function getPages($account_id, $document_id, $template_id, TemplatesApi\GetPagesOptions $options = null) { - list($response) = $this->getDocumentPageImageWithHttpInfo($account_id, $document_id, $page_number, $template_id, $options); + list($response) = $this->getPagesWithHttpInfo($account_id, $document_id, $template_id, $options); return $response; } /** - * Operation getDocumentPageImageWithHttpInfo + * Operation getPagesWithHttpInfo * - * Gets a page image from a template for display. + * Returns document page image(s) based on input. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $document_id The ID of the document being accessed. - * @param string $page_number The page number being accessed. * @param string $template_id The ID of the template being accessed. * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\PageImages, HTTP status code, HTTP response headers (array of strings) */ - public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $page_number, $template_id, TemplatesApi\GetDocumentPageImageOptions $options = null) + public function getPagesWithHttpInfo($account_id, $document_id, $template_id, TemplatesApi\GetPagesOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getDocumentPageImage'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getPages'); } // verify the required parameter 'document_id' is set if ($document_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getDocumentPageImage'); - } - // verify the required parameter 'page_number' is set - if ($page_number === null) { - throw new \InvalidArgumentException('Missing the required parameter $page_number when calling getDocumentPageImage'); + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getPages'); } // verify the required parameter 'template_id' is set if ($template_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getDocumentPageImage'); + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getPages'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image"; + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages"; $httpBody = ''; $queryParams = []; $headerParams = []; $formParams = []; - $_header_accept = $this->apiClient->selectHeaderAccept(['image/png']); + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } @@ -3284,6 +4417,10 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $pag { // query params // query params + if ($options->getCount() !== null) { + $queryParams['count'] = $this->apiClient->getSerializer()->toQueryValue($options->getCount()); + } + // query params if ($options->getDpi() !== null) { $queryParams['dpi'] = $this->apiClient->getSerializer()->toQueryValue($options->getDpi()); } @@ -3296,9 +4433,17 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $pag $queryParams['max_width'] = $this->apiClient->getSerializer()->toQueryValue($options->getMaxWidth()); } // query params + if ($options->getNocache() !== null) { + $queryParams['nocache'] = $this->apiClient->getSerializer()->toQueryValue($options->getNocache()); + } + // query params if ($options->getShowChanges() !== null) { $queryParams['show_changes'] = $this->apiClient->getSerializer()->toQueryValue($options->getShowChanges()); } + // query params + if ($options->getStartPosition() !== null) { + $queryParams['start_position'] = $this->apiClient->getSerializer()->toQueryValue($options->getStartPosition()); + } } // path params @@ -3318,14 +4463,6 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $pag ); } // path params - if ($page_number !== null) { - $resourcePath = str_replace( - "{" . "pageNumber" . "}", - $this->apiClient->getSerializer()->toPathValue($page_number), - $resourcePath - ); - } - // path params if ($template_id !== null) { $resourcePath = str_replace( "{" . "templateId" . "}", @@ -3351,15 +4488,15 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $pag $queryParams, $httpBody, $headerParams, - '\SplFileObject', - '/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image' + '\DocuSign\eSign\Model\PageImages', + '/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\SplFileObject', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\PageImages', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\PageImages', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3373,43 +4510,49 @@ public function getDocumentPageImageWithHttpInfo($account_id, $document_id, $pag } /** - * Operation getLock + * Operation getTemplateDocumentHtmlDefinitions * - * Gets template lock information. + * Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. * @param string $template_id The ID of the template being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\LockInformation + * @return \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals */ - public function getLock($account_id, $template_id) + public function getTemplateDocumentHtmlDefinitions($account_id, $document_id, $template_id) { - list($response) = $this->getLockWithHttpInfo($account_id, $template_id); + list($response) = $this->getTemplateDocumentHtmlDefinitionsWithHttpInfo($account_id, $document_id, $template_id); return $response; } /** - * Operation getLockWithHttpInfo + * Operation getTemplateDocumentHtmlDefinitionsWithHttpInfo * - * Gets template lock information. + * Get the Original HTML Definition used to generate the Responsive HTML for a given document in a template. * * @param string $account_id The external account number (int) or account ID Guid. + * @param string $document_id The ID of the document being accessed. * @param string $template_id The ID of the template being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\LockInformation, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals, HTTP status code, HTTP response headers (array of strings) */ - public function getLockWithHttpInfo($account_id, $template_id) + public function getTemplateDocumentHtmlDefinitionsWithHttpInfo($account_id, $document_id, $template_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getLock'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getTemplateDocumentHtmlDefinitions'); + } + // verify the required parameter 'document_id' is set + if ($document_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $document_id when calling getTemplateDocumentHtmlDefinitions'); } // verify the required parameter 'template_id' is set if ($template_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getLock'); + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getTemplateDocumentHtmlDefinitions'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/lock"; + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3430,6 +4573,14 @@ public function getLockWithHttpInfo($account_id, $template_id) ); } // path params + if ($document_id !== null) { + $resourcePath = str_replace( + "{" . "documentId" . "}", + $this->apiClient->getSerializer()->toPathValue($document_id), + $resourcePath + ); + } + // path params if ($template_id !== null) { $resourcePath = str_replace( "{" . "templateId" . "}", @@ -3455,15 +4606,15 @@ public function getLockWithHttpInfo($account_id, $template_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\LockInformation', - '/v2/accounts/{accountId}/templates/{templateId}/lock' + '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', + '/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\LockInformation', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\LockInformation', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -3477,43 +4628,43 @@ public function getLockWithHttpInfo($account_id, $template_id) } /** - * Operation getNotificationSettings + * Operation getTemplateHtmlDefinitions * - * Gets template notification information. + * Get the Original HTML Definition used to generate the Responsive HTML for the template. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $template_id The ID of the template being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return \DocuSign\eSign\Model\Notification + * @return \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals */ - public function getNotificationSettings($account_id, $template_id) + public function getTemplateHtmlDefinitions($account_id, $template_id) { - list($response) = $this->getNotificationSettingsWithHttpInfo($account_id, $template_id); + list($response) = $this->getTemplateHtmlDefinitionsWithHttpInfo($account_id, $template_id); return $response; } /** - * Operation getNotificationSettingsWithHttpInfo + * Operation getTemplateHtmlDefinitionsWithHttpInfo * - * Gets template notification information. + * Get the Original HTML Definition used to generate the Responsive HTML for the template. * * @param string $account_id The external account number (int) or account ID Guid. * @param string $template_id The ID of the template being accessed. * @throws \DocuSign\eSign\ApiException on non-2xx response - * @return array of \DocuSign\eSign\Model\Notification, HTTP status code, HTTP response headers (array of strings) + * @return array of \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals, HTTP status code, HTTP response headers (array of strings) */ - public function getNotificationSettingsWithHttpInfo($account_id, $template_id) + public function getTemplateHtmlDefinitionsWithHttpInfo($account_id, $template_id) { // verify the required parameter 'account_id' is set if ($account_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getNotificationSettings'); + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getTemplateHtmlDefinitions'); } // verify the required parameter 'template_id' is set if ($template_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getNotificationSettings'); + throw new \InvalidArgumentException('Missing the required parameter $template_id when calling getTemplateHtmlDefinitions'); } // parse inputs - $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/notification"; + $resourcePath = "/v2/accounts/{accountId}/templates/{templateId}/html_definitions"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -3559,15 +4710,15 @@ public function getNotificationSettingsWithHttpInfo($account_id, $template_id) $queryParams, $httpBody, $headerParams, - '\DocuSign\eSign\Model\Notification', - '/v2/accounts/{accountId}/templates/{templateId}/notification' + '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', + '/v2/accounts/{accountId}/templates/{templateId}/html_definitions' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\Notification', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\Notification', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginals', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: @@ -4360,6 +5511,14 @@ public function listTemplatesWithHttpInfo($account_id, TemplatesApi\ListTemplate $queryParams['include'] = $this->apiClient->getSerializer()->toQueryValue($options->getInclude()); } // query params + if ($options->getModifiedFromDate() !== null) { + $queryParams['modified_from_date'] = $this->apiClient->getSerializer()->toQueryValue($options->getModifiedFromDate()); + } + // query params + if ($options->getModifiedToDate() !== null) { + $queryParams['modified_to_date'] = $this->apiClient->getSerializer()->toQueryValue($options->getModifiedToDate()); + } + // query params if ($options->getOrder() !== null) { $queryParams['order'] = $this->apiClient->getSerializer()->toQueryValue($options->getOrder()); } @@ -4372,10 +5531,6 @@ public function listTemplatesWithHttpInfo($account_id, TemplatesApi\ListTemplate $queryParams['search_text'] = $this->apiClient->getSerializer()->toQueryValue($options->getSearchText()); } // query params - if ($options->getShared() !== null) { - $queryParams['shared'] = $this->apiClient->getSerializer()->toQueryValue($options->getShared()); - } - // query params if ($options->getSharedByMe() !== null) { $queryParams['shared_by_me'] = $this->apiClient->getSerializer()->toQueryValue($options->getSharedByMe()); } @@ -4399,6 +5554,10 @@ public function listTemplatesWithHttpInfo($account_id, TemplatesApi\ListTemplate if ($options->getUserFilter() !== null) { $queryParams['user_filter'] = $this->apiClient->getSerializer()->toQueryValue($options->getUserFilter()); } + // query params + if ($options->getUserId() !== null) { + $queryParams['user_id'] = $this->apiClient->getSerializer()->toQueryValue($options->getUserId()); + } } // path params @@ -5253,6 +6412,10 @@ public function updateDocumentsWithHttpInfo($account_id, $template_id, $envelope if ($options->getApplyDocumentFields() !== null) { $queryParams['apply_document_fields'] = $this->apiClient->getSerializer()->toQueryValue($options->getApplyDocumentFields()); } + // query params + if ($options->getPersistTabs() !== null) { + $queryParams['persist_tabs'] = $this->apiClient->getSerializer()->toQueryValue($options->getPersistTabs()); + } } // path params diff --git a/src/Api/TrustServiceProvidersApi.php b/src/Api/TrustServiceProvidersApi.php new file mode 100644 index 00000000..12385f34 --- /dev/null +++ b/src/Api/TrustServiceProvidersApi.php @@ -0,0 +1,183 @@ +apiClient = $apiClient; + } + + /** + * Get API client + * + * @return \DocuSign\eSign\Client\ApiClient get the API client + */ + public function getApiClient() + { + return $this->apiClient; + } + + /** + * Set the API client + * + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client + * + * @return TrustServiceProvidersApi + */ + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) + { + $this->apiClient = $apiClient; + return $this; + } + + /** + * Operation getSealProviders + * + * Returns Account available seals for specified account. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\AccountSeals + */ + public function getSealProviders($account_id) + { + list($response) = $this->getSealProvidersWithHttpInfo($account_id); + return $response; + } + + /** + * Operation getSealProvidersWithHttpInfo + * + * Returns Account available seals for specified account. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\AccountSeals, HTTP status code, HTTP response headers (array of strings) + */ + public function getSealProvidersWithHttpInfo($account_id) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling getSealProviders'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/seals"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'GET', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\AccountSeals', + '/v2/accounts/{accountId}/seals' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\AccountSeals', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\AccountSeals', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } +} diff --git a/src/Api/UsersApi.php b/src/Api/UsersApi.php index b59d7c4a..e338973a 100644 --- a/src/Api/UsersApi.php +++ b/src/Api/UsersApi.php @@ -155,31 +155,6 @@ public function setGroupId($group_id) $this->group_id = $group_id; return $this; } - /** - * $include_usersettings_for_csv - * @var string - */ - protected $include_usersettings_for_csv; - - /** - * Gets include_usersettings_for_csv - * @return string - */ - public function getIncludeUsersettingsForCsv() - { - return $this->include_usersettings_for_csv; - } - - /** - * Sets include_usersettings_for_csv - * @param string $include_usersettings_for_csv - * @return $this - */ - public function setIncludeUsersettingsForCsv($include_usersettings_for_csv) - { - $this->include_usersettings_for_csv = $include_usersettings_for_csv; - return $this; - } /** * $login_status * @var string @@ -306,6 +281,34 @@ public function setUserNameSubstring($user_name_substring) return $this; } } +class DeleteOptions +{ + /** + * $delete + * @var string + */ + protected $delete; + + /** + * Gets delete + * @return string + */ + public function getDelete() + { + return $this->delete; + } + + /** + * Sets delete + * @param string $delete + * @return $this + */ + public function setDelete($delete) + { + $this->delete = $delete; + return $this; + } +} class GetInformationOptions { /** @@ -415,6 +418,34 @@ public function setIncludeChrome($include_chrome) return $this; } } +class ListSignaturesOptions +{ + /** + * $stamp_type + * @var string + */ + protected $stamp_type; + + /** + * Gets stamp_type + * @return string + */ + public function getStampType() + { + return $this->stamp_type; + } + + /** + * Sets stamp_type + * @param string $stamp_type + * @return $this + */ + public function setStampType($stamp_type) + { + $this->stamp_type = $stamp_type; + return $this; + } +} class UpdateSignatureOptions { /** @@ -447,7 +478,7 @@ public function setCloseExistingSignature($close_existing_signature) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -465,16 +496,16 @@ class UsersApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -486,7 +517,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -496,11 +527,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return UsersApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; @@ -574,10 +605,6 @@ public function callListWithHttpInfo($account_id, UsersApi\ListOptions $options $queryParams['group_id'] = $this->apiClient->getSerializer()->toQueryValue($options->getGroupId()); } // query params - if ($options->getIncludeUsersettingsForCsv() !== null) { - $queryParams['include_usersettings_for_csv'] = $this->apiClient->getSerializer()->toQueryValue($options->getIncludeUsersettingsForCsv()); - } - // query params if ($options->getLoginStatus() !== null) { $queryParams['login_status'] = $this->apiClient->getSerializer()->toQueryValue($options->getLoginStatus()); } @@ -861,12 +888,13 @@ public function createSignaturesWithHttpInfo($account_id, $user_id, $user_signat * * @param string $account_id The external account number (int) or account ID Guid. * @param \DocuSign\eSign\Model\UserInfoList $user_info_list (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response * @return \DocuSign\eSign\Model\UsersResponse */ - public function delete($account_id, $user_info_list = null) + public function delete($account_id, $user_info_list = null, UsersApi\DeleteOptions $options = null) { - list($response) = $this->deleteWithHttpInfo($account_id, $user_info_list); + list($response) = $this->deleteWithHttpInfo($account_id, $user_info_list, $options); return $response; } @@ -877,10 +905,11 @@ public function delete($account_id, $user_info_list = null) * * @param string $account_id The external account number (int) or account ID Guid. * @param \DocuSign\eSign\Model\UserInfoList $user_info_list (optional) + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response * @return array of \DocuSign\eSign\Model\UsersResponse, HTTP status code, HTTP response headers (array of strings) */ - public function deleteWithHttpInfo($account_id, $user_info_list = null) + public function deleteWithHttpInfo($account_id, $user_info_list = null, UsersApi\DeleteOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { @@ -898,6 +927,14 @@ public function deleteWithHttpInfo($account_id, $user_info_list = null) } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getDelete() !== null) { + $queryParams['delete'] = $this->apiClient->getSerializer()->toQueryValue($options->getDelete()); + } + } // path params if ($account_id !== null) { @@ -2524,12 +2561,13 @@ public function listCustomSettingsWithHttpInfo($account_id, $user_id) * * @param string $account_id The external account number (int) or account ID Guid. * @param string $user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response * @return \DocuSign\eSign\Model\UserSignaturesInformation */ - public function listSignatures($account_id, $user_id) + public function listSignatures($account_id, $user_id, UsersApi\ListSignaturesOptions $options = null) { - list($response) = $this->listSignaturesWithHttpInfo($account_id, $user_id); + list($response) = $this->listSignaturesWithHttpInfo($account_id, $user_id, $options); return $response; } @@ -2540,10 +2578,11 @@ public function listSignatures($account_id, $user_id) * * @param string $account_id The external account number (int) or account ID Guid. * @param string $user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. + * @param $options Options for modifying the behavior of the function. (optional) * @throws \DocuSign\eSign\ApiException on non-2xx response * @return array of \DocuSign\eSign\Model\UserSignaturesInformation, HTTP status code, HTTP response headers (array of strings) */ - public function listSignaturesWithHttpInfo($account_id, $user_id) + public function listSignaturesWithHttpInfo($account_id, $user_id, UsersApi\ListSignaturesOptions $options = null) { // verify the required parameter 'account_id' is set if ($account_id === null) { @@ -2565,6 +2604,14 @@ public function listSignaturesWithHttpInfo($account_id, $user_id) } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + if ($options != null) + { + // query params + // query params + if ($options->getStampType() !== null) { + $queryParams['stamp_type'] = $this->apiClient->getSerializer()->toQueryValue($options->getStampType()); + } + } // path params if ($account_id !== null) { @@ -3079,7 +3126,7 @@ public function updateProfileImageWithHttpInfo($account_id, $user_id) if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['image/gif']); // path params @@ -3433,7 +3480,7 @@ public function updateSignatureImageWithHttpInfo($account_id, $image_type, $sign if (!is_null($_header_accept)) { $headerParams['Accept'] = $_header_accept; } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['image/gif']); // path params @@ -3507,6 +3554,117 @@ public function updateSignatureImageWithHttpInfo($account_id, $image_type, $sign } } + /** + * Operation updateSignatures + * + * Adds/updates a user signature. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. + * @param \DocuSign\eSign\Model\UserSignaturesInformation $user_signatures_information (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return \DocuSign\eSign\Model\UserSignaturesInformation + */ + public function updateSignatures($account_id, $user_id, $user_signatures_information = null) + { + list($response) = $this->updateSignaturesWithHttpInfo($account_id, $user_id, $user_signatures_information); + return $response; + } + + /** + * Operation updateSignaturesWithHttpInfo + * + * Adds/updates a user signature. + * + * @param string $account_id The external account number (int) or account ID Guid. + * @param string $user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. + * @param \DocuSign\eSign\Model\UserSignaturesInformation $user_signatures_information (optional) + * @throws \DocuSign\eSign\ApiException on non-2xx response + * @return array of \DocuSign\eSign\Model\UserSignaturesInformation, HTTP status code, HTTP response headers (array of strings) + */ + public function updateSignaturesWithHttpInfo($account_id, $user_id, $user_signatures_information = null) + { + // verify the required parameter 'account_id' is set + if ($account_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $account_id when calling updateSignatures'); + } + // verify the required parameter 'user_id' is set + if ($user_id === null) { + throw new \InvalidArgumentException('Missing the required parameter $user_id when calling updateSignatures'); + } + // parse inputs + $resourcePath = "/v2/accounts/{accountId}/users/{userId}/signatures"; + $httpBody = ''; + $queryParams = []; + $headerParams = []; + $formParams = []; + $_header_accept = $this->apiClient->selectHeaderAccept(['application/json']); + if (!is_null($_header_accept)) { + $headerParams['Accept'] = $_header_accept; + } + $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType([]); + + + // path params + if ($account_id !== null) { + $resourcePath = str_replace( + "{" . "accountId" . "}", + $this->apiClient->getSerializer()->toPathValue($account_id), + $resourcePath + ); + } + // path params + if ($user_id !== null) { + $resourcePath = str_replace( + "{" . "userId" . "}", + $this->apiClient->getSerializer()->toPathValue($user_id), + $resourcePath + ); + } + // default format to json + $resourcePath = str_replace("{format}", "json", $resourcePath); + + // body params + $_tempBody = null; + if (isset($user_signatures_information)) { + $_tempBody = $user_signatures_information; + } + + // 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) + } + // make the API Call + try { + list($response, $statusCode, $httpHeader) = $this->apiClient->callApi( + $resourcePath, + 'PUT', + $queryParams, + $httpBody, + $headerParams, + '\DocuSign\eSign\Model\UserSignaturesInformation', + '/v2/accounts/{accountId}/users/{userId}/signatures' + ); + + return [$this->apiClient->getSerializer()->deserialize($response, '\DocuSign\eSign\Model\UserSignaturesInformation', $httpHeader), $statusCode, $httpHeader]; + } catch (ApiException $e) { + switch ($e->getCode()) { + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\UserSignaturesInformation', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + case 400: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\DocuSign\eSign\Model\ErrorDetails', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; + } + + throw $e; + } + } + /** * Operation updateUser * diff --git a/src/Api/WorkspacesApi.php b/src/Api/WorkspacesApi.php index 8ce0a74e..8b50fff5 100644 --- a/src/Api/WorkspacesApi.php +++ b/src/Api/WorkspacesApi.php @@ -391,7 +391,7 @@ public function setWorkspaceUserId($workspace_user_id) namespace DocuSign\eSign\Api; -use \DocuSign\eSign\ApiClient; +use \DocuSign\eSign\Client\ApiClient; use \DocuSign\eSign\ApiException; use \DocuSign\eSign\Configuration; use \DocuSign\eSign\ObjectSerializer; @@ -409,16 +409,16 @@ class WorkspacesApi /** * API Client * - * @var \DocuSign\eSign\ApiClient instance of the ApiClient + * @var \DocuSign\eSign\Client\ApiClient instance of the ApiClient */ protected $apiClient; /** * Constructor * - * @param \DocuSign\eSign\ApiClient|null $apiClient The api client to use + * @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use */ - public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) + public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null) { if ($apiClient === null) { $apiClient = new ApiClient(); @@ -430,7 +430,7 @@ public function __construct(\DocuSign\eSign\ApiClient $apiClient = null) /** * Get API client * - * @return \DocuSign\eSign\ApiClient get the API client + * @return \DocuSign\eSign\Client\ApiClient get the API client */ public function getApiClient() { @@ -440,11 +440,11 @@ public function getApiClient() /** * Set the API client * - * @param \DocuSign\eSign\ApiClient $apiClient set the API client + * @param \DocuSign\eSign\Client\ApiClient $apiClient set the API client * * @return WorkspacesApi */ - public function setApiClient(\DocuSign\eSign\ApiClient $apiClient) + public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) { $this->apiClient = $apiClient; return $this; diff --git a/src/ApiClient.php b/src/ApiClient.php deleted file mode 100644 index b4557954..00000000 --- a/src/ApiClient.php +++ /dev/null @@ -1,370 +0,0 @@ -config = $config; - $this->serializer = new ObjectSerializer(); - } - - /** - * Get the config - * - * @return Configuration - */ - public function getConfig() - { - return $this->config; - } - - /** - * Get the serializer - * - * @return ObjectSerializer - */ - public function getSerializer() - { - return $this->serializer; - } - - /** - * Get API key (with prefix if set) - * - * @param string $apiKeyIdentifier name of apikey - * - * @return string API key with the prefix - */ - public function getApiKeyWithPrefix($apiKeyIdentifier) - { - $prefix = $this->config->getApiKeyPrefix($apiKeyIdentifier); - $apiKey = $this->config->getApiKey($apiKeyIdentifier); - - if (!isset($apiKey)) { - return null; - } - - if (isset($prefix)) { - $keyWithPrefix = $prefix." ".$apiKey; - } else { - $keyWithPrefix = $apiKey; - } - - return $keyWithPrefix; - } - - /** - * Make the HTTP call (Sync) - * - * @param string $resourcePath path to method endpoint - * @param string $method method to call - * @param array $queryParams parameters to be place in query URL - * @param array $postData parameters to be placed in POST body - * @param array $headerParams parameters to be place in request header - * @param string $responseType expected response type of the endpoint - * @param string $endpointPath path to method endpoint before expanding parameters - * - * @throws \DocuSign\eSign\ApiException on a non 2xx response - * @return mixed - */ - public function callApi($resourcePath, $method, $queryParams, $postData, $headerParams, $responseType = null, $endpointPath = null) - { - $headers = []; - - // DocuSign: Add DocuSign tracking headers - $this->config->addDefaultHeader("X-DocuSign-SDK", "PHP"); - - // construct the http header - $headerParams = array_merge( - (array)$this->config->getDefaultHeaders(), - (array)$headerParams - ); - - foreach ($headerParams as $key => $val) { - $headers[] = "$key: $val"; - } - - // form data - if ($postData and in_array('Content-Type: application/x-www-form-urlencoded', $headers, true)) { - $postData = http_build_query($postData); - } elseif ((is_object($postData) or is_array($postData)) and !in_array('Content-Type: multipart/form-data', $headers, true)) { // json model - $postData = json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($postData)); - } - - $url = $this->config->getHost() . $resourcePath; - - $curl = curl_init(); - // set timeout, if needed - if ($this->config->getCurlTimeout() !== 0) { - curl_setopt($curl, CURLOPT_TIMEOUT, $this->config->getCurlTimeout()); - } - // set connect timeout, if needed - if ($this->config->getCurlConnectTimeout() != 0) { - curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, $this->config->getCurlConnectTimeout()); - } - - // return the result on success, rather than just true - curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); - - curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); - - // disable SSL verification, if needed - if ($this->config->getSSLVerification() === false) { - curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0); - curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0); - } - - if ($this->config->getCurlProxyHost()) { - curl_setopt($curl, CURLOPT_PROXY, $this->config->getCurlProxyHost()); - } - - if ($this->config->getCurlProxyPort()) { - curl_setopt($curl, CURLOPT_PROXYPORT, $this->config->getCurlProxyPort()); - } - - if ($this->config->getCurlProxyType()) { - curl_setopt($curl, CURLOPT_PROXYTYPE, $this->config->getCurlProxyType()); - } - - if ($this->config->getCurlProxyUser()) { - curl_setopt($curl, CURLOPT_PROXYUSERPWD, $this->config->getCurlProxyUser() . ':' .$this->config->getCurlProxyPassword()); - } - - if (!empty($queryParams)) { - $url = ($url . '?' . http_build_query($queryParams)); - } - - if ($method === self::$POST) { - curl_setopt($curl, CURLOPT_POST, true); - curl_setopt($curl, CURLOPT_POSTFIELDS, $postData); - } elseif ($method === self::$HEAD) { - curl_setopt($curl, CURLOPT_NOBODY, true); - } elseif ($method === self::$OPTIONS) { - curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "OPTIONS"); - curl_setopt($curl, CURLOPT_POSTFIELDS, $postData); - } elseif ($method === self::$PATCH) { - curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH"); - curl_setopt($curl, CURLOPT_POSTFIELDS, $postData); - } elseif ($method === self::$PUT) { - curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT"); - curl_setopt($curl, CURLOPT_POSTFIELDS, $postData); - } elseif ($method === self::$DELETE) { - curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "DELETE"); - curl_setopt($curl, CURLOPT_POSTFIELDS, $postData); - } elseif ($method !== self::$GET) { - throw new ApiException('Method ' . $method . ' is not recognized.'); - } - curl_setopt($curl, CURLOPT_URL, $url); - - // Set user agent - curl_setopt($curl, CURLOPT_USERAGENT, $this->config->getUserAgent()); - - // debugging for curl - if ($this->config->getDebug()) { - error_log("[DEBUG] HTTP Request body ~BEGIN~".PHP_EOL.print_r($postData, true).PHP_EOL."~END~".PHP_EOL, 3, $this->config->getDebugFile()); - - curl_setopt($curl, CURLOPT_VERBOSE, 1); - curl_setopt($curl, CURLOPT_STDERR, fopen($this->config->getDebugFile(), 'a')); - } else { - curl_setopt($curl, CURLOPT_VERBOSE, 0); - } - - // obtain the HTTP response headers - curl_setopt($curl, CURLOPT_HEADER, 1); - - // Make the request - $response = curl_exec($curl); - $http_header_size = curl_getinfo($curl, CURLINFO_HEADER_SIZE); - $http_header = $this->httpParseHeaders(substr($response, 0, $http_header_size)); - $http_body = substr($response, $http_header_size); - $response_info = curl_getinfo($curl); - - // debug HTTP response body - if ($this->config->getDebug()) { - error_log("[DEBUG] HTTP Response body ~BEGIN~".PHP_EOL.print_r($http_body, true).PHP_EOL."~END~".PHP_EOL, 3, $this->config->getDebugFile()); - } - - // Handle the response - if ($response_info['http_code'] === 0) { - $curl_error_message = curl_error($curl); - - // curl_exec can sometimes fail but still return a blank message from curl_error(). - if (!empty($curl_error_message)) { - $error_message = "API call to $url failed: $curl_error_message"; - } else { - $error_message = "API call to $url failed, but for an unknown reason. " . - "This could happen if you are disconnected from the network."; - } - - $exception = new ApiException($error_message, 0, null, null); - $exception->setResponseObject($response_info); - throw $exception; - } elseif ($response_info['http_code'] >= 200 && $response_info['http_code'] <= 299) { - // return raw body if response is a file - if ($responseType === '\SplFileObject' || $responseType === 'string') { - return [$http_body, $response_info['http_code'], $http_header]; - } - - $data = json_decode($http_body); - if (json_last_error() > 0) { // if response is a string - $data = $http_body; - } - } else { - $data = json_decode($http_body); - if (json_last_error() > 0) { // if response is a string - $data = $http_body; - } - - throw new ApiException( - "[".$response_info['http_code']."] Error connecting to the API ($url)", - $response_info['http_code'], - $http_header, - $data - ); - } - return [$data, $response_info['http_code'], $http_header]; - } - - /** - * Return the header 'Accept' based on an array of Accept provided - * - * @param string[] $accept Array of header - * - * @return string Accept (e.g. application/json) - */ - public function selectHeaderAccept($accept) - { - if (count($accept) === 0 or (count($accept) === 1 and $accept[0] === '')) { - return null; - } elseif (preg_grep("/application\/json/i", $accept)) { - return 'application/json'; - } else { - return implode(',', $accept); - } - } - - /** - * Return the content type based on an array of content-type provided - * - * @param string[] $content_type Array fo content-type - * - * @return string Content-Type (e.g. application/json) - */ - public function selectHeaderContentType($content_type) - { - if (count($content_type) === 0 or (count($content_type) === 1 and $content_type[0] === '')) { - return 'application/json'; - } elseif (preg_grep("/application\/json/i", $content_type)) { - return 'application/json'; - } else { - return implode(',', $content_type); - } - } - - /** - * Return an array of HTTP response headers - * - * @param string $raw_headers A string of raw HTTP response headers - * - * @return string[] Array of HTTP response heaers - */ - protected function httpParseHeaders($raw_headers) - { - // ref/credit: http://php.net/manual/en/function.http-parse-headers.php#112986 - $headers = []; - $key = ''; - - foreach (explode("\n", $raw_headers) as $h) { - $h = explode(':', $h, 2); - - if (isset($h[1])) { - if (!isset($headers[$h[0]])) { - $headers[$h[0]] = trim($h[1]); - } elseif (is_array($headers[$h[0]])) { - $headers[$h[0]] = array_merge($headers[$h[0]], [trim($h[1])]); - } else { - $headers[$h[0]] = array_merge([$headers[$h[0]]], [trim($h[1])]); - } - - $key = $h[0]; - } else { - if (substr($h[0], 0, 1) === "\t") { - $headers[$key] .= "\r\n\t".trim($h[0]); - } elseif (!$key) { - $headers[0] = trim($h[0]); - } - trim($h[0]); - } - } - - return $headers; - } -} diff --git a/src/Client/ApiClient.php b/src/Client/ApiClient.php new file mode 100644 index 00000000..bc97b1f3 --- /dev/null +++ b/src/Client/ApiClient.php @@ -0,0 +1,644 @@ +config = $config; + $this->oAuth = $oAuth; + $this->serializer = new ObjectSerializer(); + } + + /** + * Get the config + * + * @return Configuration + */ + public function getConfig() + { + return $this->config; + } + + /** + * Get the oAuth + * + * @return OAuth + */ + public function getOAuth() + { + return $this->oAuth; + } + + /** + * Get the serializer + * + * @return ObjectSerializer + */ + public function getSerializer() + { + return $this->serializer; + } + + /** + * Get API key (with prefix if set) + * + * @param string $apiKeyIdentifier name of apikey + * + * @return string API key with the prefix + */ + public function getApiKeyWithPrefix($apiKeyIdentifier) + { + $prefix = $this->config->getApiKeyPrefix($apiKeyIdentifier); + $apiKey = $this->config->getApiKey($apiKeyIdentifier); + + if (!isset($apiKey)) { + return null; + } + + if (isset($prefix)) { + $keyWithPrefix = $prefix." ".$apiKey; + } else { + $keyWithPrefix = $apiKey; + } + + return $keyWithPrefix; + } + + /** + * Make the HTTP call (Sync) + * + * @param string $resourcePath path to method endpoint + * @param string $method method to call + * @param array $queryParams parameters to be place in query URL + * @param array $postData parameters to be placed in POST body + * @param array $headerParams parameters to be place in request header + * @param string $responseType expected response type of the endpoint + * @param string $endpointPath path to method endpoint before expanding parameters + * @param bool $oAuth pass true in case of oAuth requests + * + * @throws ApiException on a non 2xx response + * @return mixed + */ + public function callApi($resourcePath, $method, $queryParams, $postData, $headerParams, $responseType = null, $endpointPath = null, $oAuth = false) + { + $headers = []; + + // DocuSign: Add DocuSign tracking headers + $this->config->addDefaultHeader("X-DocuSign-SDK", "PHP"); + + $url = $this->config->getHost() . $resourcePath; + if ($oAuth) { + $url = 'https://' . $this->oAuth->getOAuthBasePath() . $resourcePath; + } else { + // construct the http header + $headerParams = array_merge( + (array)$this->config->getDefaultHeaders(), + (array)$headerParams + ); + } + + foreach ($headerParams as $key => $val) { + $headers[] = "$key: $val"; + } + + // form data + if ($postData and in_array('Content-Type: application/x-www-form-urlencoded', $headers, true)) { + $postData = http_build_query($postData); + } elseif ((is_object($postData) or is_array($postData)) and !in_array('Content-Type: multipart/form-data', $headers, true)) { // json model + $postData = json_encode(ObjectSerializer::sanitizeForSerialization($postData)); + } + + $curl = curl_init(); + // set timeout, if needed + if ($this->config->getCurlTimeout() !== 0) { + curl_setopt($curl, CURLOPT_TIMEOUT, $this->config->getCurlTimeout()); + } + // set connect timeout, if needed + if ($this->config->getCurlConnectTimeout() != 0) { + curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, $this->config->getCurlConnectTimeout()); + } + + // return the result on success, rather than just true + curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); + + curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); + + // disable SSL verification, if needed + if ($this->config->getSSLVerification() === false) { + curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0); + curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0); + } + + if ($this->config->getCurlProxyHost()) { + curl_setopt($curl, CURLOPT_PROXY, $this->config->getCurlProxyHost()); + } + + if ($this->config->getCurlProxyPort()) { + curl_setopt($curl, CURLOPT_PROXYPORT, $this->config->getCurlProxyPort()); + } + + if ($this->config->getCurlProxyType()) { + curl_setopt($curl, CURLOPT_PROXYTYPE, $this->config->getCurlProxyType()); + } + + if ($this->config->getCurlProxyUser()) { + curl_setopt($curl, CURLOPT_PROXYUSERPWD, $this->config->getCurlProxyUser() . ':' .$this->config->getCurlProxyPassword()); + } + + if (!empty($queryParams)) { + $url = ($url . '?' . http_build_query($queryParams)); + } + + if ($method === self::$POST) { + curl_setopt($curl, CURLOPT_POST, true); + curl_setopt($curl, CURLOPT_POSTFIELDS, $postData); + } elseif ($method === self::$HEAD) { + curl_setopt($curl, CURLOPT_NOBODY, true); + } elseif ($method === self::$OPTIONS) { + curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "OPTIONS"); + curl_setopt($curl, CURLOPT_POSTFIELDS, $postData); + } elseif ($method === self::$PATCH) { + curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH"); + curl_setopt($curl, CURLOPT_POSTFIELDS, $postData); + } elseif ($method === self::$PUT) { + curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT"); + curl_setopt($curl, CURLOPT_POSTFIELDS, $postData); + } elseif ($method === self::$DELETE) { + curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "DELETE"); + curl_setopt($curl, CURLOPT_POSTFIELDS, $postData); + } elseif ($method !== self::$GET) { + throw new ApiException('Method ' . $method . ' is not recognized.'); + } + curl_setopt($curl, CURLOPT_URL, $url); + + // Set user agent + curl_setopt($curl, CURLOPT_USERAGENT, $this->config->getUserAgent()); + + // debugging for curl + if ($this->config->getDebug()) { + error_log("[DEBUG] HTTP Request body ~BEGIN~".PHP_EOL.print_r($postData, true).PHP_EOL."~END~".PHP_EOL, 3, $this->config->getDebugFile()); + + curl_setopt($curl, CURLOPT_VERBOSE, 1); + curl_setopt($curl, CURLOPT_STDERR, fopen($this->config->getDebugFile(), 'a')); + } else { + curl_setopt($curl, CURLOPT_VERBOSE, 0); + } + + // obtain the HTTP response headers + curl_setopt($curl, CURLOPT_HEADER, 1); + + // Make the request + $response = curl_exec($curl); + $http_header_size = curl_getinfo($curl, CURLINFO_HEADER_SIZE); + $http_header = $this->httpParseHeaders(substr($response, 0, $http_header_size)); + $http_body = substr($response, $http_header_size); + $response_info = curl_getinfo($curl); + + // debug HTTP response body + if ($this->config->getDebug()) { + error_log("[DEBUG] HTTP Response body ~BEGIN~".PHP_EOL.print_r($http_body, true).PHP_EOL."~END~".PHP_EOL, 3, $this->config->getDebugFile()); + } + + // Handle the response + if ($response_info['http_code'] === 0) { + $curl_error_message = curl_error($curl); + + // curl_exec can sometimes fail but still return a blank message from curl_error(). + if (!empty($curl_error_message)) { + $error_message = "API call to $url failed: $curl_error_message"; + } else { + $error_message = "API call to $url failed, but for an unknown reason. " . + "This could happen if you are disconnected from the network."; + } + + $exception = new ApiException($error_message, 0, null, null); + $exception->setResponseObject($response_info); + throw $exception; + } elseif ($response_info['http_code'] >= 200 && $response_info['http_code'] <= 299) { + // return raw body if response is a file + if ($responseType === '\SplFileObject' || $responseType === 'string') { + return [$http_body, $response_info['http_code'], $http_header]; + } + + $data = json_decode($http_body); + if (json_last_error() > 0) { // if response is a string + $data = $http_body; + } + } else { + $data = json_decode($http_body); + if (json_last_error() > 0) { // if response is a string + $data = $http_body; + } + if(is_object($data)){ + $data = serialize($data); + } + + throw new ApiException( + "Error while requesting server, received a non successful HTTP code [".$response_info['http_code']."] with response Body: $data", + $response_info['http_code'], + $http_header, + $data + ); + } + return [$data, $response_info['http_code'], $http_header]; + } + + /** + * Return the header 'Accept' based on an array of Accept provided + * + * @param string[] $accept Array of header + * + * @return string Accept (e.g. application/json) + */ + public function selectHeaderAccept($accept) + { + if (count($accept) === 0 or (count($accept) === 1 and $accept[0] === '')) { + return null; + } elseif (preg_grep("/application\/json/i", $accept)) { + return 'application/json'; + } else { + return implode(',', $accept); + } + } + + /** + * Return the content type based on an array of content-type provided + * + * @param string[] $content_type Array fo content-type + * + * @return string Content-Type (e.g. application/json) + */ + public function selectHeaderContentType($content_type) + { + if (count($content_type) === 0 or (count($content_type) === 1 and $content_type[0] === '')) { + return 'application/json'; + } elseif (preg_grep("/application\/json/i", $content_type)) { + return 'application/json'; + } else { + return implode(',', $content_type); + } + } + + /** + * Return an array of HTTP response headers + * + * @param string $raw_headers A string of raw HTTP response headers + * + * @return string[] Array of HTTP response heaers + */ + protected function httpParseHeaders($raw_headers) + { + // ref/credit: http://php.net/manual/en/function.http-parse-headers.php#112986 + $headers = []; + $key = ''; + + foreach (explode("\n", $raw_headers) as $h) { + $h = explode(':', $h, 2); + + if (isset($h[1])) { + if (!isset($headers[$h[0]])) { + $headers[$h[0]] = trim($h[1]); + } elseif (is_array($headers[$h[0]])) { + $headers[$h[0]] = array_merge($headers[$h[0]], [trim($h[1])]); + } else { + $headers[$h[0]] = array_merge([$headers[$h[0]]], [trim($h[1])]); + } + + $key = $h[0]; + } else { + if (substr($h[0], 0, 1) === "\t") { + $headers[$key] .= "\r\n\t".trim($h[0]); + } elseif (!$key) { + $headers[0] = trim($h[0]); + } + trim($h[0]); + } + } + + return $headers; + } + + /** + * Helper method to configure the OAuth accessCode/implicit flow parameters + * + * @param string $client_id DocuSign OAuth Client Id(AKA Integrator Key) + * @param string|array $scopes the list of requested scopes. Client applications may be scoped to a limited set of system access. + * @param string $redirect_uri This determines where to deliver the response containing the authorization code + * @param string $response_type Determines the response type of the authorization request, NOTE: these response types are + * mutually exclusive for a client application. A public/native client application may only request a response type + * of "token". A private/trusted client application may only request a response type of "code". + * @param string $state Allows for arbitrary state that may be useful to your application. + * The value in this parameter will be round-tripped along with the response so you can make sure it didn't change. + * Will be round-tripped along with the response so you can make sure it didn't change. + * + * @return string + */ + public function getAuthorizationURI($client_id, $scopes, $redirect_uri, $response_type, $state = null) + { + $replace = array( + '{oauth_base_path}' => $this->oAuth->getOAuthBasePath(), + '{response_type}' => $response_type, + '{scope}' => rawurlencode(is_array($scopes) ? implode(" ", $scopes) : $scopes), + '{client_id}' => $client_id, + '{redirect_uri}' => $redirect_uri, + '{state}' => $state, + ); + $resourcePath = "https://{oauth_base_path}/oauth/auth?response_type={response_type}&scope={scope}&client_id={client_id}&redirect_uri={redirect_uri}"; + if ($state) { + $resourcePath .= '&state={state}'; + } + return str_replace( + array_keys($replace), + array_values($replace), + $resourcePath + ); + } + + /** + * GenerateAccessToken will exchange the authorization code for an access token and refresh tokens. + * + * @param string $client_id DocuSign OAuth Client Id(AKA Integrator Key) + * @param string $client_secret The secret key you generated when you set up the integration in DocuSign Admin console. + * @param string $code The authorization code + * + * @return array + * @throws ApiException + * @throws InvalidArgumentException + */ + public function generateAccessToken($client_id = null, $client_secret = null, $code = null) + { + if (!$client_id) { + throw new \InvalidArgumentException('Missing the required parameter $client_id when calling generateAccessToken'); + } + if (!$client_secret || !$code) { + throw new \InvalidArgumentException('Missing the required parameter $client_secret when calling generateAccessToken'); + } + if (!$code) { + throw new \InvalidArgumentException('Missing the required parameter $code when calling generateAccessToken'); + } + + $resourcePath = "/oauth/token"; + $queryParams = []; + $integrator_and_secret_key = "Basic " . utf8_decode(base64_encode("{$client_id}:{$client_secret}")); + $headers = [ + "Authorization" => $integrator_and_secret_key, + "Content-Type" => "application/x-www-form-urlencoded", + ]; + $postData = [ + "grant_type" => "authorization_code", + "code" => $code + ]; + list($response, $statusCode, $httpHeader) = $this->callApi($resourcePath, self::$POST, $queryParams, $postData, $headers, null, null, true); + if(isset($response->access_token)) + $this->config->addDefaultHeader("Authorization", "{$response->token_type} {$response->access_token}"); + return [$this->getSerializer()->deserialize($response, '\DocuSign\eSign\Client\Auth\OAuthToken', $httpHeader), $statusCode, $httpHeader]; + } + + /** + * Request JWT User Token + * + * @param string $client_id DocuSign OAuth Client Id(AKA Integrator Key) + * @param string $rsa_private_key the RSA private key + * @param string|string[] $scopes array optional The list of requested scopes may include (but not limited to) You can also pass any advanced scope. + * @param string $user_id + * @param int $expires_in Number of minutes token will be valid + * @return array + * @throws ApiException + * @throws InvalidArgumentException + */ + public function requestJWTUserToken($client_id, $user_id, $rsa_private_key, $scopes = null, $expires_in = 60) + { + if (!$client_id) { + throw new \InvalidArgumentException('Missing the required parameter $client_id when calling requestJWTUserToken'); + } + if (!$user_id) { + throw new \InvalidArgumentException('Missing the required parameter $user_id when calling requestJWTUserToken'); + } + if (!$rsa_private_key) { + throw new \InvalidArgumentException('Missing the required parameter $rsa_private_key when calling requestJWTUserToken'); + } + + if (empty($scopes)) { + $scopes = self::$SCOPE_SIGNATURE; + } + if ((int)$expires_in > 60) { + //expires max number can be 60 minutes + $expires_in = 60; + } + $now = time(); + + $claim = [ + "iss" => $client_id, + "sub" => $user_id, + "aud" => $this->oAuth->getOAuthBasePath(), + "iat" => $now, + "exp" => $now + (int)$expires_in*60, + "scope" => is_array($scopes)?implode(" ", $scopes): $scopes + ]; + + $jwt = JWT::encode($claim, $rsa_private_key, 'RS256'); + + $resourcePath = "/oauth/token"; + $queryParams = []; + $headers = [ + "Content-Type" => "application/x-www-form-urlencoded", + ]; + $postData = [ + "assertion" => $jwt, + "grant_type" => self::$GRANT_TYPE_JWT + ]; + list($response, $statusCode, $httpHeader) = $this->callApi($resourcePath, self::$POST, $queryParams, $postData, $headers, null, null, true); + + if(isset($response->access_token)) + $this->config->addDefaultHeader("Authorization", "{$response->token_type} {$response->access_token}"); + + return [$this->getSerializer()->deserialize($response, '\DocuSign\eSign\Client\Auth\OAuthToken', $httpHeader), $statusCode, $httpHeader]; + } + + /** + * Request JWT Application Token + * + * @param string $client_id DocuSign OAuth Client Id(AKA Integrator Key) + * @param string $rsa_private_key the RSA private key + * @param string|string[] $scopes array optional The list of requested scopes may include (but not limited to) You can also pass any advanced scope. + * @param int $expires_in int Number of minutes token will be valid + * + * @return array + * + * @throws ApiException + */ + public function requestJWTApplicationToken($client_id, $rsa_private_key, $scopes = null, $expires_in = 60) + { + if (!$client_id) { + throw new \InvalidArgumentException('Missing the required parameter $client_id when calling requestJWTApplicationToken'); + } + if (!$rsa_private_key) { + throw new \InvalidArgumentException('Missing the required parameter $rsa_private_key when calling requestJWTApplicationToken'); + } + + if (empty($scopes)) { + $scopes = self::$SCOPE_SIGNATURE; + } + if ((int)$expires_in > 60) { + //expires max number can be 60 minutes + $expires_in = 60; + } + $now = time(); + $claim = [ + "iss" => $client_id, + "aud" => $this->oAuth->getOAuthBasePath(), + "iat" => $now, + "exp" => $now + (int)$expires_in*60, + "scope" => is_array($scopes)?implode(" ", $scopes):$scopes + ]; + + $jwt = JWT::encode($claim, $rsa_private_key, 'RS256'); + + $resourcePath = "/oauth/token"; + $queryParams = []; + $headers = ["Content-Type" => "application/x-www-form-urlencoded"]; + $postData = [ + "assertion" => $jwt, + "grant_type" => self::$GRANT_TYPE_JWT + ]; + list($response, $statusCode, $httpHeader) = $this->callApi($resourcePath, self::$POST, $queryParams, $postData, $headers, null, null, true); + + return [$this->getSerializer()->deserialize($response, '\DocuSign\eSign\Client\Auth\OAuthToken', $httpHeader), $statusCode, $httpHeader]; + } + + /** + * Get User Info method takes the accessToken to retrieve User Account Data. + * + * @param $access_token + * + * @return array + * + * @throws ApiException + */ + public function getUserInfo($access_token) + { + if (!$access_token) { + throw new \InvalidArgumentException('Cannot find a valid access token. Make sure OAuth is configured before you try again.'); + } + + $resourcePath = "/oauth/userinfo"; + $queryParams = []; + $headers = [ + "Authorization" => 'Bearer '.$access_token, + ]; + $postData = []; + list($response, $statusCode, $httpHeader) = $this->callApi( + $resourcePath, + self::$GET, + $queryParams, + $postData, + $headers, + null, + null, + true + ); + return [ + $this->getSerializer()->deserialize( + $response, + '\DocuSign\eSign\Client\Auth\UserInfo', + $httpHeader + ), + $statusCode, + $httpHeader + ]; + } +} diff --git a/src/ApiException.php b/src/Client/ApiException.php similarity index 98% rename from src/ApiException.php rename to src/Client/ApiException.php index ef71c9e3..9c0ba03c 100644 --- a/src/ApiException.php +++ b/src/Client/ApiException.php @@ -26,7 +26,7 @@ * Do not edit the class manually. */ -namespace DocuSign\eSign; +namespace DocuSign\eSign\Client; use \Exception; diff --git a/src/Client/Auth/Account.php b/src/Client/Auth/Account.php new file mode 100644 index 00000000..d00d9458 --- /dev/null +++ b/src/Client/Auth/Account.php @@ -0,0 +1,322 @@ + 'string', + 'is_default' => 'string', + 'account_name' => 'string', + 'base_uri' => 'string', + 'organization' => '\DocuSign\eSign\Client\Auth\Organization', + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'account_id' => 'account_id', + 'is_default' => 'is_default', + 'account_name' => 'account_name', + 'base_uri' => 'base_uri', + 'organization' => 'organization' + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'account_id' => 'setAccountId', + 'is_default' => 'setIsDefault', + 'account_name' => 'setAccountName', + 'base_uri' => 'setBaseUri', + 'organization' => 'setOrganization', + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'account_id' => 'getAccountId', + 'is_default' => 'getIsDefault', + 'account_name' => 'getAccountName', + 'base_uri' => 'getBaseUri', + 'organization' => 'getOrganization', + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + /** + * 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['account_id'] = isset($data['account_id']) ? $data['account_id'] : null; + $this->container['is_default'] = isset($data['is_default']) ? $data['is_default'] : null; + $this->container['account_name'] = isset($data['account_name']) ? $data['account_name'] : null; + $this->container['base_uri'] = isset($data['base_uri']) ? $data['base_uri'] : null; + $this->container['organization'] = isset($data['organization']) ? $data['organization'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets account_id + * @return string + */ + public function getAccountId() + { + return $this->container['account_id']; + } + + /** + * Sets account_id + * @param string $account_id The account ID. + * @return $this + */ + public function setAccountId($account_id) + { + $this->container['account_id'] = $account_id; + + return $this; + } + + /** + * Gets account_name + * @return string + */ + public function getAccountName() + { + return $this->container['account_name']; + } + + /** + * Sets account_name + * @param string $account_name The name of the current account. + * @return $this + */ + public function setAccountName($account_name) + { + $this->container['account_name'] = $account_name; + + return $this; + } + + /** + * Gets is_default + * @return string + */ + public function getIsDefault() + { + return $this->container['is_default']; + } + + /** + * Sets is_default + * @param string $is_default + * @return $this + */ + public function setIsDefault($is_default) + { + $this->container['is_default'] = $is_default; + + return $this; + } + + /** + * Gets base_uri + * @return string + */ + public function getBaseUri() + { + return $this->container['base_uri']; + } + + /** + * Sets base_uri + * @param string $base_uri + * @return $this + */ + public function setBaseUri($base_uri) + { + $this->container['base_uri'] = $base_uri; + + return $this; + } + + /** + * Gets organization + * @return string + */ + public function getOrganization() + { + return $this->container['organization']; + } + + /** + * Sets organization + * @param string $organization + * @return $this + */ + public function setOrganization($organization) + { + $this->container['organization'] = $organization; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Client/Auth/Link.php b/src/Client/Auth/Link.php new file mode 100644 index 00000000..0df452cb --- /dev/null +++ b/src/Client/Auth/Link.php @@ -0,0 +1,244 @@ + 'string', + 'href' => 'string', + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'rel' => 'rel', + 'href' => 'href', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'rel' => 'setRel', + 'href' => 'setHref', + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'rel' => 'getRel', + 'href' => 'getHref', + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + /** + * 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['rel'] = isset($data['rel']) ? $data['rel'] : null; + $this->container['href'] = isset($data['href']) ? $data['href'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets rel + * @return string + */ + public function getRel() + { + return $this->container['rel']; + } + + /** + * Sets rel + * @param string $rel + * @return $this + */ + public function setRel($rel) + { + $this->container['rel'] = $rel; + + return $this; + } + + /** + * Gets href + * @return string + */ + public function getHref() + { + return $this->container['href']; + } + + /** + * Sets href + * @param string $href + * @return $this + */ + public function setHref($href) + { + $this->container['href'] = $href; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Client/Auth/OAuth.php b/src/Client/Auth/OAuth.php new file mode 100644 index 00000000..f0f0e3ca --- /dev/null +++ b/src/Client/Auth/OAuth.php @@ -0,0 +1,119 @@ +oAuthBasePath = $oAuthBasePath; + return $this; + } + + //Derive OAuth Base Path if not given. + if (substr($this->getBasePath(), 0, 12) === "https://demo" + || substr($this->getBasePath(), 0, 11) === "https://demo" + ) { + $this->oAuthBasePath = self::$DEMO_OAUTH_BASE_PATH; + } elseif (substr($this->getBasePath(), 0, 13) === "https://stage" + || substr($this->getBasePath(), 0, 12) === "http://stage" + ) { + $this->oAuthBasePath = self::$STAGE_OAUTH_BASE_PATH; + } else { + $this->oAuthBasePath = self::$PRODUCTION_OAUTH_BASE_PATH; + } + + return $this; + } + + /** + * Gets the OAuth base Path + * @return string + */ + public function getOAuthBasePath() + { + if (!$this->oAuthBasePath) { + $this->setOAuthBasePath(); + } + return $this->oAuthBasePath; + } + + /** + * Sets the Rest API base Path + * + * @param string $basePath base path for oAuth + * + * @return OAuth + */ + public function setBasePath($basePath = null) + { + $this->basePath = $basePath; + return $this; + } + + /** + * Returns the Rest API Base path + * + * @return string + */ + public function getBasePath() + { + return $this->basePath; + } + +} diff --git a/src/Client/Auth/OAuthToken.php b/src/Client/Auth/OAuthToken.php new file mode 100644 index 00000000..9d41273c --- /dev/null +++ b/src/Client/Auth/OAuthToken.php @@ -0,0 +1,335 @@ + 'string', + 'data' => '\DocuSign\eSign\Model\NameValue[]', + 'expires_in' => 'string', + 'refresh_token' => 'string', + 'scope' => 'string', + 'token_type' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'access_token' => 'access_token', + 'data' => 'data', + 'expires_in' => 'expires_in', + 'refresh_token' => 'refresh_token', + 'scope' => 'scope', + 'token_type' => 'token_type' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'access_token' => 'setAccessToken', + 'data' => 'setData', + 'expires_in' => 'setExpiresIn', + 'refresh_token' => 'setRefreshToken', + 'scope' => 'setScope', + 'token_type' => 'setTokenType' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'access_token' => 'getAccessToken', + 'data' => 'getData', + 'expires_in' => 'getExpiresIn', + 'refresh_token' => 'getRefreshToken', + 'scope' => 'getScope', + 'token_type' => 'getTokenType' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['access_token'] = isset($data['access_token']) ? $data['access_token'] : null; + $this->container['data'] = isset($data['data']) ? $data['data'] : null; + $this->container['expires_in'] = isset($data['expires_in']) ? $data['expires_in'] : null; + $this->container['refresh_token'] = isset($data['refresh_token']) ? $data['refresh_token'] : null; + $this->container['scope'] = isset($data['scope']) ? $data['scope'] : null; + $this->container['token_type'] = isset($data['token_type']) ? $data['token_type'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets access_token + * @return string + */ + public function getAccessToken() + { + return $this->container['access_token']; + } + + /** + * Sets access_token + * @param string $access_token Access token information. + * @return $this + */ + public function setAccessToken($access_token) + { + $this->container['access_token'] = $access_token; + + return $this; + } + + /** + * Gets data + * @return \DocuSign\eSign\Model\NameValue[] + */ + public function getData() + { + return $this->container['data']; + } + + /** + * Sets data + * @param \DocuSign\eSign\Model\NameValue[] $data + * @return $this + */ + public function setData($data) + { + $this->container['data'] = $data; + + return $this; + } + + /** + * Gets expires_in + * @return string + */ + public function getExpiresIn() + { + return $this->container['expires_in']; + } + + /** + * Sets expires_in + * @param string $expires_in + * @return $this + */ + public function setExpiresIn($expires_in) + { + $this->container['expires_in'] = $expires_in; + + return $this; + } + + /** + * Gets refresh_token + * @return string + */ + public function getRefreshToken() + { + return $this->container['refresh_token']; + } + + /** + * Sets refresh_token + * @param string $refresh_token + * @return $this + */ + public function setRefreshToken($refresh_token) + { + $this->container['refresh_token'] = $refresh_token; + + return $this; + } + + /** + * Gets scope + * @return string + */ + public function getScope() + { + return $this->container['scope']; + } + + /** + * Sets scope + * @param string $scope Must be set to \"api\". + * @return $this + */ + public function setScope($scope) + { + $this->container['scope'] = $scope; + + return $this; + } + + /** + * Gets token_type + * @return string + */ + public function getTokenType() + { + return $this->container['token_type']; + } + + /** + * Sets token_type + * @param string $token_type + * @return $this + */ + public function setTokenType($token_type) + { + $this->container['token_type'] = $token_type; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Client/Auth/Organization.php b/src/Client/Auth/Organization.php new file mode 100644 index 00000000..d123ce72 --- /dev/null +++ b/src/Client/Auth/Organization.php @@ -0,0 +1,256 @@ + 'string', + 'links' => '\DocuSign\eSign\Client\Auth\Link[]', + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'organization_id' => 'organization_id', + 'links' => 'links', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'organization_id' => 'setOrganizationId', + 'links' => 'setLinks', + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'organization_id' => 'getOrganizationId', + 'links' => 'getLinks', + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + /** + * 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['organization_id'] = isset($data['organization_id']) ? $data['organization_id'] : null; + $this->container['links'] = isset($data['links']) ? $data['links'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets organization_id + * @return string + */ + public function getOrganizationId() + { + return $this->container['organization_id']; + } + + /** + * Sets organization_id + * @param string $organization_id + * @return $this + */ + public function setOrganizationId($organization_id) + { + $this->container['organization_id'] = $organization_id; + + return $this; + } + + /** + * Gets links + * @return string + */ + public function getLinks() + { + return $this->container['links']; + } + + /** + * Sets links + * @param string $links + * @return $this + */ + public function setLinks($links) + { + $this->container['links'] = $links; + + return $this; + } + + /** + * Sets links + * @param string $links + * @return $this + */ + public function setHref($links) + { + $this->container['links'] = $links; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Client/Auth/UserInfo.php b/src/Client/Auth/UserInfo.php new file mode 100644 index 00000000..144bc8af --- /dev/null +++ b/src/Client/Auth/UserInfo.php @@ -0,0 +1,401 @@ + 'string', + 'email' => 'string', + 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', + 'accounts' => '\DocuSign\eSign\Client\Auth\Account[]', + 'name' => 'string', + 'given_name' => 'string', + 'family_name' => 'string', + 'created' => 'string', + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'sub' => 'sub', + 'email' => 'email', + 'error_details' => 'error_details', + 'accounts' => 'accounts', + 'name' => 'name', + 'given_name' => 'given_name', + 'family_name' => 'family_name', + 'created' => 'created' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'sub' => 'setSub', + 'email' => 'setEmail', + 'error_details' => 'setErrorDetails', + 'accounts' => 'setAccounts', + 'name' => 'setName', + 'given_name' => 'setGivenName', + 'family_name' => 'setFamilyName', + 'created' => 'setCreated' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'sub' => 'getSub', + 'email' => 'getEmail', + 'error_details' => 'getErrorDetails', + 'accounts' => 'getAccounts', + 'name' => 'getName', + 'given_name' => 'getGivenName', + 'family_name' => 'getFamilyName', + 'created' => 'getCreated' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + /** + * 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['sub'] = isset($data['sub']) ? $data['sub'] : null; + $this->container['email'] = isset($data['email']) ? $data['email'] : null; + $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; + $this->container['accounts'] = isset($data['accounts']) ? $data['accounts'] : null; + $this->container['given_name'] = isset($data['given_name']) ? $data['given_name'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['family_name'] = isset($data['family_name']) ? $data['family_name'] : null; + $this->container['created'] = isset($data['created']) ? $data['created'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets sub + * @return string + */ + public function getSub() + { + return $this->container['sub']; + } + + /** + * Sets sub + * @param string $sub + * @return $this + */ + public function setSub($sub) + { + $this->container['sub'] = $sub; + + return $this; + } + + /** + * Gets email + * @return string + */ + public function getEmail() + { + return $this->container['email']; + } + + /** + * Sets email + * @param string $email + * @return $this + */ + public function setEmail($email) + { + $this->container['email'] = $email; + + return $this; + } + + /** + * Gets error_details + * @return \DocuSign\eSign\Model\ErrorDetails + */ + public function getErrorDetails() + { + return $this->container['error_details']; + } + + /** + * Sets error_details + * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * @return $this + */ + public function setErrorDetails($error_details) + { + $this->container['error_details'] = $error_details; + + return $this; + } + + /** + * Gets accounts + * @return \DocuSign\eSign\Client\Accounts + */ + public function getAccounts() + { + return $this->container['accounts']; + } + + /** + * Sets accounts + * @param \DocuSign\eSign\Client\Accounts $accounts + * @return $this + */ + public function setAccounts($accounts) + { + $this->container['accounts'] = $accounts; + + return $this; + } + + /** + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + + /** + * Gets send_activation_email + * @return string + */ + public function getGivenName() + { + return $this->container['given_name']; + } + + /** + * Sets given_name + * @param string $given_name + * @return $this + */ + public function setGivenName($given_name) + { + $this->container['given_name'] = $given_name; + + return $this; + } + + /** + * Gets family_name + * @return string + */ + public function getFamilyName() + { + return $this->container['family_name']; + } + + /** + * Sets family_name + * @param string $family_name + * @return $this + */ + public function setFamilyName($family_name) + { + $this->container['family_name'] = $family_name; + + return $this; + } + + /** + * Gets created + * @return string + */ + public function getCreated() + { + return $this->container['created']; + } + + /** + * Sets created + * @param string $created + * @return $this + */ + public function setCreated($created) + { + $this->container['created'] = $created; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/AccountAddress.php b/src/Model/AccountAddress.php index e7899d66..37c0cc74 100644 --- a/src/Model/AccountAddress.php +++ b/src/Model/AccountAddress.php @@ -338,7 +338,7 @@ public function getFirstName() /** * Sets first_name - * @param string $first_name The user’s first name. Maximum Length: 50 characters. + * @param string $first_name The user's first name. Maximum Length: 50 characters. * @return $this */ public function setFirstName($first_name) diff --git a/src/Model/AccountBillingPlanResponse.php b/src/Model/AccountBillingPlanResponse.php index 0b91787d..d8945be5 100644 --- a/src/Model/AccountBillingPlanResponse.php +++ b/src/Model/AccountBillingPlanResponse.php @@ -59,6 +59,7 @@ class AccountBillingPlanResponse implements ArrayAccess 'billing_address_is_credit_card_address' => 'string', 'billing_plan' => '\DocuSign\eSign\Model\AccountBillingPlan', 'credit_card_information' => '\DocuSign\eSign\Model\CreditCardInformation', + 'payment_processor_information' => '\DocuSign\eSign\Model\PaymentProcessorInformation', 'referral_information' => '\DocuSign\eSign\Model\ReferralInformation', 'successor_plans' => '\DocuSign\eSign\Model\BillingPlan[]' ]; @@ -77,6 +78,7 @@ public static function swaggerTypes() 'billing_address_is_credit_card_address' => 'billingAddressIsCreditCardAddress', 'billing_plan' => 'billingPlan', 'credit_card_information' => 'creditCardInformation', + 'payment_processor_information' => 'paymentProcessorInformation', 'referral_information' => 'referralInformation', 'successor_plans' => 'successorPlans' ]; @@ -91,6 +93,7 @@ public static function swaggerTypes() 'billing_address_is_credit_card_address' => 'setBillingAddressIsCreditCardAddress', 'billing_plan' => 'setBillingPlan', 'credit_card_information' => 'setCreditCardInformation', + 'payment_processor_information' => 'setPaymentProcessorInformation', 'referral_information' => 'setReferralInformation', 'successor_plans' => 'setSuccessorPlans' ]; @@ -105,6 +108,7 @@ public static function swaggerTypes() 'billing_address_is_credit_card_address' => 'getBillingAddressIsCreditCardAddress', 'billing_plan' => 'getBillingPlan', 'credit_card_information' => 'getCreditCardInformation', + 'payment_processor_information' => 'getPaymentProcessorInformation', 'referral_information' => 'getReferralInformation', 'successor_plans' => 'getSuccessorPlans' ]; @@ -144,6 +148,7 @@ public function __construct(array $data = null) $this->container['billing_address_is_credit_card_address'] = isset($data['billing_address_is_credit_card_address']) ? $data['billing_address_is_credit_card_address'] : null; $this->container['billing_plan'] = isset($data['billing_plan']) ? $data['billing_plan'] : null; $this->container['credit_card_information'] = isset($data['credit_card_information']) ? $data['credit_card_information'] : null; + $this->container['payment_processor_information'] = isset($data['payment_processor_information']) ? $data['payment_processor_information'] : null; $this->container['referral_information'] = isset($data['referral_information']) ? $data['referral_information'] : null; $this->container['successor_plans'] = isset($data['successor_plans']) ? $data['successor_plans'] : null; } @@ -255,6 +260,27 @@ public function setCreditCardInformation($credit_card_information) return $this; } + /** + * Gets payment_processor_information + * @return \DocuSign\eSign\Model\PaymentProcessorInformation + */ + public function getPaymentProcessorInformation() + { + return $this->container['payment_processor_information']; + } + + /** + * Sets payment_processor_information + * @param \DocuSign\eSign\Model\PaymentProcessorInformation $payment_processor_information + * @return $this + */ + public function setPaymentProcessorInformation($payment_processor_information) + { + $this->container['payment_processor_information'] = $payment_processor_information; + + return $this; + } + /** * Gets referral_information * @return \DocuSign\eSign\Model\ReferralInformation diff --git a/src/Model/AccountIdentityVerificationResponse.php b/src/Model/AccountIdentityVerificationResponse.php new file mode 100644 index 00000000..acc2e299 --- /dev/null +++ b/src/Model/AccountIdentityVerificationResponse.php @@ -0,0 +1,227 @@ + '\DocuSign\eSign\Model\AccountIdentityVerificationWorkflow[]' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'identity_verification' => 'identityVerification' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'identity_verification' => 'setIdentityVerification' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'identity_verification' => 'getIdentityVerification' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['identity_verification'] = isset($data['identity_verification']) ? $data['identity_verification'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets identity_verification + * @return \DocuSign\eSign\Model\AccountIdentityVerificationWorkflow[] + */ + public function getIdentityVerification() + { + return $this->container['identity_verification']; + } + + /** + * Sets identity_verification + * @param \DocuSign\eSign\Model\AccountIdentityVerificationWorkflow[] $identity_verification + * @return $this + */ + public function setIdentityVerification($identity_verification) + { + $this->container['identity_verification'] = $identity_verification; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/ViewLinkRequest.php b/src/Model/AccountIdentityVerificationStep.php similarity index 80% rename from src/Model/ViewLinkRequest.php rename to src/Model/AccountIdentityVerificationStep.php index 8ac7b602..30c9285f 100644 --- a/src/Model/ViewLinkRequest.php +++ b/src/Model/AccountIdentityVerificationStep.php @@ -1,6 +1,6 @@ 'string', - 'return_url' => 'string' + 'name' => 'string', + 'type' => 'string' ]; public static function swaggerTypes() @@ -68,8 +68,8 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ - 'email' => 'email', - 'return_url' => 'returnUrl' + 'name' => 'name', + 'type' => 'type' ]; @@ -78,8 +78,8 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ - 'email' => 'setEmail', - 'return_url' => 'setReturnUrl' + 'name' => 'setName', + 'type' => 'setType' ]; @@ -88,8 +88,8 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ - 'email' => 'getEmail', - 'return_url' => 'getReturnUrl' + 'name' => 'getName', + 'type' => 'getType' ]; public static function attributeMap() @@ -123,8 +123,8 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['email'] = isset($data['email']) ? $data['email'] : null; - $this->container['return_url'] = isset($data['return_url']) ? $data['return_url'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['type'] = isset($data['type']) ? $data['type'] : null; } /** @@ -151,43 +151,43 @@ public function valid() /** - * Gets email + * Gets name * @return string */ - public function getEmail() + public function getName() { - return $this->container['email']; + return $this->container['name']; } /** - * Sets email - * @param string $email + * Sets name + * @param string $name * @return $this */ - public function setEmail($email) + public function setName($name) { - $this->container['email'] = $email; + $this->container['name'] = $name; return $this; } /** - * Gets return_url + * Gets type * @return string */ - public function getReturnUrl() + public function getType() { - return $this->container['return_url']; + return $this->container['type']; } /** - * Sets return_url - * @param string $return_url + * Sets type + * @param string $type * @return $this */ - public function setReturnUrl($return_url) + public function setType($type) { - $this->container['return_url'] = $return_url; + $this->container['type'] = $type; return $this; } diff --git a/src/Model/AccountIdentityVerificationWorkflow.php b/src/Model/AccountIdentityVerificationWorkflow.php new file mode 100644 index 00000000..eb8e43ce --- /dev/null +++ b/src/Model/AccountIdentityVerificationWorkflow.php @@ -0,0 +1,279 @@ + 'string', + 'steps' => '\DocuSign\eSign\Model\AccountIdentityVerificationStep[]', + 'workflow_id' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'default_name' => 'defaultName', + 'steps' => 'steps', + 'workflow_id' => 'workflowId' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'default_name' => 'setDefaultName', + 'steps' => 'setSteps', + 'workflow_id' => 'setWorkflowId' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'default_name' => 'getDefaultName', + 'steps' => 'getSteps', + 'workflow_id' => 'getWorkflowId' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['default_name'] = isset($data['default_name']) ? $data['default_name'] : null; + $this->container['steps'] = isset($data['steps']) ? $data['steps'] : null; + $this->container['workflow_id'] = isset($data['workflow_id']) ? $data['workflow_id'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets default_name + * @return string + */ + public function getDefaultName() + { + return $this->container['default_name']; + } + + /** + * Sets default_name + * @param string $default_name + * @return $this + */ + public function setDefaultName($default_name) + { + $this->container['default_name'] = $default_name; + + return $this; + } + + /** + * Gets steps + * @return \DocuSign\eSign\Model\AccountIdentityVerificationStep[] + */ + public function getSteps() + { + return $this->container['steps']; + } + + /** + * Sets steps + * @param \DocuSign\eSign\Model\AccountIdentityVerificationStep[] $steps + * @return $this + */ + public function setSteps($steps) + { + $this->container['steps'] = $steps; + + return $this; + } + + /** + * Gets workflow_id + * @return string + */ + public function getWorkflowId() + { + return $this->container['workflow_id']; + } + + /** + * Sets workflow_id + * @param string $workflow_id + * @return $this + */ + public function setWorkflowId($workflow_id) + { + $this->container['workflow_id'] = $workflow_id; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/AccountInformation.php b/src/Model/AccountInformation.php index de29659d..4c585ae4 100644 --- a/src/Model/AccountInformation.php +++ b/src/Model/AccountInformation.php @@ -74,6 +74,7 @@ class AccountInformation implements ArrayAccess 'docu_sign_landing_url' => 'string', 'envelope_sending_blocked' => 'string', 'envelope_unit_price' => 'string', + 'external_account_id' => 'string', 'forgotten_password_questions_count' => 'string', 'is_downgrade' => 'string', 'payment_method' => 'string', @@ -117,6 +118,7 @@ public static function swaggerTypes() 'docu_sign_landing_url' => 'docuSignLandingUrl', 'envelope_sending_blocked' => 'envelopeSendingBlocked', 'envelope_unit_price' => 'envelopeUnitPrice', + 'external_account_id' => 'externalAccountId', 'forgotten_password_questions_count' => 'forgottenPasswordQuestionsCount', 'is_downgrade' => 'isDowngrade', 'payment_method' => 'paymentMethod', @@ -156,6 +158,7 @@ public static function swaggerTypes() 'docu_sign_landing_url' => 'setDocuSignLandingUrl', 'envelope_sending_blocked' => 'setEnvelopeSendingBlocked', 'envelope_unit_price' => 'setEnvelopeUnitPrice', + 'external_account_id' => 'setExternalAccountId', 'forgotten_password_questions_count' => 'setForgottenPasswordQuestionsCount', 'is_downgrade' => 'setIsDowngrade', 'payment_method' => 'setPaymentMethod', @@ -195,6 +198,7 @@ public static function swaggerTypes() 'docu_sign_landing_url' => 'getDocuSignLandingUrl', 'envelope_sending_blocked' => 'getEnvelopeSendingBlocked', 'envelope_unit_price' => 'getEnvelopeUnitPrice', + 'external_account_id' => 'getExternalAccountId', 'forgotten_password_questions_count' => 'getForgottenPasswordQuestionsCount', 'is_downgrade' => 'getIsDowngrade', 'payment_method' => 'getPaymentMethod', @@ -259,6 +263,7 @@ public function __construct(array $data = null) $this->container['docu_sign_landing_url'] = isset($data['docu_sign_landing_url']) ? $data['docu_sign_landing_url'] : null; $this->container['envelope_sending_blocked'] = isset($data['envelope_sending_blocked']) ? $data['envelope_sending_blocked'] : null; $this->container['envelope_unit_price'] = isset($data['envelope_unit_price']) ? $data['envelope_unit_price'] : null; + $this->container['external_account_id'] = isset($data['external_account_id']) ? $data['external_account_id'] : null; $this->container['forgotten_password_questions_count'] = isset($data['forgotten_password_questions_count']) ? $data['forgotten_password_questions_count'] : null; $this->container['is_downgrade'] = isset($data['is_downgrade']) ? $data['is_downgrade'] : null; $this->container['payment_method'] = isset($data['payment_method']) ? $data['payment_method'] : null; @@ -695,6 +700,27 @@ public function setEnvelopeUnitPrice($envelope_unit_price) return $this; } + /** + * Gets external_account_id + * @return string + */ + public function getExternalAccountId() + { + return $this->container['external_account_id']; + } + + /** + * Sets external_account_id + * @param string $external_account_id + * @return $this + */ + public function setExternalAccountId($external_account_id) + { + $this->container['external_account_id'] = $external_account_id; + + return $this; + } + /** * Gets forgotten_password_questions_count * @return string diff --git a/src/Model/AccountMinimumPasswordLength.php b/src/Model/AccountMinimumPasswordLength.php new file mode 100644 index 00000000..253fed6c --- /dev/null +++ b/src/Model/AccountMinimumPasswordLength.php @@ -0,0 +1,253 @@ + 'string', + 'minimum_length' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'maximum_length' => 'maximumLength', + 'minimum_length' => 'minimumLength' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'maximum_length' => 'setMaximumLength', + 'minimum_length' => 'setMinimumLength' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'maximum_length' => 'getMaximumLength', + 'minimum_length' => 'getMinimumLength' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['maximum_length'] = isset($data['maximum_length']) ? $data['maximum_length'] : null; + $this->container['minimum_length'] = isset($data['minimum_length']) ? $data['minimum_length'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets maximum_length + * @return string + */ + public function getMaximumLength() + { + return $this->container['maximum_length']; + } + + /** + * Sets maximum_length + * @param string $maximum_length + * @return $this + */ + public function setMaximumLength($maximum_length) + { + $this->container['maximum_length'] = $maximum_length; + + return $this; + } + + /** + * Gets minimum_length + * @return string + */ + public function getMinimumLength() + { + return $this->container['minimum_length']; + } + + /** + * Sets minimum_length + * @param string $minimum_length + * @return $this + */ + public function setMinimumLength($minimum_length) + { + $this->container['minimum_length'] = $minimum_length; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/PostTransactionsResponse.php b/src/Model/AccountPasswordExpirePasswordDays.php similarity index 76% rename from src/Model/PostTransactionsResponse.php rename to src/Model/AccountPasswordExpirePasswordDays.php index 2913a2fd..6c557a10 100644 --- a/src/Model/PostTransactionsResponse.php +++ b/src/Model/AccountPasswordExpirePasswordDays.php @@ -1,6 +1,6 @@ 'string', - 'transaction_sid' => 'string' + 'maximum_days' => 'string', + 'minimum_days' => 'string' ]; public static function swaggerTypes() @@ -68,8 +68,8 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ - 'document_data' => 'documentData', - 'transaction_sid' => 'transactionSid' + 'maximum_days' => 'maximumDays', + 'minimum_days' => 'minimumDays' ]; @@ -78,8 +78,8 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ - 'document_data' => 'setDocumentData', - 'transaction_sid' => 'setTransactionSid' + 'maximum_days' => 'setMaximumDays', + 'minimum_days' => 'setMinimumDays' ]; @@ -88,8 +88,8 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ - 'document_data' => 'getDocumentData', - 'transaction_sid' => 'getTransactionSid' + 'maximum_days' => 'getMaximumDays', + 'minimum_days' => 'getMinimumDays' ]; public static function attributeMap() @@ -123,8 +123,8 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['document_data'] = isset($data['document_data']) ? $data['document_data'] : null; - $this->container['transaction_sid'] = isset($data['transaction_sid']) ? $data['transaction_sid'] : null; + $this->container['maximum_days'] = isset($data['maximum_days']) ? $data['maximum_days'] : null; + $this->container['minimum_days'] = isset($data['minimum_days']) ? $data['minimum_days'] : null; } /** @@ -151,43 +151,43 @@ public function valid() /** - * Gets document_data + * Gets maximum_days * @return string */ - public function getDocumentData() + public function getMaximumDays() { - return $this->container['document_data']; + return $this->container['maximum_days']; } /** - * Sets document_data - * @param string $document_data + * Sets maximum_days + * @param string $maximum_days * @return $this */ - public function setDocumentData($document_data) + public function setMaximumDays($maximum_days) { - $this->container['document_data'] = $document_data; + $this->container['maximum_days'] = $maximum_days; return $this; } /** - * Gets transaction_sid + * Gets minimum_days * @return string */ - public function getTransactionSid() + public function getMinimumDays() { - return $this->container['transaction_sid']; + return $this->container['minimum_days']; } /** - * Sets transaction_sid - * @param string $transaction_sid + * Sets minimum_days + * @param string $minimum_days * @return $this */ - public function setTransactionSid($transaction_sid) + public function setMinimumDays($minimum_days) { - $this->container['transaction_sid'] = $transaction_sid; + $this->container['minimum_days'] = $minimum_days; return $this; } diff --git a/src/Model/AccountPasswordLockoutDurationMinutes.php b/src/Model/AccountPasswordLockoutDurationMinutes.php new file mode 100644 index 00000000..d5e17568 --- /dev/null +++ b/src/Model/AccountPasswordLockoutDurationMinutes.php @@ -0,0 +1,253 @@ + 'string', + 'minimum_minutes' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'maximum_minutes' => 'maximumMinutes', + 'minimum_minutes' => 'minimumMinutes' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'maximum_minutes' => 'setMaximumMinutes', + 'minimum_minutes' => 'setMinimumMinutes' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'maximum_minutes' => 'getMaximumMinutes', + 'minimum_minutes' => 'getMinimumMinutes' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['maximum_minutes'] = isset($data['maximum_minutes']) ? $data['maximum_minutes'] : null; + $this->container['minimum_minutes'] = isset($data['minimum_minutes']) ? $data['minimum_minutes'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets maximum_minutes + * @return string + */ + public function getMaximumMinutes() + { + return $this->container['maximum_minutes']; + } + + /** + * Sets maximum_minutes + * @param string $maximum_minutes + * @return $this + */ + public function setMaximumMinutes($maximum_minutes) + { + $this->container['maximum_minutes'] = $maximum_minutes; + + return $this; + } + + /** + * Gets minimum_minutes + * @return string + */ + public function getMinimumMinutes() + { + return $this->container['minimum_minutes']; + } + + /** + * Sets minimum_minutes + * @param string $minimum_minutes + * @return $this + */ + public function setMinimumMinutes($minimum_minutes) + { + $this->container['minimum_minutes'] = $minimum_minutes; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/AccountPasswordLockoutDurationType.php b/src/Model/AccountPasswordLockoutDurationType.php new file mode 100644 index 00000000..635d4aeb --- /dev/null +++ b/src/Model/AccountPasswordLockoutDurationType.php @@ -0,0 +1,227 @@ + 'string[]' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'options' => 'options' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'options' => 'setOptions' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'options' => 'getOptions' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['options'] = isset($data['options']) ? $data['options'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets options + * @return string[] + */ + public function getOptions() + { + return $this->container['options']; + } + + /** + * Sets options + * @param string[] $options + * @return $this + */ + public function setOptions($options) + { + $this->container['options'] = $options; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/AccountPasswordMinimumPasswordAgeDays.php b/src/Model/AccountPasswordMinimumPasswordAgeDays.php new file mode 100644 index 00000000..cb65bfa9 --- /dev/null +++ b/src/Model/AccountPasswordMinimumPasswordAgeDays.php @@ -0,0 +1,253 @@ + 'string', + 'minimum_age' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'maximum_age' => 'maximumAge', + 'minimum_age' => 'minimumAge' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'maximum_age' => 'setMaximumAge', + 'minimum_age' => 'setMinimumAge' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'maximum_age' => 'getMaximumAge', + 'minimum_age' => 'getMinimumAge' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['maximum_age'] = isset($data['maximum_age']) ? $data['maximum_age'] : null; + $this->container['minimum_age'] = isset($data['minimum_age']) ? $data['minimum_age'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets maximum_age + * @return string + */ + public function getMaximumAge() + { + return $this->container['maximum_age']; + } + + /** + * Sets maximum_age + * @param string $maximum_age + * @return $this + */ + public function setMaximumAge($maximum_age) + { + $this->container['maximum_age'] = $maximum_age; + + return $this; + } + + /** + * Gets minimum_age + * @return string + */ + public function getMinimumAge() + { + return $this->container['minimum_age']; + } + + /** + * Sets minimum_age + * @param string $minimum_age + * @return $this + */ + public function setMinimumAge($minimum_age) + { + $this->container['minimum_age'] = $minimum_age; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/AccountPasswordQuestionsRequired.php b/src/Model/AccountPasswordQuestionsRequired.php new file mode 100644 index 00000000..3f492a5c --- /dev/null +++ b/src/Model/AccountPasswordQuestionsRequired.php @@ -0,0 +1,253 @@ + 'string', + 'minimum_questions' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'maximum_questions' => 'maximumQuestions', + 'minimum_questions' => 'minimumQuestions' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'maximum_questions' => 'setMaximumQuestions', + 'minimum_questions' => 'setMinimumQuestions' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'maximum_questions' => 'getMaximumQuestions', + 'minimum_questions' => 'getMinimumQuestions' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['maximum_questions'] = isset($data['maximum_questions']) ? $data['maximum_questions'] : null; + $this->container['minimum_questions'] = isset($data['minimum_questions']) ? $data['minimum_questions'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets maximum_questions + * @return string + */ + public function getMaximumQuestions() + { + return $this->container['maximum_questions']; + } + + /** + * Sets maximum_questions + * @param string $maximum_questions + * @return $this + */ + public function setMaximumQuestions($maximum_questions) + { + $this->container['maximum_questions'] = $maximum_questions; + + return $this; + } + + /** + * Gets minimum_questions + * @return string + */ + public function getMinimumQuestions() + { + return $this->container['minimum_questions']; + } + + /** + * Sets minimum_questions + * @param string $minimum_questions + * @return $this + */ + public function setMinimumQuestions($minimum_questions) + { + $this->container['minimum_questions'] = $minimum_questions; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/AccountPasswordRules.php b/src/Model/AccountPasswordRules.php new file mode 100644 index 00000000..8c6ba48a --- /dev/null +++ b/src/Model/AccountPasswordRules.php @@ -0,0 +1,721 @@ + 'string', + 'expire_password_days' => 'string', + 'expire_password_days_metadata' => '\DocuSign\eSign\Model\AccountPasswordExpirePasswordDays', + 'lockout_duration_minutes' => 'string', + 'lockout_duration_minutes_metadata' => '\DocuSign\eSign\Model\AccountPasswordLockoutDurationMinutes', + 'lockout_duration_type' => 'string', + 'lockout_duration_type_metadata' => '\DocuSign\eSign\Model\AccountPasswordLockoutDurationType', + 'minimum_password_age_days' => 'string', + 'minimum_password_age_days_metadata' => '\DocuSign\eSign\Model\AccountPasswordMinimumPasswordAgeDays', + 'minimum_password_length' => 'string', + 'minimum_password_length_metadata' => '\DocuSign\eSign\Model\AccountMinimumPasswordLength', + 'password_include_digit' => 'string', + 'password_include_digit_or_special_character' => 'string', + 'password_include_lower_case' => 'string', + 'password_include_special_character' => 'string', + 'password_include_upper_case' => 'string', + 'password_strength_type' => 'string', + 'password_strength_type_metadata' => '\DocuSign\eSign\Model\AccountPasswordStrengthType', + 'questions_required' => 'string', + 'questions_required_metadata' => '\DocuSign\eSign\Model\AccountPasswordQuestionsRequired' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'expire_password' => 'expirePassword', + 'expire_password_days' => 'expirePasswordDays', + 'expire_password_days_metadata' => 'expirePasswordDaysMetadata', + 'lockout_duration_minutes' => 'lockoutDurationMinutes', + 'lockout_duration_minutes_metadata' => 'lockoutDurationMinutesMetadata', + 'lockout_duration_type' => 'lockoutDurationType', + 'lockout_duration_type_metadata' => 'lockoutDurationTypeMetadata', + 'minimum_password_age_days' => 'minimumPasswordAgeDays', + 'minimum_password_age_days_metadata' => 'minimumPasswordAgeDaysMetadata', + 'minimum_password_length' => 'minimumPasswordLength', + 'minimum_password_length_metadata' => 'minimumPasswordLengthMetadata', + 'password_include_digit' => 'passwordIncludeDigit', + 'password_include_digit_or_special_character' => 'passwordIncludeDigitOrSpecialCharacter', + 'password_include_lower_case' => 'passwordIncludeLowerCase', + 'password_include_special_character' => 'passwordIncludeSpecialCharacter', + 'password_include_upper_case' => 'passwordIncludeUpperCase', + 'password_strength_type' => 'passwordStrengthType', + 'password_strength_type_metadata' => 'passwordStrengthTypeMetadata', + 'questions_required' => 'questionsRequired', + 'questions_required_metadata' => 'questionsRequiredMetadata' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'expire_password' => 'setExpirePassword', + 'expire_password_days' => 'setExpirePasswordDays', + 'expire_password_days_metadata' => 'setExpirePasswordDaysMetadata', + 'lockout_duration_minutes' => 'setLockoutDurationMinutes', + 'lockout_duration_minutes_metadata' => 'setLockoutDurationMinutesMetadata', + 'lockout_duration_type' => 'setLockoutDurationType', + 'lockout_duration_type_metadata' => 'setLockoutDurationTypeMetadata', + 'minimum_password_age_days' => 'setMinimumPasswordAgeDays', + 'minimum_password_age_days_metadata' => 'setMinimumPasswordAgeDaysMetadata', + 'minimum_password_length' => 'setMinimumPasswordLength', + 'minimum_password_length_metadata' => 'setMinimumPasswordLengthMetadata', + 'password_include_digit' => 'setPasswordIncludeDigit', + 'password_include_digit_or_special_character' => 'setPasswordIncludeDigitOrSpecialCharacter', + 'password_include_lower_case' => 'setPasswordIncludeLowerCase', + 'password_include_special_character' => 'setPasswordIncludeSpecialCharacter', + 'password_include_upper_case' => 'setPasswordIncludeUpperCase', + 'password_strength_type' => 'setPasswordStrengthType', + 'password_strength_type_metadata' => 'setPasswordStrengthTypeMetadata', + 'questions_required' => 'setQuestionsRequired', + 'questions_required_metadata' => 'setQuestionsRequiredMetadata' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'expire_password' => 'getExpirePassword', + 'expire_password_days' => 'getExpirePasswordDays', + 'expire_password_days_metadata' => 'getExpirePasswordDaysMetadata', + 'lockout_duration_minutes' => 'getLockoutDurationMinutes', + 'lockout_duration_minutes_metadata' => 'getLockoutDurationMinutesMetadata', + 'lockout_duration_type' => 'getLockoutDurationType', + 'lockout_duration_type_metadata' => 'getLockoutDurationTypeMetadata', + 'minimum_password_age_days' => 'getMinimumPasswordAgeDays', + 'minimum_password_age_days_metadata' => 'getMinimumPasswordAgeDaysMetadata', + 'minimum_password_length' => 'getMinimumPasswordLength', + 'minimum_password_length_metadata' => 'getMinimumPasswordLengthMetadata', + 'password_include_digit' => 'getPasswordIncludeDigit', + 'password_include_digit_or_special_character' => 'getPasswordIncludeDigitOrSpecialCharacter', + 'password_include_lower_case' => 'getPasswordIncludeLowerCase', + 'password_include_special_character' => 'getPasswordIncludeSpecialCharacter', + 'password_include_upper_case' => 'getPasswordIncludeUpperCase', + 'password_strength_type' => 'getPasswordStrengthType', + 'password_strength_type_metadata' => 'getPasswordStrengthTypeMetadata', + 'questions_required' => 'getQuestionsRequired', + 'questions_required_metadata' => 'getQuestionsRequiredMetadata' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['expire_password'] = isset($data['expire_password']) ? $data['expire_password'] : null; + $this->container['expire_password_days'] = isset($data['expire_password_days']) ? $data['expire_password_days'] : null; + $this->container['expire_password_days_metadata'] = isset($data['expire_password_days_metadata']) ? $data['expire_password_days_metadata'] : null; + $this->container['lockout_duration_minutes'] = isset($data['lockout_duration_minutes']) ? $data['lockout_duration_minutes'] : null; + $this->container['lockout_duration_minutes_metadata'] = isset($data['lockout_duration_minutes_metadata']) ? $data['lockout_duration_minutes_metadata'] : null; + $this->container['lockout_duration_type'] = isset($data['lockout_duration_type']) ? $data['lockout_duration_type'] : null; + $this->container['lockout_duration_type_metadata'] = isset($data['lockout_duration_type_metadata']) ? $data['lockout_duration_type_metadata'] : null; + $this->container['minimum_password_age_days'] = isset($data['minimum_password_age_days']) ? $data['minimum_password_age_days'] : null; + $this->container['minimum_password_age_days_metadata'] = isset($data['minimum_password_age_days_metadata']) ? $data['minimum_password_age_days_metadata'] : null; + $this->container['minimum_password_length'] = isset($data['minimum_password_length']) ? $data['minimum_password_length'] : null; + $this->container['minimum_password_length_metadata'] = isset($data['minimum_password_length_metadata']) ? $data['minimum_password_length_metadata'] : null; + $this->container['password_include_digit'] = isset($data['password_include_digit']) ? $data['password_include_digit'] : null; + $this->container['password_include_digit_or_special_character'] = isset($data['password_include_digit_or_special_character']) ? $data['password_include_digit_or_special_character'] : null; + $this->container['password_include_lower_case'] = isset($data['password_include_lower_case']) ? $data['password_include_lower_case'] : null; + $this->container['password_include_special_character'] = isset($data['password_include_special_character']) ? $data['password_include_special_character'] : null; + $this->container['password_include_upper_case'] = isset($data['password_include_upper_case']) ? $data['password_include_upper_case'] : null; + $this->container['password_strength_type'] = isset($data['password_strength_type']) ? $data['password_strength_type'] : null; + $this->container['password_strength_type_metadata'] = isset($data['password_strength_type_metadata']) ? $data['password_strength_type_metadata'] : null; + $this->container['questions_required'] = isset($data['questions_required']) ? $data['questions_required'] : null; + $this->container['questions_required_metadata'] = isset($data['questions_required_metadata']) ? $data['questions_required_metadata'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets expire_password + * @return string + */ + public function getExpirePassword() + { + return $this->container['expire_password']; + } + + /** + * Sets expire_password + * @param string $expire_password + * @return $this + */ + public function setExpirePassword($expire_password) + { + $this->container['expire_password'] = $expire_password; + + return $this; + } + + /** + * Gets expire_password_days + * @return string + */ + public function getExpirePasswordDays() + { + return $this->container['expire_password_days']; + } + + /** + * Sets expire_password_days + * @param string $expire_password_days + * @return $this + */ + public function setExpirePasswordDays($expire_password_days) + { + $this->container['expire_password_days'] = $expire_password_days; + + return $this; + } + + /** + * Gets expire_password_days_metadata + * @return \DocuSign\eSign\Model\AccountPasswordExpirePasswordDays + */ + public function getExpirePasswordDaysMetadata() + { + return $this->container['expire_password_days_metadata']; + } + + /** + * Sets expire_password_days_metadata + * @param \DocuSign\eSign\Model\AccountPasswordExpirePasswordDays $expire_password_days_metadata + * @return $this + */ + public function setExpirePasswordDaysMetadata($expire_password_days_metadata) + { + $this->container['expire_password_days_metadata'] = $expire_password_days_metadata; + + return $this; + } + + /** + * Gets lockout_duration_minutes + * @return string + */ + public function getLockoutDurationMinutes() + { + return $this->container['lockout_duration_minutes']; + } + + /** + * Sets lockout_duration_minutes + * @param string $lockout_duration_minutes + * @return $this + */ + public function setLockoutDurationMinutes($lockout_duration_minutes) + { + $this->container['lockout_duration_minutes'] = $lockout_duration_minutes; + + return $this; + } + + /** + * Gets lockout_duration_minutes_metadata + * @return \DocuSign\eSign\Model\AccountPasswordLockoutDurationMinutes + */ + public function getLockoutDurationMinutesMetadata() + { + return $this->container['lockout_duration_minutes_metadata']; + } + + /** + * Sets lockout_duration_minutes_metadata + * @param \DocuSign\eSign\Model\AccountPasswordLockoutDurationMinutes $lockout_duration_minutes_metadata + * @return $this + */ + public function setLockoutDurationMinutesMetadata($lockout_duration_minutes_metadata) + { + $this->container['lockout_duration_minutes_metadata'] = $lockout_duration_minutes_metadata; + + return $this; + } + + /** + * Gets lockout_duration_type + * @return string + */ + public function getLockoutDurationType() + { + return $this->container['lockout_duration_type']; + } + + /** + * Sets lockout_duration_type + * @param string $lockout_duration_type + * @return $this + */ + public function setLockoutDurationType($lockout_duration_type) + { + $this->container['lockout_duration_type'] = $lockout_duration_type; + + return $this; + } + + /** + * Gets lockout_duration_type_metadata + * @return \DocuSign\eSign\Model\AccountPasswordLockoutDurationType + */ + public function getLockoutDurationTypeMetadata() + { + return $this->container['lockout_duration_type_metadata']; + } + + /** + * Sets lockout_duration_type_metadata + * @param \DocuSign\eSign\Model\AccountPasswordLockoutDurationType $lockout_duration_type_metadata + * @return $this + */ + public function setLockoutDurationTypeMetadata($lockout_duration_type_metadata) + { + $this->container['lockout_duration_type_metadata'] = $lockout_duration_type_metadata; + + return $this; + } + + /** + * Gets minimum_password_age_days + * @return string + */ + public function getMinimumPasswordAgeDays() + { + return $this->container['minimum_password_age_days']; + } + + /** + * Sets minimum_password_age_days + * @param string $minimum_password_age_days + * @return $this + */ + public function setMinimumPasswordAgeDays($minimum_password_age_days) + { + $this->container['minimum_password_age_days'] = $minimum_password_age_days; + + return $this; + } + + /** + * Gets minimum_password_age_days_metadata + * @return \DocuSign\eSign\Model\AccountPasswordMinimumPasswordAgeDays + */ + public function getMinimumPasswordAgeDaysMetadata() + { + return $this->container['minimum_password_age_days_metadata']; + } + + /** + * Sets minimum_password_age_days_metadata + * @param \DocuSign\eSign\Model\AccountPasswordMinimumPasswordAgeDays $minimum_password_age_days_metadata + * @return $this + */ + public function setMinimumPasswordAgeDaysMetadata($minimum_password_age_days_metadata) + { + $this->container['minimum_password_age_days_metadata'] = $minimum_password_age_days_metadata; + + return $this; + } + + /** + * Gets minimum_password_length + * @return string + */ + public function getMinimumPasswordLength() + { + return $this->container['minimum_password_length']; + } + + /** + * Sets minimum_password_length + * @param string $minimum_password_length + * @return $this + */ + public function setMinimumPasswordLength($minimum_password_length) + { + $this->container['minimum_password_length'] = $minimum_password_length; + + return $this; + } + + /** + * Gets minimum_password_length_metadata + * @return \DocuSign\eSign\Model\AccountMinimumPasswordLength + */ + public function getMinimumPasswordLengthMetadata() + { + return $this->container['minimum_password_length_metadata']; + } + + /** + * Sets minimum_password_length_metadata + * @param \DocuSign\eSign\Model\AccountMinimumPasswordLength $minimum_password_length_metadata + * @return $this + */ + public function setMinimumPasswordLengthMetadata($minimum_password_length_metadata) + { + $this->container['minimum_password_length_metadata'] = $minimum_password_length_metadata; + + return $this; + } + + /** + * Gets password_include_digit + * @return string + */ + public function getPasswordIncludeDigit() + { + return $this->container['password_include_digit']; + } + + /** + * Sets password_include_digit + * @param string $password_include_digit + * @return $this + */ + public function setPasswordIncludeDigit($password_include_digit) + { + $this->container['password_include_digit'] = $password_include_digit; + + return $this; + } + + /** + * Gets password_include_digit_or_special_character + * @return string + */ + public function getPasswordIncludeDigitOrSpecialCharacter() + { + return $this->container['password_include_digit_or_special_character']; + } + + /** + * Sets password_include_digit_or_special_character + * @param string $password_include_digit_or_special_character + * @return $this + */ + public function setPasswordIncludeDigitOrSpecialCharacter($password_include_digit_or_special_character) + { + $this->container['password_include_digit_or_special_character'] = $password_include_digit_or_special_character; + + return $this; + } + + /** + * Gets password_include_lower_case + * @return string + */ + public function getPasswordIncludeLowerCase() + { + return $this->container['password_include_lower_case']; + } + + /** + * Sets password_include_lower_case + * @param string $password_include_lower_case + * @return $this + */ + public function setPasswordIncludeLowerCase($password_include_lower_case) + { + $this->container['password_include_lower_case'] = $password_include_lower_case; + + return $this; + } + + /** + * Gets password_include_special_character + * @return string + */ + public function getPasswordIncludeSpecialCharacter() + { + return $this->container['password_include_special_character']; + } + + /** + * Sets password_include_special_character + * @param string $password_include_special_character + * @return $this + */ + public function setPasswordIncludeSpecialCharacter($password_include_special_character) + { + $this->container['password_include_special_character'] = $password_include_special_character; + + return $this; + } + + /** + * Gets password_include_upper_case + * @return string + */ + public function getPasswordIncludeUpperCase() + { + return $this->container['password_include_upper_case']; + } + + /** + * Sets password_include_upper_case + * @param string $password_include_upper_case + * @return $this + */ + public function setPasswordIncludeUpperCase($password_include_upper_case) + { + $this->container['password_include_upper_case'] = $password_include_upper_case; + + return $this; + } + + /** + * Gets password_strength_type + * @return string + */ + public function getPasswordStrengthType() + { + return $this->container['password_strength_type']; + } + + /** + * Sets password_strength_type + * @param string $password_strength_type + * @return $this + */ + public function setPasswordStrengthType($password_strength_type) + { + $this->container['password_strength_type'] = $password_strength_type; + + return $this; + } + + /** + * Gets password_strength_type_metadata + * @return \DocuSign\eSign\Model\AccountPasswordStrengthType + */ + public function getPasswordStrengthTypeMetadata() + { + return $this->container['password_strength_type_metadata']; + } + + /** + * Sets password_strength_type_metadata + * @param \DocuSign\eSign\Model\AccountPasswordStrengthType $password_strength_type_metadata + * @return $this + */ + public function setPasswordStrengthTypeMetadata($password_strength_type_metadata) + { + $this->container['password_strength_type_metadata'] = $password_strength_type_metadata; + + return $this; + } + + /** + * Gets questions_required + * @return string + */ + public function getQuestionsRequired() + { + return $this->container['questions_required']; + } + + /** + * Sets questions_required + * @param string $questions_required + * @return $this + */ + public function setQuestionsRequired($questions_required) + { + $this->container['questions_required'] = $questions_required; + + return $this; + } + + /** + * Gets questions_required_metadata + * @return \DocuSign\eSign\Model\AccountPasswordQuestionsRequired + */ + public function getQuestionsRequiredMetadata() + { + return $this->container['questions_required_metadata']; + } + + /** + * Sets questions_required_metadata + * @param \DocuSign\eSign\Model\AccountPasswordQuestionsRequired $questions_required_metadata + * @return $this + */ + public function setQuestionsRequiredMetadata($questions_required_metadata) + { + $this->container['questions_required_metadata'] = $questions_required_metadata; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/AccountPasswordStrengthType.php b/src/Model/AccountPasswordStrengthType.php new file mode 100644 index 00000000..c217ef0f --- /dev/null +++ b/src/Model/AccountPasswordStrengthType.php @@ -0,0 +1,227 @@ + '\DocuSign\eSign\Model\AccountPasswordStrengthTypeOption[]' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'options' => 'options' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'options' => 'setOptions' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'options' => 'getOptions' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['options'] = isset($data['options']) ? $data['options'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets options + * @return \DocuSign\eSign\Model\AccountPasswordStrengthTypeOption[] + */ + public function getOptions() + { + return $this->container['options']; + } + + /** + * Sets options + * @param \DocuSign\eSign\Model\AccountPasswordStrengthTypeOption[] $options + * @return $this + */ + public function setOptions($options) + { + $this->container['options'] = $options; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/AccountPasswordStrengthTypeOption.php b/src/Model/AccountPasswordStrengthTypeOption.php new file mode 100644 index 00000000..83b4b078 --- /dev/null +++ b/src/Model/AccountPasswordStrengthTypeOption.php @@ -0,0 +1,383 @@ + 'string', + 'name' => 'string', + 'password_include_digit' => 'string', + 'password_include_digit_or_special_character' => 'string', + 'password_include_lower_case' => 'string', + 'password_include_special_character' => 'string', + 'password_include_upper_case' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'minimum_length' => 'minimumLength', + 'name' => 'name', + 'password_include_digit' => 'passwordIncludeDigit', + 'password_include_digit_or_special_character' => 'passwordIncludeDigitOrSpecialCharacter', + 'password_include_lower_case' => 'passwordIncludeLowerCase', + 'password_include_special_character' => 'passwordIncludeSpecialCharacter', + 'password_include_upper_case' => 'passwordIncludeUpperCase' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'minimum_length' => 'setMinimumLength', + 'name' => 'setName', + 'password_include_digit' => 'setPasswordIncludeDigit', + 'password_include_digit_or_special_character' => 'setPasswordIncludeDigitOrSpecialCharacter', + 'password_include_lower_case' => 'setPasswordIncludeLowerCase', + 'password_include_special_character' => 'setPasswordIncludeSpecialCharacter', + 'password_include_upper_case' => 'setPasswordIncludeUpperCase' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'minimum_length' => 'getMinimumLength', + 'name' => 'getName', + 'password_include_digit' => 'getPasswordIncludeDigit', + 'password_include_digit_or_special_character' => 'getPasswordIncludeDigitOrSpecialCharacter', + 'password_include_lower_case' => 'getPasswordIncludeLowerCase', + 'password_include_special_character' => 'getPasswordIncludeSpecialCharacter', + 'password_include_upper_case' => 'getPasswordIncludeUpperCase' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['minimum_length'] = isset($data['minimum_length']) ? $data['minimum_length'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['password_include_digit'] = isset($data['password_include_digit']) ? $data['password_include_digit'] : null; + $this->container['password_include_digit_or_special_character'] = isset($data['password_include_digit_or_special_character']) ? $data['password_include_digit_or_special_character'] : null; + $this->container['password_include_lower_case'] = isset($data['password_include_lower_case']) ? $data['password_include_lower_case'] : null; + $this->container['password_include_special_character'] = isset($data['password_include_special_character']) ? $data['password_include_special_character'] : null; + $this->container['password_include_upper_case'] = isset($data['password_include_upper_case']) ? $data['password_include_upper_case'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets minimum_length + * @return string + */ + public function getMinimumLength() + { + return $this->container['minimum_length']; + } + + /** + * Sets minimum_length + * @param string $minimum_length + * @return $this + */ + public function setMinimumLength($minimum_length) + { + $this->container['minimum_length'] = $minimum_length; + + return $this; + } + + /** + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + + /** + * Gets password_include_digit + * @return string + */ + public function getPasswordIncludeDigit() + { + return $this->container['password_include_digit']; + } + + /** + * Sets password_include_digit + * @param string $password_include_digit + * @return $this + */ + public function setPasswordIncludeDigit($password_include_digit) + { + $this->container['password_include_digit'] = $password_include_digit; + + return $this; + } + + /** + * Gets password_include_digit_or_special_character + * @return string + */ + public function getPasswordIncludeDigitOrSpecialCharacter() + { + return $this->container['password_include_digit_or_special_character']; + } + + /** + * Sets password_include_digit_or_special_character + * @param string $password_include_digit_or_special_character + * @return $this + */ + public function setPasswordIncludeDigitOrSpecialCharacter($password_include_digit_or_special_character) + { + $this->container['password_include_digit_or_special_character'] = $password_include_digit_or_special_character; + + return $this; + } + + /** + * Gets password_include_lower_case + * @return string + */ + public function getPasswordIncludeLowerCase() + { + return $this->container['password_include_lower_case']; + } + + /** + * Sets password_include_lower_case + * @param string $password_include_lower_case + * @return $this + */ + public function setPasswordIncludeLowerCase($password_include_lower_case) + { + $this->container['password_include_lower_case'] = $password_include_lower_case; + + return $this; + } + + /** + * Gets password_include_special_character + * @return string + */ + public function getPasswordIncludeSpecialCharacter() + { + return $this->container['password_include_special_character']; + } + + /** + * Sets password_include_special_character + * @param string $password_include_special_character + * @return $this + */ + public function setPasswordIncludeSpecialCharacter($password_include_special_character) + { + $this->container['password_include_special_character'] = $password_include_special_character; + + return $this; + } + + /** + * Gets password_include_upper_case + * @return string + */ + public function getPasswordIncludeUpperCase() + { + return $this->container['password_include_upper_case']; + } + + /** + * Sets password_include_upper_case + * @param string $password_include_upper_case + * @return $this + */ + public function setPasswordIncludeUpperCase($password_include_upper_case) + { + $this->container['password_include_upper_case'] = $password_include_upper_case; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/AccountRoleSettings.php b/src/Model/AccountRoleSettings.php index 069d1bb0..73f311b4 100644 --- a/src/Model/AccountRoleSettings.php +++ b/src/Model/AccountRoleSettings.php @@ -76,6 +76,10 @@ class AccountRoleSettings implements ArrayAccess 'allowed_to_be_envelope_transfer_recipient_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', 'allow_envelope_sending' => 'string', 'allow_envelope_sending_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', + 'allow_e_seal_recipients' => 'string', + 'allow_e_seal_recipients_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', + 'allow_power_forms_admin_to_access_all_power_form_envelopes' => 'string', + 'allow_power_forms_admin_to_access_all_power_form_envelopes_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', 'allow_senders_to_set_recipient_email_language' => 'string', 'allow_senders_to_set_recipient_email_language_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', 'allow_signer_attachments' => 'string', @@ -152,6 +156,10 @@ public static function swaggerTypes() 'allowed_to_be_envelope_transfer_recipient_metadata' => 'allowedToBeEnvelopeTransferRecipientMetadata', 'allow_envelope_sending' => 'allowEnvelopeSending', 'allow_envelope_sending_metadata' => 'allowEnvelopeSendingMetadata', + 'allow_e_seal_recipients' => 'allowESealRecipients', + 'allow_e_seal_recipients_metadata' => 'allowESealRecipientsMetadata', + 'allow_power_forms_admin_to_access_all_power_form_envelopes' => 'allowPowerFormsAdminToAccessAllPowerFormEnvelopes', + 'allow_power_forms_admin_to_access_all_power_form_envelopes_metadata' => 'allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata', 'allow_senders_to_set_recipient_email_language' => 'allowSendersToSetRecipientEmailLanguage', 'allow_senders_to_set_recipient_email_language_metadata' => 'allowSendersToSetRecipientEmailLanguageMetadata', 'allow_signer_attachments' => 'allowSignerAttachments', @@ -224,6 +232,10 @@ public static function swaggerTypes() 'allowed_to_be_envelope_transfer_recipient_metadata' => 'setAllowedToBeEnvelopeTransferRecipientMetadata', 'allow_envelope_sending' => 'setAllowEnvelopeSending', 'allow_envelope_sending_metadata' => 'setAllowEnvelopeSendingMetadata', + 'allow_e_seal_recipients' => 'setAllowESealRecipients', + 'allow_e_seal_recipients_metadata' => 'setAllowESealRecipientsMetadata', + 'allow_power_forms_admin_to_access_all_power_form_envelopes' => 'setAllowPowerFormsAdminToAccessAllPowerFormEnvelopes', + 'allow_power_forms_admin_to_access_all_power_form_envelopes_metadata' => 'setAllowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata', 'allow_senders_to_set_recipient_email_language' => 'setAllowSendersToSetRecipientEmailLanguage', 'allow_senders_to_set_recipient_email_language_metadata' => 'setAllowSendersToSetRecipientEmailLanguageMetadata', 'allow_signer_attachments' => 'setAllowSignerAttachments', @@ -296,6 +308,10 @@ public static function swaggerTypes() 'allowed_to_be_envelope_transfer_recipient_metadata' => 'getAllowedToBeEnvelopeTransferRecipientMetadata', 'allow_envelope_sending' => 'getAllowEnvelopeSending', 'allow_envelope_sending_metadata' => 'getAllowEnvelopeSendingMetadata', + 'allow_e_seal_recipients' => 'getAllowESealRecipients', + 'allow_e_seal_recipients_metadata' => 'getAllowESealRecipientsMetadata', + 'allow_power_forms_admin_to_access_all_power_form_envelopes' => 'getAllowPowerFormsAdminToAccessAllPowerFormEnvelopes', + 'allow_power_forms_admin_to_access_all_power_form_envelopes_metadata' => 'getAllowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata', 'allow_senders_to_set_recipient_email_language' => 'getAllowSendersToSetRecipientEmailLanguage', 'allow_senders_to_set_recipient_email_language_metadata' => 'getAllowSendersToSetRecipientEmailLanguageMetadata', 'allow_signer_attachments' => 'getAllowSignerAttachments', @@ -393,6 +409,10 @@ public function __construct(array $data = null) $this->container['allowed_to_be_envelope_transfer_recipient_metadata'] = isset($data['allowed_to_be_envelope_transfer_recipient_metadata']) ? $data['allowed_to_be_envelope_transfer_recipient_metadata'] : null; $this->container['allow_envelope_sending'] = isset($data['allow_envelope_sending']) ? $data['allow_envelope_sending'] : null; $this->container['allow_envelope_sending_metadata'] = isset($data['allow_envelope_sending_metadata']) ? $data['allow_envelope_sending_metadata'] : null; + $this->container['allow_e_seal_recipients'] = isset($data['allow_e_seal_recipients']) ? $data['allow_e_seal_recipients'] : null; + $this->container['allow_e_seal_recipients_metadata'] = isset($data['allow_e_seal_recipients_metadata']) ? $data['allow_e_seal_recipients_metadata'] : null; + $this->container['allow_power_forms_admin_to_access_all_power_form_envelopes'] = isset($data['allow_power_forms_admin_to_access_all_power_form_envelopes']) ? $data['allow_power_forms_admin_to_access_all_power_form_envelopes'] : null; + $this->container['allow_power_forms_admin_to_access_all_power_form_envelopes_metadata'] = isset($data['allow_power_forms_admin_to_access_all_power_form_envelopes_metadata']) ? $data['allow_power_forms_admin_to_access_all_power_form_envelopes_metadata'] : null; $this->container['allow_senders_to_set_recipient_email_language'] = isset($data['allow_senders_to_set_recipient_email_language']) ? $data['allow_senders_to_set_recipient_email_language'] : null; $this->container['allow_senders_to_set_recipient_email_language_metadata'] = isset($data['allow_senders_to_set_recipient_email_language_metadata']) ? $data['allow_senders_to_set_recipient_email_language_metadata'] : null; $this->container['allow_signer_attachments'] = isset($data['allow_signer_attachments']) ? $data['allow_signer_attachments'] : null; @@ -922,6 +942,90 @@ public function setAllowEnvelopeSendingMetadata($allow_envelope_sending_metadata return $this; } + /** + * Gets allow_e_seal_recipients + * @return string + */ + public function getAllowESealRecipients() + { + return $this->container['allow_e_seal_recipients']; + } + + /** + * Sets allow_e_seal_recipients + * @param string $allow_e_seal_recipients + * @return $this + */ + public function setAllowESealRecipients($allow_e_seal_recipients) + { + $this->container['allow_e_seal_recipients'] = $allow_e_seal_recipients; + + return $this; + } + + /** + * Gets allow_e_seal_recipients_metadata + * @return \DocuSign\eSign\Model\SettingsMetadata + */ + public function getAllowESealRecipientsMetadata() + { + return $this->container['allow_e_seal_recipients_metadata']; + } + + /** + * Sets allow_e_seal_recipients_metadata + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_e_seal_recipients_metadata + * @return $this + */ + public function setAllowESealRecipientsMetadata($allow_e_seal_recipients_metadata) + { + $this->container['allow_e_seal_recipients_metadata'] = $allow_e_seal_recipients_metadata; + + return $this; + } + + /** + * Gets allow_power_forms_admin_to_access_all_power_form_envelopes + * @return string + */ + public function getAllowPowerFormsAdminToAccessAllPowerFormEnvelopes() + { + return $this->container['allow_power_forms_admin_to_access_all_power_form_envelopes']; + } + + /** + * Sets allow_power_forms_admin_to_access_all_power_form_envelopes + * @param string $allow_power_forms_admin_to_access_all_power_form_envelopes + * @return $this + */ + public function setAllowPowerFormsAdminToAccessAllPowerFormEnvelopes($allow_power_forms_admin_to_access_all_power_form_envelopes) + { + $this->container['allow_power_forms_admin_to_access_all_power_form_envelopes'] = $allow_power_forms_admin_to_access_all_power_form_envelopes; + + return $this; + } + + /** + * Gets allow_power_forms_admin_to_access_all_power_form_envelopes_metadata + * @return \DocuSign\eSign\Model\SettingsMetadata + */ + public function getAllowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata() + { + return $this->container['allow_power_forms_admin_to_access_all_power_form_envelopes_metadata']; + } + + /** + * Sets allow_power_forms_admin_to_access_all_power_form_envelopes_metadata + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_power_forms_admin_to_access_all_power_form_envelopes_metadata + * @return $this + */ + public function setAllowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata($allow_power_forms_admin_to_access_all_power_form_envelopes_metadata) + { + $this->container['allow_power_forms_admin_to_access_all_power_form_envelopes_metadata'] = $allow_power_forms_admin_to_access_all_power_form_envelopes_metadata; + + return $this; + } + /** * Gets allow_senders_to_set_recipient_email_language * @return string diff --git a/src/Model/AccountSeals.php b/src/Model/AccountSeals.php new file mode 100644 index 00000000..319598b9 --- /dev/null +++ b/src/Model/AccountSeals.php @@ -0,0 +1,227 @@ + '\DocuSign\eSign\Model\SealIdentifier[]' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'seals' => 'seals' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'seals' => 'setSeals' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'seals' => 'getSeals' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['seals'] = isset($data['seals']) ? $data['seals'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets seals + * @return \DocuSign\eSign\Model\SealIdentifier[] + */ + public function getSeals() + { + return $this->container['seals']; + } + + /** + * Sets seals + * @param \DocuSign\eSign\Model\SealIdentifier[] $seals + * @return $this + */ + public function setSeals($seals) + { + $this->container['seals'] = $seals; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Agent.php b/src/Model/Agent.php index 280ef700..6441aa26 100644 --- a/src/Model/Agent.php +++ b/src/Model/Agent.php @@ -71,9 +71,12 @@ class Agent implements ArrayAccess 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', 'excluded_documents' => 'string[]', 'fax_number' => 'string', + 'first_name' => 'string', + 'full_name' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', 'inherit_email_notification_configuration' => 'string', + 'last_name' => 'string', 'name' => 'string', 'note' => 'string', 'phone_authentication' => '\DocuSign\eSign\Model\RecipientPhoneAuthentication', @@ -125,9 +128,12 @@ public static function swaggerTypes() 'error_details' => 'errorDetails', 'excluded_documents' => 'excludedDocuments', 'fax_number' => 'faxNumber', + 'first_name' => 'firstName', + 'full_name' => 'fullName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', + 'last_name' => 'lastName', 'name' => 'name', 'note' => 'note', 'phone_authentication' => 'phoneAuthentication', @@ -175,9 +181,12 @@ public static function swaggerTypes() 'error_details' => 'setErrorDetails', 'excluded_documents' => 'setExcludedDocuments', 'fax_number' => 'setFaxNumber', + 'first_name' => 'setFirstName', + 'full_name' => 'setFullName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', + 'last_name' => 'setLastName', 'name' => 'setName', 'note' => 'setNote', 'phone_authentication' => 'setPhoneAuthentication', @@ -225,9 +234,12 @@ public static function swaggerTypes() 'error_details' => 'getErrorDetails', 'excluded_documents' => 'getExcludedDocuments', 'fax_number' => 'getFaxNumber', + 'first_name' => 'getFirstName', + 'full_name' => 'getFullName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', + 'last_name' => 'getLastName', 'name' => 'getName', 'note' => 'getNote', 'phone_authentication' => 'getPhoneAuthentication', @@ -300,9 +312,12 @@ public function __construct(array $data = null) $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; $this->container['excluded_documents'] = isset($data['excluded_documents']) ? $data['excluded_documents'] : null; $this->container['fax_number'] = isset($data['fax_number']) ? $data['fax_number'] : null; + $this->container['first_name'] = isset($data['first_name']) ? $data['first_name'] : null; + $this->container['full_name'] = isset($data['full_name']) ? $data['full_name'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; + $this->container['last_name'] = isset($data['last_name']) ? $data['last_name'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['note'] = isset($data['note']) ? $data['note'] : null; $this->container['phone_authentication'] = isset($data['phone_authentication']) ? $data['phone_authentication'] : null; @@ -362,7 +377,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) @@ -614,7 +629,7 @@ public function getEmbeddedRecipientStartUrl() /** * Sets embedded_recipient_start_url - * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -687,6 +702,48 @@ public function setFaxNumber($fax_number) return $this; } + /** + * Gets first_name + * @return string + */ + public function getFirstName() + { + return $this->container['first_name']; + } + + /** + * Sets first_name + * @param string $first_name The user's first name. Maximum Length: 50 characters. + * @return $this + */ + public function setFirstName($first_name) + { + $this->container['first_name'] = $first_name; + + return $this; + } + + /** + * Gets full_name + * @return string + */ + public function getFullName() + { + return $this->container['full_name']; + } + + /** + * Sets full_name + * @param string $full_name + * @return $this + */ + public function setFullName($full_name) + { + $this->container['full_name'] = $full_name; + + return $this; + } + /** * Gets id_check_configuration_name * @return string @@ -750,6 +807,27 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica return $this; } + /** + * Gets last_name + * @return string + */ + public function getLastName() + { + return $this->container['last_name']; + } + + /** + * Sets last_name + * @param string $last_name + * @return $this + */ + public function setLastName($last_name) + { + $this->container['last_name'] = $last_name; + + return $this; + } + /** * Gets name * @return string diff --git a/src/Model/Approve.php b/src/Model/Approve.php index a1cca83a..4660445b 100644 --- a/src/Model/Approve.php +++ b/src/Model/Approve.php @@ -78,11 +78,13 @@ class Approve implements ArrayAccess 'page_number' => 'string', 'recipient_id' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'width' => 'int', 'x_position' => 'string', @@ -123,11 +125,13 @@ public static function swaggerTypes() 'page_number' => 'pageNumber', 'recipient_id' => 'recipientId', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'width' => 'width', 'x_position' => 'xPosition', @@ -164,11 +168,13 @@ public static function swaggerTypes() 'page_number' => 'setPageNumber', 'recipient_id' => 'setRecipientId', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'width' => 'setWidth', 'x_position' => 'setXPosition', @@ -205,11 +211,13 @@ public static function swaggerTypes() 'page_number' => 'getPageNumber', 'recipient_id' => 'getRecipientId', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'width' => 'getWidth', 'x_position' => 'getXPosition', @@ -271,11 +279,13 @@ public function __construct(array $data = null) $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['width'] = isset($data['width']) ? $data['width'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; @@ -442,7 +452,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -463,7 +473,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -809,6 +819,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -914,6 +945,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string diff --git a/src/Model/AuthenticationStatus.php b/src/Model/AuthenticationStatus.php index 825745ef..38109a94 100644 --- a/src/Model/AuthenticationStatus.php +++ b/src/Model/AuthenticationStatus.php @@ -68,6 +68,7 @@ class AuthenticationStatus implements ArrayAccess 'open_id_result' => '\DocuSign\eSign\Model\EventResult', 'phone_auth_result' => '\DocuSign\eSign\Model\EventResult', 'salesforce_result' => '\DocuSign\eSign\Model\EventResult', + 'signature_provider_result' => '\DocuSign\eSign\Model\EventResult', 'sms_auth_result' => '\DocuSign\eSign\Model\EventResult', 's_tan_pin_result' => '\DocuSign\eSign\Model\EventResult', 'twitter_result' => '\DocuSign\eSign\Model\EventResult', @@ -97,6 +98,7 @@ public static function swaggerTypes() 'open_id_result' => 'openIDResult', 'phone_auth_result' => 'phoneAuthResult', 'salesforce_result' => 'salesforceResult', + 'signature_provider_result' => 'signatureProviderResult', 'sms_auth_result' => 'smsAuthResult', 's_tan_pin_result' => 'sTANPinResult', 'twitter_result' => 'twitterResult', @@ -122,6 +124,7 @@ public static function swaggerTypes() 'open_id_result' => 'setOpenIdResult', 'phone_auth_result' => 'setPhoneAuthResult', 'salesforce_result' => 'setSalesforceResult', + 'signature_provider_result' => 'setSignatureProviderResult', 'sms_auth_result' => 'setSmsAuthResult', 's_tan_pin_result' => 'setSTanPinResult', 'twitter_result' => 'setTwitterResult', @@ -147,6 +150,7 @@ public static function swaggerTypes() 'open_id_result' => 'getOpenIdResult', 'phone_auth_result' => 'getPhoneAuthResult', 'salesforce_result' => 'getSalesforceResult', + 'signature_provider_result' => 'getSignatureProviderResult', 'sms_auth_result' => 'getSmsAuthResult', 's_tan_pin_result' => 'getSTanPinResult', 'twitter_result' => 'getTwitterResult', @@ -197,6 +201,7 @@ public function __construct(array $data = null) $this->container['open_id_result'] = isset($data['open_id_result']) ? $data['open_id_result'] : null; $this->container['phone_auth_result'] = isset($data['phone_auth_result']) ? $data['phone_auth_result'] : null; $this->container['salesforce_result'] = isset($data['salesforce_result']) ? $data['salesforce_result'] : null; + $this->container['signature_provider_result'] = isset($data['signature_provider_result']) ? $data['signature_provider_result'] : null; $this->container['sms_auth_result'] = isset($data['sms_auth_result']) ? $data['sms_auth_result'] : null; $this->container['s_tan_pin_result'] = isset($data['s_tan_pin_result']) ? $data['s_tan_pin_result'] : null; $this->container['twitter_result'] = isset($data['twitter_result']) ? $data['twitter_result'] : null; @@ -499,6 +504,27 @@ public function setSalesforceResult($salesforce_result) return $this; } + /** + * Gets signature_provider_result + * @return \DocuSign\eSign\Model\EventResult + */ + public function getSignatureProviderResult() + { + return $this->container['signature_provider_result']; + } + + /** + * Sets signature_provider_result + * @param \DocuSign\eSign\Model\EventResult $signature_provider_result + * @return $this + */ + public function setSignatureProviderResult($signature_provider_result) + { + $this->container['signature_provider_result'] = $signature_provider_result; + + return $this; + } + /** * Gets sms_auth_result * @return \DocuSign\eSign\Model\EventResult diff --git a/src/Model/BillingCharge.php b/src/Model/BillingCharge.php index e07b4912..80a905a2 100644 --- a/src/Model/BillingCharge.php +++ b/src/Model/BillingCharge.php @@ -259,7 +259,7 @@ public function getChargeName() /** * Sets charge_name - * @param string $charge_name Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | + * @param string $charge_name Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | * @return $this */ public function setChargeName($charge_name) diff --git a/src/Model/BillingPlanInformation.php b/src/Model/BillingPlanInformation.php index 029ffa4c..d4081dca 100644 --- a/src/Model/BillingPlanInformation.php +++ b/src/Model/BillingPlanInformation.php @@ -61,6 +61,7 @@ class BillingPlanInformation implements ArrayAccess 'enable_support' => 'string', 'included_seats' => 'string', 'incremental_seats' => 'string', + 'payment_processor_information' => '\DocuSign\eSign\Model\PaymentProcessorInformation', 'plan_information' => '\DocuSign\eSign\Model\PlanInformation', 'referral_information' => '\DocuSign\eSign\Model\ReferralInformation', 'renewal_status' => 'string', @@ -88,6 +89,7 @@ public static function swaggerTypes() 'enable_support' => 'enableSupport', 'included_seats' => 'includedSeats', 'incremental_seats' => 'incrementalSeats', + 'payment_processor_information' => 'paymentProcessorInformation', 'plan_information' => 'planInformation', 'referral_information' => 'referralInformation', 'renewal_status' => 'renewalStatus', @@ -111,6 +113,7 @@ public static function swaggerTypes() 'enable_support' => 'setEnableSupport', 'included_seats' => 'setIncludedSeats', 'incremental_seats' => 'setIncrementalSeats', + 'payment_processor_information' => 'setPaymentProcessorInformation', 'plan_information' => 'setPlanInformation', 'referral_information' => 'setReferralInformation', 'renewal_status' => 'setRenewalStatus', @@ -134,6 +137,7 @@ public static function swaggerTypes() 'enable_support' => 'getEnableSupport', 'included_seats' => 'getIncludedSeats', 'incremental_seats' => 'getIncrementalSeats', + 'payment_processor_information' => 'getPaymentProcessorInformation', 'plan_information' => 'getPlanInformation', 'referral_information' => 'getReferralInformation', 'renewal_status' => 'getRenewalStatus', @@ -182,6 +186,7 @@ public function __construct(array $data = null) $this->container['enable_support'] = isset($data['enable_support']) ? $data['enable_support'] : null; $this->container['included_seats'] = isset($data['included_seats']) ? $data['included_seats'] : null; $this->container['incremental_seats'] = isset($data['incremental_seats']) ? $data['incremental_seats'] : null; + $this->container['payment_processor_information'] = isset($data['payment_processor_information']) ? $data['payment_processor_information'] : null; $this->container['plan_information'] = isset($data['plan_information']) ? $data['plan_information'] : null; $this->container['referral_information'] = isset($data['referral_information']) ? $data['referral_information'] : null; $this->container['renewal_status'] = isset($data['renewal_status']) ? $data['renewal_status'] : null; @@ -362,6 +367,27 @@ public function setIncrementalSeats($incremental_seats) return $this; } + /** + * Gets payment_processor_information + * @return \DocuSign\eSign\Model\PaymentProcessorInformation + */ + public function getPaymentProcessorInformation() + { + return $this->container['payment_processor_information']; + } + + /** + * Sets payment_processor_information + * @param \DocuSign\eSign\Model\PaymentProcessorInformation $payment_processor_information + * @return $this + */ + public function setPaymentProcessorInformation($payment_processor_information) + { + $this->container['payment_processor_information'] = $payment_processor_information; + + return $this; + } + /** * Gets plan_information * @return \DocuSign\eSign\Model\PlanInformation diff --git a/src/Model/BillingPlanUpdateResponse.php b/src/Model/BillingPlanUpdateResponse.php index b54c222c..46c4de09 100644 --- a/src/Model/BillingPlanUpdateResponse.php +++ b/src/Model/BillingPlanUpdateResponse.php @@ -55,6 +55,7 @@ class BillingPlanUpdateResponse implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ + 'account_payment_method' => 'string', 'billing_plan_preview' => '\DocuSign\eSign\Model\BillingPlanPreview', 'currency_code' => 'string', 'included_seats' => 'string', @@ -74,6 +75,7 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ + 'account_payment_method' => 'accountPaymentMethod', 'billing_plan_preview' => 'billingPlanPreview', 'currency_code' => 'currencyCode', 'included_seats' => 'includedSeats', @@ -89,6 +91,7 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ + 'account_payment_method' => 'setAccountPaymentMethod', 'billing_plan_preview' => 'setBillingPlanPreview', 'currency_code' => 'setCurrencyCode', 'included_seats' => 'setIncludedSeats', @@ -104,6 +107,7 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ + 'account_payment_method' => 'getAccountPaymentMethod', 'billing_plan_preview' => 'getBillingPlanPreview', 'currency_code' => 'getCurrencyCode', 'included_seats' => 'getIncludedSeats', @@ -144,6 +148,7 @@ public static function getters() */ public function __construct(array $data = null) { + $this->container['account_payment_method'] = isset($data['account_payment_method']) ? $data['account_payment_method'] : null; $this->container['billing_plan_preview'] = isset($data['billing_plan_preview']) ? $data['billing_plan_preview'] : null; $this->container['currency_code'] = isset($data['currency_code']) ? $data['currency_code'] : null; $this->container['included_seats'] = isset($data['included_seats']) ? $data['included_seats'] : null; @@ -176,6 +181,27 @@ public function valid() } + /** + * Gets account_payment_method + * @return string + */ + public function getAccountPaymentMethod() + { + return $this->container['account_payment_method']; + } + + /** + * Sets account_payment_method + * @param string $account_payment_method + * @return $this + */ + public function setAccountPaymentMethod($account_payment_method) + { + $this->container['account_payment_method'] = $account_payment_method; + + return $this; + } + /** * Gets billing_plan_preview * @return \DocuSign\eSign\Model\BillingPlanPreview diff --git a/src/Model/BulkRecipient.php b/src/Model/BulkRecipient.php index 9e56db15..5ce58ff7 100644 --- a/src/Model/BulkRecipient.php +++ b/src/Model/BulkRecipient.php @@ -201,7 +201,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) diff --git a/src/Model/CarbonCopy.php b/src/Model/CarbonCopy.php index 40f1374a..2018aaa7 100644 --- a/src/Model/CarbonCopy.php +++ b/src/Model/CarbonCopy.php @@ -56,6 +56,8 @@ class CarbonCopy implements ArrayAccess protected static $swaggerTypes = [ 'access_code' => 'string', 'add_access_code_to_email' => 'string', + 'agent_can_edit_email' => 'string', + 'agent_can_edit_name' => 'string', 'client_user_id' => 'string', 'custom_fields' => 'string[]', 'declined_date_time' => 'string', @@ -70,9 +72,12 @@ class CarbonCopy implements ArrayAccess 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', 'excluded_documents' => 'string[]', 'fax_number' => 'string', + 'first_name' => 'string', + 'full_name' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', 'inherit_email_notification_configuration' => 'string', + 'last_name' => 'string', 'name' => 'string', 'note' => 'string', 'phone_authentication' => '\DocuSign\eSign\Model\RecipientPhoneAuthentication', @@ -110,6 +115,8 @@ public static function swaggerTypes() protected static $attributeMap = [ 'access_code' => 'accessCode', 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'agent_can_edit_email' => 'agentCanEditEmail', + 'agent_can_edit_name' => 'agentCanEditName', 'client_user_id' => 'clientUserId', 'custom_fields' => 'customFields', 'declined_date_time' => 'declinedDateTime', @@ -124,9 +131,12 @@ public static function swaggerTypes() 'error_details' => 'errorDetails', 'excluded_documents' => 'excludedDocuments', 'fax_number' => 'faxNumber', + 'first_name' => 'firstName', + 'full_name' => 'fullName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', + 'last_name' => 'lastName', 'name' => 'name', 'note' => 'note', 'phone_authentication' => 'phoneAuthentication', @@ -160,6 +170,8 @@ public static function swaggerTypes() protected static $setters = [ 'access_code' => 'setAccessCode', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'agent_can_edit_email' => 'setAgentCanEditEmail', + 'agent_can_edit_name' => 'setAgentCanEditName', 'client_user_id' => 'setClientUserId', 'custom_fields' => 'setCustomFields', 'declined_date_time' => 'setDeclinedDateTime', @@ -174,9 +186,12 @@ public static function swaggerTypes() 'error_details' => 'setErrorDetails', 'excluded_documents' => 'setExcludedDocuments', 'fax_number' => 'setFaxNumber', + 'first_name' => 'setFirstName', + 'full_name' => 'setFullName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', + 'last_name' => 'setLastName', 'name' => 'setName', 'note' => 'setNote', 'phone_authentication' => 'setPhoneAuthentication', @@ -210,6 +225,8 @@ public static function swaggerTypes() protected static $getters = [ 'access_code' => 'getAccessCode', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'agent_can_edit_email' => 'getAgentCanEditEmail', + 'agent_can_edit_name' => 'getAgentCanEditName', 'client_user_id' => 'getClientUserId', 'custom_fields' => 'getCustomFields', 'declined_date_time' => 'getDeclinedDateTime', @@ -224,9 +241,12 @@ public static function swaggerTypes() 'error_details' => 'getErrorDetails', 'excluded_documents' => 'getExcludedDocuments', 'fax_number' => 'getFaxNumber', + 'first_name' => 'getFirstName', + 'full_name' => 'getFullName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', + 'last_name' => 'getLastName', 'name' => 'getName', 'note' => 'getNote', 'phone_authentication' => 'getPhoneAuthentication', @@ -285,6 +305,8 @@ public function __construct(array $data = null) { $this->container['access_code'] = isset($data['access_code']) ? $data['access_code'] : null; $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['agent_can_edit_email'] = isset($data['agent_can_edit_email']) ? $data['agent_can_edit_email'] : null; + $this->container['agent_can_edit_name'] = isset($data['agent_can_edit_name']) ? $data['agent_can_edit_name'] : null; $this->container['client_user_id'] = isset($data['client_user_id']) ? $data['client_user_id'] : null; $this->container['custom_fields'] = isset($data['custom_fields']) ? $data['custom_fields'] : null; $this->container['declined_date_time'] = isset($data['declined_date_time']) ? $data['declined_date_time'] : null; @@ -299,9 +321,12 @@ public function __construct(array $data = null) $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; $this->container['excluded_documents'] = isset($data['excluded_documents']) ? $data['excluded_documents'] : null; $this->container['fax_number'] = isset($data['fax_number']) ? $data['fax_number'] : null; + $this->container['first_name'] = isset($data['first_name']) ? $data['first_name'] : null; + $this->container['full_name'] = isset($data['full_name']) ? $data['full_name'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; + $this->container['last_name'] = isset($data['last_name']) ? $data['last_name'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['note'] = isset($data['note']) ? $data['note'] : null; $this->container['phone_authentication'] = isset($data['phone_authentication']) ? $data['phone_authentication'] : null; @@ -361,7 +386,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) @@ -392,6 +417,48 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) return $this; } + /** + * Gets agent_can_edit_email + * @return string + */ + public function getAgentCanEditEmail() + { + return $this->container['agent_can_edit_email']; + } + + /** + * Sets agent_can_edit_email + * @param string $agent_can_edit_email + * @return $this + */ + public function setAgentCanEditEmail($agent_can_edit_email) + { + $this->container['agent_can_edit_email'] = $agent_can_edit_email; + + return $this; + } + + /** + * Gets agent_can_edit_name + * @return string + */ + public function getAgentCanEditName() + { + return $this->container['agent_can_edit_name']; + } + + /** + * Sets agent_can_edit_name + * @param string $agent_can_edit_name + * @return $this + */ + public function setAgentCanEditName($agent_can_edit_name) + { + $this->container['agent_can_edit_name'] = $agent_can_edit_name; + + return $this; + } + /** * Gets client_user_id * @return string @@ -613,7 +680,7 @@ public function getEmbeddedRecipientStartUrl() /** * Sets embedded_recipient_start_url - * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -686,6 +753,48 @@ public function setFaxNumber($fax_number) return $this; } + /** + * Gets first_name + * @return string + */ + public function getFirstName() + { + return $this->container['first_name']; + } + + /** + * Sets first_name + * @param string $first_name The user's first name. Maximum Length: 50 characters. + * @return $this + */ + public function setFirstName($first_name) + { + $this->container['first_name'] = $first_name; + + return $this; + } + + /** + * Gets full_name + * @return string + */ + public function getFullName() + { + return $this->container['full_name']; + } + + /** + * Sets full_name + * @param string $full_name + * @return $this + */ + public function setFullName($full_name) + { + $this->container['full_name'] = $full_name; + + return $this; + } + /** * Gets id_check_configuration_name * @return string @@ -749,6 +858,27 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica return $this; } + /** + * Gets last_name + * @return string + */ + public function getLastName() + { + return $this->container['last_name']; + } + + /** + * Sets last_name + * @param string $last_name + * @return $this + */ + public function setLastName($last_name) + { + $this->container['last_name'] = $last_name; + + return $this; + } + /** * Gets name * @return string diff --git a/src/Model/CertifiedDelivery.php b/src/Model/CertifiedDelivery.php index a258c8c7..1a6e4b30 100644 --- a/src/Model/CertifiedDelivery.php +++ b/src/Model/CertifiedDelivery.php @@ -56,6 +56,8 @@ class CertifiedDelivery implements ArrayAccess protected static $swaggerTypes = [ 'access_code' => 'string', 'add_access_code_to_email' => 'string', + 'agent_can_edit_email' => 'string', + 'agent_can_edit_name' => 'string', 'client_user_id' => 'string', 'custom_fields' => 'string[]', 'declined_date_time' => 'string', @@ -70,9 +72,12 @@ class CertifiedDelivery implements ArrayAccess 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', 'excluded_documents' => 'string[]', 'fax_number' => 'string', + 'first_name' => 'string', + 'full_name' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', 'inherit_email_notification_configuration' => 'string', + 'last_name' => 'string', 'name' => 'string', 'note' => 'string', 'phone_authentication' => '\DocuSign\eSign\Model\RecipientPhoneAuthentication', @@ -110,6 +115,8 @@ public static function swaggerTypes() protected static $attributeMap = [ 'access_code' => 'accessCode', 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'agent_can_edit_email' => 'agentCanEditEmail', + 'agent_can_edit_name' => 'agentCanEditName', 'client_user_id' => 'clientUserId', 'custom_fields' => 'customFields', 'declined_date_time' => 'declinedDateTime', @@ -124,9 +131,12 @@ public static function swaggerTypes() 'error_details' => 'errorDetails', 'excluded_documents' => 'excludedDocuments', 'fax_number' => 'faxNumber', + 'first_name' => 'firstName', + 'full_name' => 'fullName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', + 'last_name' => 'lastName', 'name' => 'name', 'note' => 'note', 'phone_authentication' => 'phoneAuthentication', @@ -160,6 +170,8 @@ public static function swaggerTypes() protected static $setters = [ 'access_code' => 'setAccessCode', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'agent_can_edit_email' => 'setAgentCanEditEmail', + 'agent_can_edit_name' => 'setAgentCanEditName', 'client_user_id' => 'setClientUserId', 'custom_fields' => 'setCustomFields', 'declined_date_time' => 'setDeclinedDateTime', @@ -174,9 +186,12 @@ public static function swaggerTypes() 'error_details' => 'setErrorDetails', 'excluded_documents' => 'setExcludedDocuments', 'fax_number' => 'setFaxNumber', + 'first_name' => 'setFirstName', + 'full_name' => 'setFullName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', + 'last_name' => 'setLastName', 'name' => 'setName', 'note' => 'setNote', 'phone_authentication' => 'setPhoneAuthentication', @@ -210,6 +225,8 @@ public static function swaggerTypes() protected static $getters = [ 'access_code' => 'getAccessCode', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'agent_can_edit_email' => 'getAgentCanEditEmail', + 'agent_can_edit_name' => 'getAgentCanEditName', 'client_user_id' => 'getClientUserId', 'custom_fields' => 'getCustomFields', 'declined_date_time' => 'getDeclinedDateTime', @@ -224,9 +241,12 @@ public static function swaggerTypes() 'error_details' => 'getErrorDetails', 'excluded_documents' => 'getExcludedDocuments', 'fax_number' => 'getFaxNumber', + 'first_name' => 'getFirstName', + 'full_name' => 'getFullName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', + 'last_name' => 'getLastName', 'name' => 'getName', 'note' => 'getNote', 'phone_authentication' => 'getPhoneAuthentication', @@ -285,6 +305,8 @@ public function __construct(array $data = null) { $this->container['access_code'] = isset($data['access_code']) ? $data['access_code'] : null; $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['agent_can_edit_email'] = isset($data['agent_can_edit_email']) ? $data['agent_can_edit_email'] : null; + $this->container['agent_can_edit_name'] = isset($data['agent_can_edit_name']) ? $data['agent_can_edit_name'] : null; $this->container['client_user_id'] = isset($data['client_user_id']) ? $data['client_user_id'] : null; $this->container['custom_fields'] = isset($data['custom_fields']) ? $data['custom_fields'] : null; $this->container['declined_date_time'] = isset($data['declined_date_time']) ? $data['declined_date_time'] : null; @@ -299,9 +321,12 @@ public function __construct(array $data = null) $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; $this->container['excluded_documents'] = isset($data['excluded_documents']) ? $data['excluded_documents'] : null; $this->container['fax_number'] = isset($data['fax_number']) ? $data['fax_number'] : null; + $this->container['first_name'] = isset($data['first_name']) ? $data['first_name'] : null; + $this->container['full_name'] = isset($data['full_name']) ? $data['full_name'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; + $this->container['last_name'] = isset($data['last_name']) ? $data['last_name'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['note'] = isset($data['note']) ? $data['note'] : null; $this->container['phone_authentication'] = isset($data['phone_authentication']) ? $data['phone_authentication'] : null; @@ -361,7 +386,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) @@ -392,6 +417,48 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) return $this; } + /** + * Gets agent_can_edit_email + * @return string + */ + public function getAgentCanEditEmail() + { + return $this->container['agent_can_edit_email']; + } + + /** + * Sets agent_can_edit_email + * @param string $agent_can_edit_email + * @return $this + */ + public function setAgentCanEditEmail($agent_can_edit_email) + { + $this->container['agent_can_edit_email'] = $agent_can_edit_email; + + return $this; + } + + /** + * Gets agent_can_edit_name + * @return string + */ + public function getAgentCanEditName() + { + return $this->container['agent_can_edit_name']; + } + + /** + * Sets agent_can_edit_name + * @param string $agent_can_edit_name + * @return $this + */ + public function setAgentCanEditName($agent_can_edit_name) + { + $this->container['agent_can_edit_name'] = $agent_can_edit_name; + + return $this; + } + /** * Gets client_user_id * @return string @@ -613,7 +680,7 @@ public function getEmbeddedRecipientStartUrl() /** * Sets embedded_recipient_start_url - * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -686,6 +753,48 @@ public function setFaxNumber($fax_number) return $this; } + /** + * Gets first_name + * @return string + */ + public function getFirstName() + { + return $this->container['first_name']; + } + + /** + * Sets first_name + * @param string $first_name The user's first name. Maximum Length: 50 characters. + * @return $this + */ + public function setFirstName($first_name) + { + $this->container['first_name'] = $first_name; + + return $this; + } + + /** + * Gets full_name + * @return string + */ + public function getFullName() + { + return $this->container['full_name']; + } + + /** + * Sets full_name + * @param string $full_name + * @return $this + */ + public function setFullName($full_name) + { + $this->container['full_name'] = $full_name; + + return $this; + } + /** * Gets id_check_configuration_name * @return string @@ -749,6 +858,27 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica return $this; } + /** + * Gets last_name + * @return string + */ + public function getLastName() + { + return $this->container['last_name']; + } + + /** + * Sets last_name + * @param string $last_name + * @return $this + */ + public function setLastName($last_name) + { + $this->container['last_name'] = $last_name; + + return $this; + } + /** * Gets name * @return string diff --git a/src/Model/Checkbox.php b/src/Model/Checkbox.php index 131609f7..86431b9f 100644 --- a/src/Model/Checkbox.php +++ b/src/Model/Checkbox.php @@ -77,11 +77,13 @@ class Checkbox implements ArrayAccess 'selected' => 'string', 'shared' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'x_position' => 'string', 'y_position' => 'string' ]; @@ -119,11 +121,13 @@ public static function swaggerTypes() 'selected' => 'selected', 'shared' => 'shared', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'x_position' => 'xPosition', 'y_position' => 'yPosition' ]; @@ -157,11 +161,13 @@ public static function swaggerTypes() 'selected' => 'setSelected', 'shared' => 'setShared', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'x_position' => 'setXPosition', 'y_position' => 'setYPosition' ]; @@ -195,11 +201,13 @@ public static function swaggerTypes() 'selected' => 'getSelected', 'shared' => 'getShared', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'x_position' => 'getXPosition', 'y_position' => 'getYPosition' ]; @@ -258,11 +266,13 @@ public function __construct(array $data = null) $this->container['selected'] = isset($data['selected']) ? $data['selected'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; } @@ -427,7 +437,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -448,7 +458,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -773,6 +783,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -878,6 +909,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets x_position * @return string diff --git a/src/Model/ChunkedUploadResponse.php b/src/Model/ChunkedUploadResponse.php index 7f61b360..1832fc24 100644 --- a/src/Model/ChunkedUploadResponse.php +++ b/src/Model/ChunkedUploadResponse.php @@ -60,6 +60,8 @@ class ChunkedUploadResponse implements ArrayAccess 'chunked_upload_uri' => 'string', 'committed' => 'string', 'expiration_date_time' => 'string', + 'max_chunked_upload_parts' => 'string', + 'max_total_size' => 'string', 'total_size' => 'string' ]; @@ -79,6 +81,8 @@ public static function swaggerTypes() 'chunked_upload_uri' => 'chunkedUploadUri', 'committed' => 'committed', 'expiration_date_time' => 'expirationDateTime', + 'max_chunked_upload_parts' => 'maxChunkedUploadParts', + 'max_total_size' => 'maxTotalSize', 'total_size' => 'totalSize' ]; @@ -94,6 +98,8 @@ public static function swaggerTypes() 'chunked_upload_uri' => 'setChunkedUploadUri', 'committed' => 'setCommitted', 'expiration_date_time' => 'setExpirationDateTime', + 'max_chunked_upload_parts' => 'setMaxChunkedUploadParts', + 'max_total_size' => 'setMaxTotalSize', 'total_size' => 'setTotalSize' ]; @@ -109,6 +115,8 @@ public static function swaggerTypes() 'chunked_upload_uri' => 'getChunkedUploadUri', 'committed' => 'getCommitted', 'expiration_date_time' => 'getExpirationDateTime', + 'max_chunked_upload_parts' => 'getMaxChunkedUploadParts', + 'max_total_size' => 'getMaxTotalSize', 'total_size' => 'getTotalSize' ]; @@ -149,6 +157,8 @@ public function __construct(array $data = null) $this->container['chunked_upload_uri'] = isset($data['chunked_upload_uri']) ? $data['chunked_upload_uri'] : null; $this->container['committed'] = isset($data['committed']) ? $data['committed'] : null; $this->container['expiration_date_time'] = isset($data['expiration_date_time']) ? $data['expiration_date_time'] : null; + $this->container['max_chunked_upload_parts'] = isset($data['max_chunked_upload_parts']) ? $data['max_chunked_upload_parts'] : null; + $this->container['max_total_size'] = isset($data['max_total_size']) ? $data['max_total_size'] : null; $this->container['total_size'] = isset($data['total_size']) ? $data['total_size'] : null; } @@ -301,6 +311,48 @@ public function setExpirationDateTime($expiration_date_time) return $this; } + /** + * Gets max_chunked_upload_parts + * @return string + */ + public function getMaxChunkedUploadParts() + { + return $this->container['max_chunked_upload_parts']; + } + + /** + * Sets max_chunked_upload_parts + * @param string $max_chunked_upload_parts + * @return $this + */ + public function setMaxChunkedUploadParts($max_chunked_upload_parts) + { + $this->container['max_chunked_upload_parts'] = $max_chunked_upload_parts; + + return $this; + } + + /** + * Gets max_total_size + * @return string + */ + public function getMaxTotalSize() + { + return $this->container['max_total_size']; + } + + /** + * Sets max_total_size + * @param string $max_total_size + * @return $this + */ + public function setMaxTotalSize($max_total_size) + { + $this->container['max_total_size'] = $max_total_size; + + return $this; + } + /** * Gets total_size * @return string diff --git a/src/Model/Company.php b/src/Model/Company.php index 6e672377..efeeb0e8 100644 --- a/src/Model/Company.php +++ b/src/Model/Company.php @@ -83,11 +83,13 @@ class Company implements ArrayAccess 'recipient_id' => 'string', 'required' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'value' => 'string', 'width' => 'int', @@ -134,11 +136,13 @@ public static function swaggerTypes() 'recipient_id' => 'recipientId', 'required' => 'required', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'value' => 'value', 'width' => 'width', @@ -181,11 +185,13 @@ public static function swaggerTypes() 'recipient_id' => 'setRecipientId', 'required' => 'setRequired', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'value' => 'setValue', 'width' => 'setWidth', @@ -228,11 +234,13 @@ public static function swaggerTypes() 'recipient_id' => 'getRecipientId', 'required' => 'getRequired', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'value' => 'getValue', 'width' => 'getWidth', @@ -300,11 +308,13 @@ public function __construct(array $data = null) $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['required'] = isset($data['required']) ? $data['required'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['width'] = isset($data['width']) ? $data['width'] : null; @@ -472,7 +482,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -493,7 +503,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -944,6 +954,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -1049,6 +1080,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string diff --git a/src/Model/CompleteSignHashResponse.php b/src/Model/CompleteSignHashResponse.php new file mode 100644 index 00000000..10eda87e --- /dev/null +++ b/src/Model/CompleteSignHashResponse.php @@ -0,0 +1,279 @@ + '\DocuSign\eSign\Model\SignHashDocument[]', + 'redirection_url' => 'string', + 'remaining_signature_requests' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'documents' => 'documents', + 'redirection_url' => 'redirectionUrl', + 'remaining_signature_requests' => 'remainingSignatureRequests' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'documents' => 'setDocuments', + 'redirection_url' => 'setRedirectionUrl', + 'remaining_signature_requests' => 'setRemainingSignatureRequests' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'documents' => 'getDocuments', + 'redirection_url' => 'getRedirectionUrl', + 'remaining_signature_requests' => 'getRemainingSignatureRequests' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['documents'] = isset($data['documents']) ? $data['documents'] : null; + $this->container['redirection_url'] = isset($data['redirection_url']) ? $data['redirection_url'] : null; + $this->container['remaining_signature_requests'] = isset($data['remaining_signature_requests']) ? $data['remaining_signature_requests'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets documents + * @return \DocuSign\eSign\Model\SignHashDocument[] + */ + public function getDocuments() + { + return $this->container['documents']; + } + + /** + * Sets documents + * @param \DocuSign\eSign\Model\SignHashDocument[] $documents Complex element contains the details on the documents in the envelope. + * @return $this + */ + public function setDocuments($documents) + { + $this->container['documents'] = $documents; + + return $this; + } + + /** + * Gets redirection_url + * @return string + */ + public function getRedirectionUrl() + { + return $this->container['redirection_url']; + } + + /** + * Sets redirection_url + * @param string $redirection_url + * @return $this + */ + public function setRedirectionUrl($redirection_url) + { + $this->container['redirection_url'] = $redirection_url; + + return $this; + } + + /** + * Gets remaining_signature_requests + * @return string + */ + public function getRemainingSignatureRequests() + { + return $this->container['remaining_signature_requests']; + } + + /** + * Sets remaining_signature_requests + * @param string $remaining_signature_requests + * @return $this + */ + public function setRemainingSignatureRequests($remaining_signature_requests) + { + $this->container['remaining_signature_requests'] = $remaining_signature_requests; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/CompleteSignRequest.php b/src/Model/CompleteSignRequest.php new file mode 100644 index 00000000..97326e96 --- /dev/null +++ b/src/Model/CompleteSignRequest.php @@ -0,0 +1,305 @@ + 'string', + 'document_update_infos' => '\DocuSign\eSign\Model\DocumentUpdateInfo[]', + 'signing_location' => 'string', + 'transaction_id' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'correlation_id' => 'correlationId', + 'document_update_infos' => 'documentUpdateInfos', + 'signing_location' => 'signingLocation', + 'transaction_id' => 'transactionId' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'correlation_id' => 'setCorrelationId', + 'document_update_infos' => 'setDocumentUpdateInfos', + 'signing_location' => 'setSigningLocation', + 'transaction_id' => 'setTransactionId' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'correlation_id' => 'getCorrelationId', + 'document_update_infos' => 'getDocumentUpdateInfos', + 'signing_location' => 'getSigningLocation', + 'transaction_id' => 'getTransactionId' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['correlation_id'] = isset($data['correlation_id']) ? $data['correlation_id'] : null; + $this->container['document_update_infos'] = isset($data['document_update_infos']) ? $data['document_update_infos'] : null; + $this->container['signing_location'] = isset($data['signing_location']) ? $data['signing_location'] : null; + $this->container['transaction_id'] = isset($data['transaction_id']) ? $data['transaction_id'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets correlation_id + * @return string + */ + public function getCorrelationId() + { + return $this->container['correlation_id']; + } + + /** + * Sets correlation_id + * @param string $correlation_id + * @return $this + */ + public function setCorrelationId($correlation_id) + { + $this->container['correlation_id'] = $correlation_id; + + return $this; + } + + /** + * Gets document_update_infos + * @return \DocuSign\eSign\Model\DocumentUpdateInfo[] + */ + public function getDocumentUpdateInfos() + { + return $this->container['document_update_infos']; + } + + /** + * Sets document_update_infos + * @param \DocuSign\eSign\Model\DocumentUpdateInfo[] $document_update_infos + * @return $this + */ + public function setDocumentUpdateInfos($document_update_infos) + { + $this->container['document_update_infos'] = $document_update_infos; + + return $this; + } + + /** + * Gets signing_location + * @return string + */ + public function getSigningLocation() + { + return $this->container['signing_location']; + } + + /** + * Sets signing_location + * @param string $signing_location Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. + * @return $this + */ + public function setSigningLocation($signing_location) + { + $this->container['signing_location'] = $signing_location; + + return $this; + } + + /** + * Gets transaction_id + * @return string + */ + public function getTransactionId() + { + return $this->container['transaction_id']; + } + + /** + * Sets transaction_id + * @param string $transaction_id Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. + * @return $this + */ + public function setTransactionId($transaction_id) + { + $this->container['transaction_id'] = $transaction_id; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/CompositeTemplate.php b/src/Model/CompositeTemplate.php index a5c4238d..b4ede398 100644 --- a/src/Model/CompositeTemplate.php +++ b/src/Model/CompositeTemplate.php @@ -176,7 +176,7 @@ public function getCompositeTemplateId() /** * Sets composite_template_id - * @param string $composite_template_id The identify of this composite template. It is used as a reference when adding document object information. If used, the document’s `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document. + * @param string $composite_template_id The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document. * @return $this */ public function setCompositeTemplateId($composite_template_id) diff --git a/src/Model/ConnectCustomConfiguration.php b/src/Model/ConnectCustomConfiguration.php index 1db3ee62..50d33233 100644 --- a/src/Model/ConnectCustomConfiguration.php +++ b/src/Model/ConnectCustomConfiguration.php @@ -65,6 +65,7 @@ class ConnectCustomConfiguration implements ArrayAccess 'include_document_fields' => 'string', 'include_documents' => 'string', 'include_envelope_void_reason' => 'string', + 'include_hmac' => 'string', 'include_sender_accountas_custom_field' => 'string', 'include_time_zone_information' => 'string', 'name' => 'string', @@ -98,6 +99,7 @@ public static function swaggerTypes() 'include_document_fields' => 'includeDocumentFields', 'include_documents' => 'includeDocuments', 'include_envelope_void_reason' => 'includeEnvelopeVoidReason', + 'include_hmac' => 'includeHMAC', 'include_sender_accountas_custom_field' => 'includeSenderAccountasCustomField', 'include_time_zone_information' => 'includeTimeZoneInformation', 'name' => 'name', @@ -127,6 +129,7 @@ public static function swaggerTypes() 'include_document_fields' => 'setIncludeDocumentFields', 'include_documents' => 'setIncludeDocuments', 'include_envelope_void_reason' => 'setIncludeEnvelopeVoidReason', + 'include_hmac' => 'setIncludeHmac', 'include_sender_accountas_custom_field' => 'setIncludeSenderAccountasCustomField', 'include_time_zone_information' => 'setIncludeTimeZoneInformation', 'name' => 'setName', @@ -156,6 +159,7 @@ public static function swaggerTypes() 'include_document_fields' => 'getIncludeDocumentFields', 'include_documents' => 'getIncludeDocuments', 'include_envelope_void_reason' => 'getIncludeEnvelopeVoidReason', + 'include_hmac' => 'getIncludeHmac', 'include_sender_accountas_custom_field' => 'getIncludeSenderAccountasCustomField', 'include_time_zone_information' => 'getIncludeTimeZoneInformation', 'name' => 'getName', @@ -210,6 +214,7 @@ public function __construct(array $data = null) $this->container['include_document_fields'] = isset($data['include_document_fields']) ? $data['include_document_fields'] : null; $this->container['include_documents'] = isset($data['include_documents']) ? $data['include_documents'] : null; $this->container['include_envelope_void_reason'] = isset($data['include_envelope_void_reason']) ? $data['include_envelope_void_reason'] : null; + $this->container['include_hmac'] = isset($data['include_hmac']) ? $data['include_hmac'] : null; $this->container['include_sender_accountas_custom_field'] = isset($data['include_sender_accountas_custom_field']) ? $data['include_sender_accountas_custom_field'] : null; $this->container['include_time_zone_information'] = isset($data['include_time_zone_information']) ? $data['include_time_zone_information'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; @@ -361,7 +366,7 @@ public function getEnvelopeEvents() /** * Sets envelope_events - * @param string $envelope_events A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided. + * @param string $envelope_events A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided. * @return $this */ public function setEnvelopeEvents($envelope_events) @@ -476,6 +481,27 @@ public function setIncludeEnvelopeVoidReason($include_envelope_void_reason) return $this; } + /** + * Gets include_hmac + * @return string + */ + public function getIncludeHmac() + { + return $this->container['include_hmac']; + } + + /** + * Sets include_hmac + * @param string $include_hmac + * @return $this + */ + public function setIncludeHmac($include_hmac) + { + $this->container['include_hmac'] = $include_hmac; + + return $this; + } + /** * Gets include_sender_accountas_custom_field * @return string @@ -550,7 +576,7 @@ public function getRecipientEvents() /** * Sets recipient_events - * @param string $recipient_events A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. + * @param string $recipient_events A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * @return $this */ public function setRecipientEvents($recipient_events) @@ -655,7 +681,7 @@ public function getUserIds() /** * Sets user_ids - * @param string $user_ids A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s. + * @param string $user_ids A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s. * @return $this */ public function setUserIds($user_ids) diff --git a/src/Model/ConsumerDisclosure.php b/src/Model/ConsumerDisclosure.php index 3e0f614a..8f7633b0 100644 --- a/src/Model/ConsumerDisclosure.php +++ b/src/Model/ConsumerDisclosure.php @@ -56,6 +56,7 @@ class ConsumerDisclosure implements ArrayAccess protected static $swaggerTypes = [ 'account_esign_id' => 'string', 'allow_cd_withdraw' => 'string', + 'allow_cd_withdraw_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', 'change_email' => 'string', 'change_email_other' => 'string', 'company_name' => 'string', @@ -72,6 +73,7 @@ class ConsumerDisclosure implements ArrayAccess 'pdf_id' => 'string', 'use_brand' => 'string', 'use_consumer_disclosure_within_account' => 'string', + 'use_consumer_disclosure_within_account_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', 'withdraw_address_line1' => 'string', 'withdraw_address_line2' => 'string', 'withdraw_by_email' => 'string', @@ -98,6 +100,7 @@ public static function swaggerTypes() protected static $attributeMap = [ 'account_esign_id' => 'accountEsignId', 'allow_cd_withdraw' => 'allowCDWithdraw', + 'allow_cd_withdraw_metadata' => 'allowCDWithdrawMetadata', 'change_email' => 'changeEmail', 'change_email_other' => 'changeEmailOther', 'company_name' => 'companyName', @@ -114,6 +117,7 @@ public static function swaggerTypes() 'pdf_id' => 'pdfId', 'use_brand' => 'useBrand', 'use_consumer_disclosure_within_account' => 'useConsumerDisclosureWithinAccount', + 'use_consumer_disclosure_within_account_metadata' => 'useConsumerDisclosureWithinAccountMetadata', 'withdraw_address_line1' => 'withdrawAddressLine1', 'withdraw_address_line2' => 'withdrawAddressLine2', 'withdraw_by_email' => 'withdrawByEmail', @@ -136,6 +140,7 @@ public static function swaggerTypes() protected static $setters = [ 'account_esign_id' => 'setAccountEsignId', 'allow_cd_withdraw' => 'setAllowCdWithdraw', + 'allow_cd_withdraw_metadata' => 'setAllowCdWithdrawMetadata', 'change_email' => 'setChangeEmail', 'change_email_other' => 'setChangeEmailOther', 'company_name' => 'setCompanyName', @@ -152,6 +157,7 @@ public static function swaggerTypes() 'pdf_id' => 'setPdfId', 'use_brand' => 'setUseBrand', 'use_consumer_disclosure_within_account' => 'setUseConsumerDisclosureWithinAccount', + 'use_consumer_disclosure_within_account_metadata' => 'setUseConsumerDisclosureWithinAccountMetadata', 'withdraw_address_line1' => 'setWithdrawAddressLine1', 'withdraw_address_line2' => 'setWithdrawAddressLine2', 'withdraw_by_email' => 'setWithdrawByEmail', @@ -174,6 +180,7 @@ public static function swaggerTypes() protected static $getters = [ 'account_esign_id' => 'getAccountEsignId', 'allow_cd_withdraw' => 'getAllowCdWithdraw', + 'allow_cd_withdraw_metadata' => 'getAllowCdWithdrawMetadata', 'change_email' => 'getChangeEmail', 'change_email_other' => 'getChangeEmailOther', 'company_name' => 'getCompanyName', @@ -190,6 +197,7 @@ public static function swaggerTypes() 'pdf_id' => 'getPdfId', 'use_brand' => 'getUseBrand', 'use_consumer_disclosure_within_account' => 'getUseConsumerDisclosureWithinAccount', + 'use_consumer_disclosure_within_account_metadata' => 'getUseConsumerDisclosureWithinAccountMetadata', 'withdraw_address_line1' => 'getWithdrawAddressLine1', 'withdraw_address_line2' => 'getWithdrawAddressLine2', 'withdraw_by_email' => 'getWithdrawByEmail', @@ -237,6 +245,7 @@ public function __construct(array $data = null) { $this->container['account_esign_id'] = isset($data['account_esign_id']) ? $data['account_esign_id'] : null; $this->container['allow_cd_withdraw'] = isset($data['allow_cd_withdraw']) ? $data['allow_cd_withdraw'] : null; + $this->container['allow_cd_withdraw_metadata'] = isset($data['allow_cd_withdraw_metadata']) ? $data['allow_cd_withdraw_metadata'] : null; $this->container['change_email'] = isset($data['change_email']) ? $data['change_email'] : null; $this->container['change_email_other'] = isset($data['change_email_other']) ? $data['change_email_other'] : null; $this->container['company_name'] = isset($data['company_name']) ? $data['company_name'] : null; @@ -253,6 +262,7 @@ public function __construct(array $data = null) $this->container['pdf_id'] = isset($data['pdf_id']) ? $data['pdf_id'] : null; $this->container['use_brand'] = isset($data['use_brand']) ? $data['use_brand'] : null; $this->container['use_consumer_disclosure_within_account'] = isset($data['use_consumer_disclosure_within_account']) ? $data['use_consumer_disclosure_within_account'] : null; + $this->container['use_consumer_disclosure_within_account_metadata'] = isset($data['use_consumer_disclosure_within_account_metadata']) ? $data['use_consumer_disclosure_within_account_metadata'] : null; $this->container['withdraw_address_line1'] = isset($data['withdraw_address_line1']) ? $data['withdraw_address_line1'] : null; $this->container['withdraw_address_line2'] = isset($data['withdraw_address_line2']) ? $data['withdraw_address_line2'] : null; $this->container['withdraw_by_email'] = isset($data['withdraw_by_email']) ? $data['withdraw_by_email'] : null; @@ -332,6 +342,27 @@ public function setAllowCdWithdraw($allow_cd_withdraw) return $this; } + /** + * Gets allow_cd_withdraw_metadata + * @return \DocuSign\eSign\Model\SettingsMetadata + */ + public function getAllowCdWithdrawMetadata() + { + return $this->container['allow_cd_withdraw_metadata']; + } + + /** + * Sets allow_cd_withdraw_metadata + * @param \DocuSign\eSign\Model\SettingsMetadata $allow_cd_withdraw_metadata + * @return $this + */ + public function setAllowCdWithdrawMetadata($allow_cd_withdraw_metadata) + { + $this->container['allow_cd_withdraw_metadata'] = $allow_cd_withdraw_metadata; + + return $this; + } + /** * Gets change_email * @return string @@ -668,6 +699,27 @@ public function setUseConsumerDisclosureWithinAccount($use_consumer_disclosure_w return $this; } + /** + * Gets use_consumer_disclosure_within_account_metadata + * @return \DocuSign\eSign\Model\SettingsMetadata + */ + public function getUseConsumerDisclosureWithinAccountMetadata() + { + return $this->container['use_consumer_disclosure_within_account_metadata']; + } + + /** + * Sets use_consumer_disclosure_within_account_metadata + * @param \DocuSign\eSign\Model\SettingsMetadata $use_consumer_disclosure_within_account_metadata + * @return $this + */ + public function setUseConsumerDisclosureWithinAccountMetadata($use_consumer_disclosure_within_account_metadata) + { + $this->container['use_consumer_disclosure_within_account_metadata'] = $use_consumer_disclosure_within_account_metadata; + + return $this; + } + /** * Gets withdraw_address_line1 * @return string diff --git a/src/Model/Contact.php b/src/Model/Contact.php index 3fe81463..9398cbd7 100644 --- a/src/Model/Contact.php +++ b/src/Model/Contact.php @@ -55,6 +55,7 @@ class Contact implements ArrayAccess */ protected static $swaggerTypes = [ 'contact_id' => 'string', + 'contact_phone_numbers' => '\DocuSign\eSign\Model\ContactPhoneNumber[]', 'contact_uri' => 'string', 'emails' => 'string[]', 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', @@ -76,6 +77,7 @@ public static function swaggerTypes() */ protected static $attributeMap = [ 'contact_id' => 'contactId', + 'contact_phone_numbers' => 'contactPhoneNumbers', 'contact_uri' => 'contactUri', 'emails' => 'emails', 'error_details' => 'errorDetails', @@ -93,6 +95,7 @@ public static function swaggerTypes() */ protected static $setters = [ 'contact_id' => 'setContactId', + 'contact_phone_numbers' => 'setContactPhoneNumbers', 'contact_uri' => 'setContactUri', 'emails' => 'setEmails', 'error_details' => 'setErrorDetails', @@ -110,6 +113,7 @@ public static function swaggerTypes() */ protected static $getters = [ 'contact_id' => 'getContactId', + 'contact_phone_numbers' => 'getContactPhoneNumbers', 'contact_uri' => 'getContactUri', 'emails' => 'getEmails', 'error_details' => 'getErrorDetails', @@ -152,6 +156,7 @@ public static function getters() public function __construct(array $data = null) { $this->container['contact_id'] = isset($data['contact_id']) ? $data['contact_id'] : null; + $this->container['contact_phone_numbers'] = isset($data['contact_phone_numbers']) ? $data['contact_phone_numbers'] : null; $this->container['contact_uri'] = isset($data['contact_uri']) ? $data['contact_uri'] : null; $this->container['emails'] = isset($data['emails']) ? $data['emails'] : null; $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; @@ -206,6 +211,27 @@ public function setContactId($contact_id) return $this; } + /** + * Gets contact_phone_numbers + * @return \DocuSign\eSign\Model\ContactPhoneNumber[] + */ + public function getContactPhoneNumbers() + { + return $this->container['contact_phone_numbers']; + } + + /** + * Sets contact_phone_numbers + * @param \DocuSign\eSign\Model\ContactPhoneNumber[] $contact_phone_numbers + * @return $this + */ + public function setContactPhoneNumbers($contact_phone_numbers) + { + $this->container['contact_phone_numbers'] = $contact_phone_numbers; + + return $this; + } + /** * Gets contact_uri * @return string diff --git a/src/Model/ContactPhoneNumber.php b/src/Model/ContactPhoneNumber.php new file mode 100644 index 00000000..1587bb54 --- /dev/null +++ b/src/Model/ContactPhoneNumber.php @@ -0,0 +1,253 @@ + 'string', + 'phone_type' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'phone_number' => 'phoneNumber', + 'phone_type' => 'phoneType' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'phone_number' => 'setPhoneNumber', + 'phone_type' => 'setPhoneType' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'phone_number' => 'getPhoneNumber', + 'phone_type' => 'getPhoneType' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['phone_number'] = isset($data['phone_number']) ? $data['phone_number'] : null; + $this->container['phone_type'] = isset($data['phone_type']) ? $data['phone_type'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets phone_number + * @return string + */ + public function getPhoneNumber() + { + return $this->container['phone_number']; + } + + /** + * Sets phone_number + * @param string $phone_number + * @return $this + */ + public function setPhoneNumber($phone_number) + { + $this->container['phone_number'] = $phone_number; + + return $this; + } + + /** + * Gets phone_type + * @return string + */ + public function getPhoneType() + { + return $this->container['phone_type']; + } + + /** + * Sets phone_type + * @param string $phone_type + * @return $this + */ + public function setPhoneType($phone_type) + { + $this->container['phone_type'] = $phone_type; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Credential.php b/src/Model/Credential.php new file mode 100644 index 00000000..238181ec --- /dev/null +++ b/src/Model/Credential.php @@ -0,0 +1,253 @@ + 'string', + 'value' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'type' => 'type', + 'value' => 'value' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'type' => 'setType', + 'value' => 'setValue' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'type' => 'getType', + 'value' => 'getValue' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['type'] = isset($data['type']) ? $data['type'] : null; + $this->container['value'] = isset($data['value']) ? $data['value'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets type + * @return string + */ + public function getType() + { + return $this->container['type']; + } + + /** + * Sets type + * @param string $type + * @return $this + */ + public function setType($type) + { + $this->container['type'] = $type; + + return $this; + } + + /** + * Gets value + * @return string + */ + public function getValue() + { + return $this->container['value']; + } + + /** + * Sets value + * @param string $value Specifies the value of the tab. + * @return $this + */ + public function setValue($value) + { + $this->container['value'] = $value; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/CustomField.php b/src/Model/CustomField.php new file mode 100644 index 00000000..107ecdb9 --- /dev/null +++ b/src/Model/CustomField.php @@ -0,0 +1,409 @@ + 'string', + 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', + 'field_id' => 'string', + 'list_items' => 'string[]', + 'name' => 'string', + 'required' => 'string', + 'show' => 'string', + 'value' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'custom_field_type' => 'customFieldType', + 'error_details' => 'errorDetails', + 'field_id' => 'fieldId', + 'list_items' => 'listItems', + 'name' => 'name', + 'required' => 'required', + 'show' => 'show', + 'value' => 'value' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'custom_field_type' => 'setCustomFieldType', + 'error_details' => 'setErrorDetails', + 'field_id' => 'setFieldId', + 'list_items' => 'setListItems', + 'name' => 'setName', + 'required' => 'setRequired', + 'show' => 'setShow', + 'value' => 'setValue' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'custom_field_type' => 'getCustomFieldType', + 'error_details' => 'getErrorDetails', + 'field_id' => 'getFieldId', + 'list_items' => 'getListItems', + 'name' => 'getName', + 'required' => 'getRequired', + 'show' => 'getShow', + 'value' => 'getValue' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['custom_field_type'] = isset($data['custom_field_type']) ? $data['custom_field_type'] : null; + $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; + $this->container['field_id'] = isset($data['field_id']) ? $data['field_id'] : null; + $this->container['list_items'] = isset($data['list_items']) ? $data['list_items'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['required'] = isset($data['required']) ? $data['required'] : null; + $this->container['show'] = isset($data['show']) ? $data['show'] : null; + $this->container['value'] = isset($data['value']) ? $data['value'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets custom_field_type + * @return string + */ + public function getCustomFieldType() + { + return $this->container['custom_field_type']; + } + + /** + * Sets custom_field_type + * @param string $custom_field_type + * @return $this + */ + public function setCustomFieldType($custom_field_type) + { + $this->container['custom_field_type'] = $custom_field_type; + + return $this; + } + + /** + * Gets error_details + * @return \DocuSign\eSign\Model\ErrorDetails + */ + public function getErrorDetails() + { + return $this->container['error_details']; + } + + /** + * Sets error_details + * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * @return $this + */ + public function setErrorDetails($error_details) + { + $this->container['error_details'] = $error_details; + + return $this; + } + + /** + * Gets field_id + * @return string + */ + public function getFieldId() + { + return $this->container['field_id']; + } + + /** + * Sets field_id + * @param string $field_id + * @return $this + */ + public function setFieldId($field_id) + { + $this->container['field_id'] = $field_id; + + return $this; + } + + /** + * Gets list_items + * @return string[] + */ + public function getListItems() + { + return $this->container['list_items']; + } + + /** + * Sets list_items + * @param string[] $list_items + * @return $this + */ + public function setListItems($list_items) + { + $this->container['list_items'] = $list_items; + + return $this; + } + + /** + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + + /** + * Gets required + * @return string + */ + public function getRequired() + { + return $this->container['required']; + } + + /** + * Sets required + * @param string $required When set to **true**, the signer is required to fill out this tab + * @return $this + */ + public function setRequired($required) + { + $this->container['required'] = $required; + + return $this; + } + + /** + * Gets show + * @return string + */ + public function getShow() + { + return $this->container['show']; + } + + /** + * Sets show + * @param string $show + * @return $this + */ + public function setShow($show) + { + $this->container['show'] = $show; + + return $this; + } + + /** + * Gets value + * @return string + */ + public function getValue() + { + return $this->container['value']; + } + + /** + * Sets value + * @param string $value Specifies the value of the tab. + * @return $this + */ + public function setValue($value) + { + $this->container['value'] = $value; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Date.php b/src/Model/Date.php index 91de6f68..b6d353f2 100644 --- a/src/Model/Date.php +++ b/src/Model/Date.php @@ -87,11 +87,13 @@ class Date implements ArrayAccess 'sender_required' => 'string', 'shared' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'validation_message' => 'string', 'validation_pattern' => 'string', @@ -144,11 +146,13 @@ public static function swaggerTypes() 'sender_required' => 'senderRequired', 'shared' => 'shared', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'validation_message' => 'validationMessage', 'validation_pattern' => 'validationPattern', @@ -197,11 +201,13 @@ public static function swaggerTypes() 'sender_required' => 'setSenderRequired', 'shared' => 'setShared', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'validation_message' => 'setValidationMessage', 'validation_pattern' => 'setValidationPattern', @@ -250,11 +256,13 @@ public static function swaggerTypes() 'sender_required' => 'getSenderRequired', 'shared' => 'getShared', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'validation_message' => 'getValidationMessage', 'validation_pattern' => 'getValidationPattern', @@ -328,11 +336,13 @@ public function __construct(array $data = null) $this->container['sender_required'] = isset($data['sender_required']) ? $data['sender_required'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['validation_message'] = isset($data['validation_message']) ? $data['validation_message'] : null; $this->container['validation_pattern'] = isset($data['validation_pattern']) ? $data['validation_pattern'] : null; @@ -502,7 +512,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -523,7 +533,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -1058,6 +1068,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -1163,6 +1194,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -1216,7 +1268,7 @@ public function getValidationPattern() /** * Sets validation_pattern - * @param string $validation_pattern A regular expressionn used to validate input for the tab. + * @param string $validation_pattern A regular expression used to validate input for the tab. * @return $this */ public function setValidationPattern($validation_pattern) diff --git a/src/Model/DateSigned.php b/src/Model/DateSigned.php index 492797b1..1e582d4e 100644 --- a/src/Model/DateSigned.php +++ b/src/Model/DateSigned.php @@ -77,11 +77,13 @@ class DateSigned implements ArrayAccess 'page_number' => 'string', 'recipient_id' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'value' => 'string', 'x_position' => 'string', @@ -121,11 +123,13 @@ public static function swaggerTypes() 'page_number' => 'pageNumber', 'recipient_id' => 'recipientId', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'value' => 'value', 'x_position' => 'xPosition', @@ -161,11 +165,13 @@ public static function swaggerTypes() 'page_number' => 'setPageNumber', 'recipient_id' => 'setRecipientId', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'value' => 'setValue', 'x_position' => 'setXPosition', @@ -201,11 +207,13 @@ public static function swaggerTypes() 'page_number' => 'getPageNumber', 'recipient_id' => 'getRecipientId', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'value' => 'getValue', 'x_position' => 'getXPosition', @@ -266,11 +274,13 @@ public function __construct(array $data = null) $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; @@ -437,7 +447,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -458,7 +468,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -783,6 +793,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -888,6 +919,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string diff --git a/src/Model/PostTransactionsRequest.php b/src/Model/DateStampProperties.php similarity index 64% rename from src/Model/PostTransactionsRequest.php rename to src/Model/DateStampProperties.php index ac2f0b36..09175d2d 100644 --- a/src/Model/PostTransactionsRequest.php +++ b/src/Model/DateStampProperties.php @@ -1,6 +1,6 @@ 'string', - 'dpt_name' => 'string', - 'transaction_name' => 'string', - 'transaction_type_name' => 'string' + 'date_area_height' => 'string', + 'date_area_width' => 'string', + 'date_area_x' => 'string', + 'date_area_y' => 'string' ]; public static function swaggerTypes() @@ -70,10 +70,10 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ - 'document_data' => 'documentData', - 'dpt_name' => 'dptName', - 'transaction_name' => 'transactionName', - 'transaction_type_name' => 'transactionTypeName' + 'date_area_height' => 'dateAreaHeight', + 'date_area_width' => 'dateAreaWidth', + 'date_area_x' => 'dateAreaX', + 'date_area_y' => 'dateAreaY' ]; @@ -82,10 +82,10 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ - 'document_data' => 'setDocumentData', - 'dpt_name' => 'setDptName', - 'transaction_name' => 'setTransactionName', - 'transaction_type_name' => 'setTransactionTypeName' + 'date_area_height' => 'setDateAreaHeight', + 'date_area_width' => 'setDateAreaWidth', + 'date_area_x' => 'setDateAreaX', + 'date_area_y' => 'setDateAreaY' ]; @@ -94,10 +94,10 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ - 'document_data' => 'getDocumentData', - 'dpt_name' => 'getDptName', - 'transaction_name' => 'getTransactionName', - 'transaction_type_name' => 'getTransactionTypeName' + 'date_area_height' => 'getDateAreaHeight', + 'date_area_width' => 'getDateAreaWidth', + 'date_area_x' => 'getDateAreaX', + 'date_area_y' => 'getDateAreaY' ]; public static function attributeMap() @@ -131,10 +131,10 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['document_data'] = isset($data['document_data']) ? $data['document_data'] : null; - $this->container['dpt_name'] = isset($data['dpt_name']) ? $data['dpt_name'] : null; - $this->container['transaction_name'] = isset($data['transaction_name']) ? $data['transaction_name'] : null; - $this->container['transaction_type_name'] = isset($data['transaction_type_name']) ? $data['transaction_type_name'] : null; + $this->container['date_area_height'] = isset($data['date_area_height']) ? $data['date_area_height'] : null; + $this->container['date_area_width'] = isset($data['date_area_width']) ? $data['date_area_width'] : null; + $this->container['date_area_x'] = isset($data['date_area_x']) ? $data['date_area_x'] : null; + $this->container['date_area_y'] = isset($data['date_area_y']) ? $data['date_area_y'] : null; } /** @@ -161,85 +161,85 @@ public function valid() /** - * Gets document_data + * Gets date_area_height * @return string */ - public function getDocumentData() + public function getDateAreaHeight() { - return $this->container['document_data']; + return $this->container['date_area_height']; } /** - * Sets document_data - * @param string $document_data + * Sets date_area_height + * @param string $date_area_height * @return $this */ - public function setDocumentData($document_data) + public function setDateAreaHeight($date_area_height) { - $this->container['document_data'] = $document_data; + $this->container['date_area_height'] = $date_area_height; return $this; } /** - * Gets dpt_name + * Gets date_area_width * @return string */ - public function getDptName() + public function getDateAreaWidth() { - return $this->container['dpt_name']; + return $this->container['date_area_width']; } /** - * Sets dpt_name - * @param string $dpt_name + * Sets date_area_width + * @param string $date_area_width * @return $this */ - public function setDptName($dpt_name) + public function setDateAreaWidth($date_area_width) { - $this->container['dpt_name'] = $dpt_name; + $this->container['date_area_width'] = $date_area_width; return $this; } /** - * Gets transaction_name + * Gets date_area_x * @return string */ - public function getTransactionName() + public function getDateAreaX() { - return $this->container['transaction_name']; + return $this->container['date_area_x']; } /** - * Sets transaction_name - * @param string $transaction_name + * Sets date_area_x + * @param string $date_area_x * @return $this */ - public function setTransactionName($transaction_name) + public function setDateAreaX($date_area_x) { - $this->container['transaction_name'] = $transaction_name; + $this->container['date_area_x'] = $date_area_x; return $this; } /** - * Gets transaction_type_name + * Gets date_area_y * @return string */ - public function getTransactionTypeName() + public function getDateAreaY() { - return $this->container['transaction_type_name']; + return $this->container['date_area_y']; } /** - * Sets transaction_type_name - * @param string $transaction_type_name + * Sets date_area_y + * @param string $date_area_y * @return $this */ - public function setTransactionTypeName($transaction_type_name) + public function setDateAreaY($date_area_y) { - $this->container['transaction_type_name'] = $transaction_type_name; + $this->container['date_area_y'] = $date_area_y; return $this; } diff --git a/src/Model/Decline.php b/src/Model/Decline.php index 1b2fb17f..fc6ed8a4 100644 --- a/src/Model/Decline.php +++ b/src/Model/Decline.php @@ -79,11 +79,13 @@ class Decline implements ArrayAccess 'page_number' => 'string', 'recipient_id' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'width' => 'int', 'x_position' => 'string', @@ -125,11 +127,13 @@ public static function swaggerTypes() 'page_number' => 'pageNumber', 'recipient_id' => 'recipientId', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'width' => 'width', 'x_position' => 'xPosition', @@ -167,11 +171,13 @@ public static function swaggerTypes() 'page_number' => 'setPageNumber', 'recipient_id' => 'setRecipientId', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'width' => 'setWidth', 'x_position' => 'setXPosition', @@ -209,11 +215,13 @@ public static function swaggerTypes() 'page_number' => 'getPageNumber', 'recipient_id' => 'getRecipientId', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'width' => 'getWidth', 'x_position' => 'getXPosition', @@ -276,11 +284,13 @@ public function __construct(array $data = null) $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['width'] = isset($data['width']) ? $data['width'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; @@ -447,7 +457,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -468,7 +478,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -835,6 +845,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -940,6 +971,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string diff --git a/src/Model/DobInformationInput.php b/src/Model/DobInformationInput.php index 3e3b94c3..b4cbeb02 100644 --- a/src/Model/DobInformationInput.php +++ b/src/Model/DobInformationInput.php @@ -167,7 +167,7 @@ public function getDateOfBirth() /** * Sets date_of_birth - * @param string $date_of_birth Specifies the recipient’s date, month, and year of birth. + * @param string $date_of_birth Specifies the recipient's date, month, and year of birth. * @return $this */ public function setDateOfBirth($date_of_birth) diff --git a/src/Model/Document.php b/src/Model/Document.php index bbd4aa39..8a10fdbe 100644 --- a/src/Model/Document.php +++ b/src/Model/Document.php @@ -55,6 +55,7 @@ class Document implements ArrayAccess */ protected static $swaggerTypes = [ 'apply_anchor_tabs' => 'string', + 'authoritative_copy' => 'bool', 'display' => 'string', 'document_base64' => 'string', 'document_fields' => '\DocuSign\eSign\Model\NameValue[]', @@ -62,6 +63,8 @@ class Document implements ArrayAccess 'document_id' => 'string', 'encrypted_with_key_manager' => 'string', 'file_extension' => 'string', + 'file_format_hint' => 'string', + 'html_definition' => '\DocuSign\eSign\Model\DocumentHtmlDefinition', 'include_in_download' => 'string', 'match_boxes' => '\DocuSign\eSign\Model\MatchBox[]', 'name' => 'string', @@ -87,6 +90,7 @@ public static function swaggerTypes() */ protected static $attributeMap = [ 'apply_anchor_tabs' => 'applyAnchorTabs', + 'authoritative_copy' => 'authoritativeCopy', 'display' => 'display', 'document_base64' => 'documentBase64', 'document_fields' => 'documentFields', @@ -94,6 +98,8 @@ public static function swaggerTypes() 'document_id' => 'documentId', 'encrypted_with_key_manager' => 'encryptedWithKeyManager', 'file_extension' => 'fileExtension', + 'file_format_hint' => 'fileFormatHint', + 'html_definition' => 'htmlDefinition', 'include_in_download' => 'includeInDownload', 'match_boxes' => 'matchBoxes', 'name' => 'name', @@ -115,6 +121,7 @@ public static function swaggerTypes() */ protected static $setters = [ 'apply_anchor_tabs' => 'setApplyAnchorTabs', + 'authoritative_copy' => 'setAuthoritativeCopy', 'display' => 'setDisplay', 'document_base64' => 'setDocumentBase64', 'document_fields' => 'setDocumentFields', @@ -122,6 +129,8 @@ public static function swaggerTypes() 'document_id' => 'setDocumentId', 'encrypted_with_key_manager' => 'setEncryptedWithKeyManager', 'file_extension' => 'setFileExtension', + 'file_format_hint' => 'setFileFormatHint', + 'html_definition' => 'setHtmlDefinition', 'include_in_download' => 'setIncludeInDownload', 'match_boxes' => 'setMatchBoxes', 'name' => 'setName', @@ -143,6 +152,7 @@ public static function swaggerTypes() */ protected static $getters = [ 'apply_anchor_tabs' => 'getApplyAnchorTabs', + 'authoritative_copy' => 'getAuthoritativeCopy', 'display' => 'getDisplay', 'document_base64' => 'getDocumentBase64', 'document_fields' => 'getDocumentFields', @@ -150,6 +160,8 @@ public static function swaggerTypes() 'document_id' => 'getDocumentId', 'encrypted_with_key_manager' => 'getEncryptedWithKeyManager', 'file_extension' => 'getFileExtension', + 'file_format_hint' => 'getFileFormatHint', + 'html_definition' => 'getHtmlDefinition', 'include_in_download' => 'getIncludeInDownload', 'match_boxes' => 'getMatchBoxes', 'name' => 'getName', @@ -196,6 +208,7 @@ public static function getters() public function __construct(array $data = null) { $this->container['apply_anchor_tabs'] = isset($data['apply_anchor_tabs']) ? $data['apply_anchor_tabs'] : null; + $this->container['authoritative_copy'] = isset($data['authoritative_copy']) ? $data['authoritative_copy'] : null; $this->container['display'] = isset($data['display']) ? $data['display'] : null; $this->container['document_base64'] = isset($data['document_base64']) ? $data['document_base64'] : null; $this->container['document_fields'] = isset($data['document_fields']) ? $data['document_fields'] : null; @@ -203,6 +216,8 @@ public function __construct(array $data = null) $this->container['document_id'] = isset($data['document_id']) ? $data['document_id'] : null; $this->container['encrypted_with_key_manager'] = isset($data['encrypted_with_key_manager']) ? $data['encrypted_with_key_manager'] : null; $this->container['file_extension'] = isset($data['file_extension']) ? $data['file_extension'] : null; + $this->container['file_format_hint'] = isset($data['file_format_hint']) ? $data['file_format_hint'] : null; + $this->container['html_definition'] = isset($data['html_definition']) ? $data['html_definition'] : null; $this->container['include_in_download'] = isset($data['include_in_download']) ? $data['include_in_download'] : null; $this->container['match_boxes'] = isset($data['match_boxes']) ? $data['match_boxes'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; @@ -261,6 +276,27 @@ public function setApplyAnchorTabs($apply_anchor_tabs) return $this; } + /** + * Gets authoritative_copy + * @return bool + */ + public function getAuthoritativeCopy() + { + return $this->container['authoritative_copy']; + } + + /** + * Sets authoritative_copy + * @param bool $authoritative_copy Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. + * @return $this + */ + public function setAuthoritativeCopy($authoritative_copy) + { + $this->container['authoritative_copy'] = $authoritative_copy; + + return $this; + } + /** * Gets display * @return string @@ -293,7 +329,7 @@ public function getDocumentBase64() /** * Sets document_base64 - * @param string $document_base64 The document’s bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. + * @param string $document_base64 The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. * @return $this */ public function setDocumentBase64($document_base64) @@ -408,6 +444,48 @@ public function setFileExtension($file_extension) return $this; } + /** + * Gets file_format_hint + * @return string + */ + public function getFileFormatHint() + { + return $this->container['file_format_hint']; + } + + /** + * Sets file_format_hint + * @param string $file_format_hint + * @return $this + */ + public function setFileFormatHint($file_format_hint) + { + $this->container['file_format_hint'] = $file_format_hint; + + return $this; + } + + /** + * Gets html_definition + * @return \DocuSign\eSign\Model\DocumentHtmlDefinition + */ + public function getHtmlDefinition() + { + return $this->container['html_definition']; + } + + /** + * Sets html_definition + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $html_definition + * @return $this + */ + public function setHtmlDefinition($html_definition) + { + $this->container['html_definition'] = $html_definition; + + return $this; + } + /** * Gets include_in_download * @return string diff --git a/src/Model/DocumentFieldsInformation.php b/src/Model/DocumentFieldsInformation.php index 263df2fa..b2cd286f 100644 --- a/src/Model/DocumentFieldsInformation.php +++ b/src/Model/DocumentFieldsInformation.php @@ -156,7 +156,7 @@ public function getDocumentFields() /** * Sets document_fields - * @param \DocuSign\eSign\Model\NameValue[] $document_fields The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: * name – A string that can be a maximum of 50 characters. * value – A string that can be a maximum of 200 characters. *IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element. + * @param \DocuSign\eSign\Model\NameValue[] $document_fields The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: * name - A string that can be a maximum of 50 characters. * value - A string that can be a maximum of 200 characters. *IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element. * @return $this */ public function setDocumentFields($document_fields) diff --git a/src/Model/DocumentHtmlCollapsibleDisplaySettings.php b/src/Model/DocumentHtmlCollapsibleDisplaySettings.php new file mode 100644 index 00000000..ffb9421c --- /dev/null +++ b/src/Model/DocumentHtmlCollapsibleDisplaySettings.php @@ -0,0 +1,461 @@ + 'string', + 'arrow_color' => 'string', + 'arrow_location' => 'string', + 'arrow_open' => 'string', + 'arrow_size' => 'string', + 'arrow_style' => 'string', + 'container_style' => 'string', + 'label_style' => 'string', + 'only_arrow_is_clickable' => 'bool', + 'outer_label_and_arrow_style' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'arrow_closed' => 'arrowClosed', + 'arrow_color' => 'arrowColor', + 'arrow_location' => 'arrowLocation', + 'arrow_open' => 'arrowOpen', + 'arrow_size' => 'arrowSize', + 'arrow_style' => 'arrowStyle', + 'container_style' => 'containerStyle', + 'label_style' => 'labelStyle', + 'only_arrow_is_clickable' => 'onlyArrowIsClickable', + 'outer_label_and_arrow_style' => 'outerLabelAndArrowStyle' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'arrow_closed' => 'setArrowClosed', + 'arrow_color' => 'setArrowColor', + 'arrow_location' => 'setArrowLocation', + 'arrow_open' => 'setArrowOpen', + 'arrow_size' => 'setArrowSize', + 'arrow_style' => 'setArrowStyle', + 'container_style' => 'setContainerStyle', + 'label_style' => 'setLabelStyle', + 'only_arrow_is_clickable' => 'setOnlyArrowIsClickable', + 'outer_label_and_arrow_style' => 'setOuterLabelAndArrowStyle' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'arrow_closed' => 'getArrowClosed', + 'arrow_color' => 'getArrowColor', + 'arrow_location' => 'getArrowLocation', + 'arrow_open' => 'getArrowOpen', + 'arrow_size' => 'getArrowSize', + 'arrow_style' => 'getArrowStyle', + 'container_style' => 'getContainerStyle', + 'label_style' => 'getLabelStyle', + 'only_arrow_is_clickable' => 'getOnlyArrowIsClickable', + 'outer_label_and_arrow_style' => 'getOuterLabelAndArrowStyle' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['arrow_closed'] = isset($data['arrow_closed']) ? $data['arrow_closed'] : null; + $this->container['arrow_color'] = isset($data['arrow_color']) ? $data['arrow_color'] : null; + $this->container['arrow_location'] = isset($data['arrow_location']) ? $data['arrow_location'] : null; + $this->container['arrow_open'] = isset($data['arrow_open']) ? $data['arrow_open'] : null; + $this->container['arrow_size'] = isset($data['arrow_size']) ? $data['arrow_size'] : null; + $this->container['arrow_style'] = isset($data['arrow_style']) ? $data['arrow_style'] : null; + $this->container['container_style'] = isset($data['container_style']) ? $data['container_style'] : null; + $this->container['label_style'] = isset($data['label_style']) ? $data['label_style'] : null; + $this->container['only_arrow_is_clickable'] = isset($data['only_arrow_is_clickable']) ? $data['only_arrow_is_clickable'] : null; + $this->container['outer_label_and_arrow_style'] = isset($data['outer_label_and_arrow_style']) ? $data['outer_label_and_arrow_style'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets arrow_closed + * @return string + */ + public function getArrowClosed() + { + return $this->container['arrow_closed']; + } + + /** + * Sets arrow_closed + * @param string $arrow_closed + * @return $this + */ + public function setArrowClosed($arrow_closed) + { + $this->container['arrow_closed'] = $arrow_closed; + + return $this; + } + + /** + * Gets arrow_color + * @return string + */ + public function getArrowColor() + { + return $this->container['arrow_color']; + } + + /** + * Sets arrow_color + * @param string $arrow_color + * @return $this + */ + public function setArrowColor($arrow_color) + { + $this->container['arrow_color'] = $arrow_color; + + return $this; + } + + /** + * Gets arrow_location + * @return string + */ + public function getArrowLocation() + { + return $this->container['arrow_location']; + } + + /** + * Sets arrow_location + * @param string $arrow_location + * @return $this + */ + public function setArrowLocation($arrow_location) + { + $this->container['arrow_location'] = $arrow_location; + + return $this; + } + + /** + * Gets arrow_open + * @return string + */ + public function getArrowOpen() + { + return $this->container['arrow_open']; + } + + /** + * Sets arrow_open + * @param string $arrow_open + * @return $this + */ + public function setArrowOpen($arrow_open) + { + $this->container['arrow_open'] = $arrow_open; + + return $this; + } + + /** + * Gets arrow_size + * @return string + */ + public function getArrowSize() + { + return $this->container['arrow_size']; + } + + /** + * Sets arrow_size + * @param string $arrow_size + * @return $this + */ + public function setArrowSize($arrow_size) + { + $this->container['arrow_size'] = $arrow_size; + + return $this; + } + + /** + * Gets arrow_style + * @return string + */ + public function getArrowStyle() + { + return $this->container['arrow_style']; + } + + /** + * Sets arrow_style + * @param string $arrow_style + * @return $this + */ + public function setArrowStyle($arrow_style) + { + $this->container['arrow_style'] = $arrow_style; + + return $this; + } + + /** + * Gets container_style + * @return string + */ + public function getContainerStyle() + { + return $this->container['container_style']; + } + + /** + * Sets container_style + * @param string $container_style + * @return $this + */ + public function setContainerStyle($container_style) + { + $this->container['container_style'] = $container_style; + + return $this; + } + + /** + * Gets label_style + * @return string + */ + public function getLabelStyle() + { + return $this->container['label_style']; + } + + /** + * Sets label_style + * @param string $label_style + * @return $this + */ + public function setLabelStyle($label_style) + { + $this->container['label_style'] = $label_style; + + return $this; + } + + /** + * Gets only_arrow_is_clickable + * @return bool + */ + public function getOnlyArrowIsClickable() + { + return $this->container['only_arrow_is_clickable']; + } + + /** + * Sets only_arrow_is_clickable + * @param bool $only_arrow_is_clickable + * @return $this + */ + public function setOnlyArrowIsClickable($only_arrow_is_clickable) + { + $this->container['only_arrow_is_clickable'] = $only_arrow_is_clickable; + + return $this; + } + + /** + * Gets outer_label_and_arrow_style + * @return string + */ + public function getOuterLabelAndArrowStyle() + { + return $this->container['outer_label_and_arrow_style']; + } + + /** + * Sets outer_label_and_arrow_style + * @param string $outer_label_and_arrow_style + * @return $this + */ + public function setOuterLabelAndArrowStyle($outer_label_and_arrow_style) + { + $this->container['outer_label_and_arrow_style'] = $outer_label_and_arrow_style; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/DocumentHtmlDefinition.php b/src/Model/DocumentHtmlDefinition.php new file mode 100644 index 00000000..6b362f9b --- /dev/null +++ b/src/Model/DocumentHtmlDefinition.php @@ -0,0 +1,487 @@ + 'string', + 'display_anchors' => '\DocuSign\eSign\Model\DocumentHtmlDisplayAnchor[]', + 'display_order' => 'string', + 'display_page_number' => 'string', + 'document_guid' => 'string', + 'document_id' => 'string', + 'header_label' => 'string', + 'max_screen_width' => 'string', + 'remove_empty_tags' => 'string', + 'show_mobile_optimized_toggle' => 'string', + 'source' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'display_anchor_prefix' => 'displayAnchorPrefix', + 'display_anchors' => 'displayAnchors', + 'display_order' => 'displayOrder', + 'display_page_number' => 'displayPageNumber', + 'document_guid' => 'documentGuid', + 'document_id' => 'documentId', + 'header_label' => 'headerLabel', + 'max_screen_width' => 'maxScreenWidth', + 'remove_empty_tags' => 'removeEmptyTags', + 'show_mobile_optimized_toggle' => 'showMobileOptimizedToggle', + 'source' => 'source' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'display_anchor_prefix' => 'setDisplayAnchorPrefix', + 'display_anchors' => 'setDisplayAnchors', + 'display_order' => 'setDisplayOrder', + 'display_page_number' => 'setDisplayPageNumber', + 'document_guid' => 'setDocumentGuid', + 'document_id' => 'setDocumentId', + 'header_label' => 'setHeaderLabel', + 'max_screen_width' => 'setMaxScreenWidth', + 'remove_empty_tags' => 'setRemoveEmptyTags', + 'show_mobile_optimized_toggle' => 'setShowMobileOptimizedToggle', + 'source' => 'setSource' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'display_anchor_prefix' => 'getDisplayAnchorPrefix', + 'display_anchors' => 'getDisplayAnchors', + 'display_order' => 'getDisplayOrder', + 'display_page_number' => 'getDisplayPageNumber', + 'document_guid' => 'getDocumentGuid', + 'document_id' => 'getDocumentId', + 'header_label' => 'getHeaderLabel', + 'max_screen_width' => 'getMaxScreenWidth', + 'remove_empty_tags' => 'getRemoveEmptyTags', + 'show_mobile_optimized_toggle' => 'getShowMobileOptimizedToggle', + 'source' => 'getSource' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['display_anchor_prefix'] = isset($data['display_anchor_prefix']) ? $data['display_anchor_prefix'] : null; + $this->container['display_anchors'] = isset($data['display_anchors']) ? $data['display_anchors'] : null; + $this->container['display_order'] = isset($data['display_order']) ? $data['display_order'] : null; + $this->container['display_page_number'] = isset($data['display_page_number']) ? $data['display_page_number'] : null; + $this->container['document_guid'] = isset($data['document_guid']) ? $data['document_guid'] : null; + $this->container['document_id'] = isset($data['document_id']) ? $data['document_id'] : null; + $this->container['header_label'] = isset($data['header_label']) ? $data['header_label'] : null; + $this->container['max_screen_width'] = isset($data['max_screen_width']) ? $data['max_screen_width'] : null; + $this->container['remove_empty_tags'] = isset($data['remove_empty_tags']) ? $data['remove_empty_tags'] : null; + $this->container['show_mobile_optimized_toggle'] = isset($data['show_mobile_optimized_toggle']) ? $data['show_mobile_optimized_toggle'] : null; + $this->container['source'] = isset($data['source']) ? $data['source'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets display_anchor_prefix + * @return string + */ + public function getDisplayAnchorPrefix() + { + return $this->container['display_anchor_prefix']; + } + + /** + * Sets display_anchor_prefix + * @param string $display_anchor_prefix + * @return $this + */ + public function setDisplayAnchorPrefix($display_anchor_prefix) + { + $this->container['display_anchor_prefix'] = $display_anchor_prefix; + + return $this; + } + + /** + * Gets display_anchors + * @return \DocuSign\eSign\Model\DocumentHtmlDisplayAnchor[] + */ + public function getDisplayAnchors() + { + return $this->container['display_anchors']; + } + + /** + * Sets display_anchors + * @param \DocuSign\eSign\Model\DocumentHtmlDisplayAnchor[] $display_anchors + * @return $this + */ + public function setDisplayAnchors($display_anchors) + { + $this->container['display_anchors'] = $display_anchors; + + return $this; + } + + /** + * Gets display_order + * @return string + */ + public function getDisplayOrder() + { + return $this->container['display_order']; + } + + /** + * Sets display_order + * @param string $display_order + * @return $this + */ + public function setDisplayOrder($display_order) + { + $this->container['display_order'] = $display_order; + + return $this; + } + + /** + * Gets display_page_number + * @return string + */ + public function getDisplayPageNumber() + { + return $this->container['display_page_number']; + } + + /** + * Sets display_page_number + * @param string $display_page_number + * @return $this + */ + public function setDisplayPageNumber($display_page_number) + { + $this->container['display_page_number'] = $display_page_number; + + return $this; + } + + /** + * Gets document_guid + * @return string + */ + public function getDocumentGuid() + { + return $this->container['document_guid']; + } + + /** + * Sets document_guid + * @param string $document_guid + * @return $this + */ + public function setDocumentGuid($document_guid) + { + $this->container['document_guid'] = $document_guid; + + return $this; + } + + /** + * Gets document_id + * @return string + */ + public function getDocumentId() + { + return $this->container['document_id']; + } + + /** + * Sets document_id + * @param string $document_id Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + * @return $this + */ + public function setDocumentId($document_id) + { + $this->container['document_id'] = $document_id; + + return $this; + } + + /** + * Gets header_label + * @return string + */ + public function getHeaderLabel() + { + return $this->container['header_label']; + } + + /** + * Sets header_label + * @param string $header_label + * @return $this + */ + public function setHeaderLabel($header_label) + { + $this->container['header_label'] = $header_label; + + return $this; + } + + /** + * Gets max_screen_width + * @return string + */ + public function getMaxScreenWidth() + { + return $this->container['max_screen_width']; + } + + /** + * Sets max_screen_width + * @param string $max_screen_width + * @return $this + */ + public function setMaxScreenWidth($max_screen_width) + { + $this->container['max_screen_width'] = $max_screen_width; + + return $this; + } + + /** + * Gets remove_empty_tags + * @return string + */ + public function getRemoveEmptyTags() + { + return $this->container['remove_empty_tags']; + } + + /** + * Sets remove_empty_tags + * @param string $remove_empty_tags + * @return $this + */ + public function setRemoveEmptyTags($remove_empty_tags) + { + $this->container['remove_empty_tags'] = $remove_empty_tags; + + return $this; + } + + /** + * Gets show_mobile_optimized_toggle + * @return string + */ + public function getShowMobileOptimizedToggle() + { + return $this->container['show_mobile_optimized_toggle']; + } + + /** + * Sets show_mobile_optimized_toggle + * @param string $show_mobile_optimized_toggle + * @return $this + */ + public function setShowMobileOptimizedToggle($show_mobile_optimized_toggle) + { + $this->container['show_mobile_optimized_toggle'] = $show_mobile_optimized_toggle; + + return $this; + } + + /** + * Gets source + * @return string + */ + public function getSource() + { + return $this->container['source']; + } + + /** + * Sets source + * @param string $source + * @return $this + */ + public function setSource($source) + { + $this->container['source'] = $source; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/DocumentHtmlDefinitionOriginal.php b/src/Model/DocumentHtmlDefinitionOriginal.php new file mode 100644 index 00000000..0f337368 --- /dev/null +++ b/src/Model/DocumentHtmlDefinitionOriginal.php @@ -0,0 +1,279 @@ + 'string', + 'document_id_guid' => 'string', + 'html_definition' => '\DocuSign\eSign\Model\DocumentHtmlDefinition' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'document_id' => 'documentId', + 'document_id_guid' => 'documentIdGuid', + 'html_definition' => 'htmlDefinition' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'document_id' => 'setDocumentId', + 'document_id_guid' => 'setDocumentIdGuid', + 'html_definition' => 'setHtmlDefinition' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'document_id' => 'getDocumentId', + 'document_id_guid' => 'getDocumentIdGuid', + 'html_definition' => 'getHtmlDefinition' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['document_id'] = isset($data['document_id']) ? $data['document_id'] : null; + $this->container['document_id_guid'] = isset($data['document_id_guid']) ? $data['document_id_guid'] : null; + $this->container['html_definition'] = isset($data['html_definition']) ? $data['html_definition'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets document_id + * @return string + */ + public function getDocumentId() + { + return $this->container['document_id']; + } + + /** + * Sets document_id + * @param string $document_id Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + * @return $this + */ + public function setDocumentId($document_id) + { + $this->container['document_id'] = $document_id; + + return $this; + } + + /** + * Gets document_id_guid + * @return string + */ + public function getDocumentIdGuid() + { + return $this->container['document_id_guid']; + } + + /** + * Sets document_id_guid + * @param string $document_id_guid + * @return $this + */ + public function setDocumentIdGuid($document_id_guid) + { + $this->container['document_id_guid'] = $document_id_guid; + + return $this; + } + + /** + * Gets html_definition + * @return \DocuSign\eSign\Model\DocumentHtmlDefinition + */ + public function getHtmlDefinition() + { + return $this->container['html_definition']; + } + + /** + * Sets html_definition + * @param \DocuSign\eSign\Model\DocumentHtmlDefinition $html_definition + * @return $this + */ + public function setHtmlDefinition($html_definition) + { + $this->container['html_definition'] = $html_definition; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/DocumentHtmlDefinitionOriginals.php b/src/Model/DocumentHtmlDefinitionOriginals.php new file mode 100644 index 00000000..c87097a1 --- /dev/null +++ b/src/Model/DocumentHtmlDefinitionOriginals.php @@ -0,0 +1,227 @@ + '\DocuSign\eSign\Model\DocumentHtmlDefinitionOriginal[]' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'html_definitions' => 'htmlDefinitions' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'html_definitions' => 'setHtmlDefinitions' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'html_definitions' => 'getHtmlDefinitions' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['html_definitions'] = isset($data['html_definitions']) ? $data['html_definitions'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets html_definitions + * @return \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginal[] + */ + public function getHtmlDefinitions() + { + return $this->container['html_definitions']; + } + + /** + * Sets html_definitions + * @param \DocuSign\eSign\Model\DocumentHtmlDefinitionOriginal[] $html_definitions + * @return $this + */ + public function setHtmlDefinitions($html_definitions) + { + $this->container['html_definitions'] = $html_definitions; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/DocumentHtmlDefinitions.php b/src/Model/DocumentHtmlDefinitions.php new file mode 100644 index 00000000..b9c193f8 --- /dev/null +++ b/src/Model/DocumentHtmlDefinitions.php @@ -0,0 +1,227 @@ + 'string[]' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'html_definitions' => 'htmlDefinitions' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'html_definitions' => 'setHtmlDefinitions' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'html_definitions' => 'getHtmlDefinitions' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['html_definitions'] = isset($data['html_definitions']) ? $data['html_definitions'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets html_definitions + * @return string[] + */ + public function getHtmlDefinitions() + { + return $this->container['html_definitions']; + } + + /** + * Sets html_definitions + * @param string[] $html_definitions + * @return $this + */ + public function setHtmlDefinitions($html_definitions) + { + $this->container['html_definitions'] = $html_definitions; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/DocumentHtmlDisplayAnchor.php b/src/Model/DocumentHtmlDisplayAnchor.php new file mode 100644 index 00000000..cada1ab3 --- /dev/null +++ b/src/Model/DocumentHtmlDisplayAnchor.php @@ -0,0 +1,357 @@ + 'bool', + 'display_settings' => '\DocuSign\eSign\Model\DocumentHtmlDisplaySettings', + 'end_anchor' => 'string', + 'remove_end_anchor' => 'bool', + 'remove_start_anchor' => 'bool', + 'start_anchor' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'case_sensitive' => 'caseSensitive', + 'display_settings' => 'displaySettings', + 'end_anchor' => 'endAnchor', + 'remove_end_anchor' => 'removeEndAnchor', + 'remove_start_anchor' => 'removeStartAnchor', + 'start_anchor' => 'startAnchor' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'case_sensitive' => 'setCaseSensitive', + 'display_settings' => 'setDisplaySettings', + 'end_anchor' => 'setEndAnchor', + 'remove_end_anchor' => 'setRemoveEndAnchor', + 'remove_start_anchor' => 'setRemoveStartAnchor', + 'start_anchor' => 'setStartAnchor' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'case_sensitive' => 'getCaseSensitive', + 'display_settings' => 'getDisplaySettings', + 'end_anchor' => 'getEndAnchor', + 'remove_end_anchor' => 'getRemoveEndAnchor', + 'remove_start_anchor' => 'getRemoveStartAnchor', + 'start_anchor' => 'getStartAnchor' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['case_sensitive'] = isset($data['case_sensitive']) ? $data['case_sensitive'] : null; + $this->container['display_settings'] = isset($data['display_settings']) ? $data['display_settings'] : null; + $this->container['end_anchor'] = isset($data['end_anchor']) ? $data['end_anchor'] : null; + $this->container['remove_end_anchor'] = isset($data['remove_end_anchor']) ? $data['remove_end_anchor'] : null; + $this->container['remove_start_anchor'] = isset($data['remove_start_anchor']) ? $data['remove_start_anchor'] : null; + $this->container['start_anchor'] = isset($data['start_anchor']) ? $data['start_anchor'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets case_sensitive + * @return bool + */ + public function getCaseSensitive() + { + return $this->container['case_sensitive']; + } + + /** + * Sets case_sensitive + * @param bool $case_sensitive + * @return $this + */ + public function setCaseSensitive($case_sensitive) + { + $this->container['case_sensitive'] = $case_sensitive; + + return $this; + } + + /** + * Gets display_settings + * @return \DocuSign\eSign\Model\DocumentHtmlDisplaySettings + */ + public function getDisplaySettings() + { + return $this->container['display_settings']; + } + + /** + * Sets display_settings + * @param \DocuSign\eSign\Model\DocumentHtmlDisplaySettings $display_settings + * @return $this + */ + public function setDisplaySettings($display_settings) + { + $this->container['display_settings'] = $display_settings; + + return $this; + } + + /** + * Gets end_anchor + * @return string + */ + public function getEndAnchor() + { + return $this->container['end_anchor']; + } + + /** + * Sets end_anchor + * @param string $end_anchor + * @return $this + */ + public function setEndAnchor($end_anchor) + { + $this->container['end_anchor'] = $end_anchor; + + return $this; + } + + /** + * Gets remove_end_anchor + * @return bool + */ + public function getRemoveEndAnchor() + { + return $this->container['remove_end_anchor']; + } + + /** + * Sets remove_end_anchor + * @param bool $remove_end_anchor + * @return $this + */ + public function setRemoveEndAnchor($remove_end_anchor) + { + $this->container['remove_end_anchor'] = $remove_end_anchor; + + return $this; + } + + /** + * Gets remove_start_anchor + * @return bool + */ + public function getRemoveStartAnchor() + { + return $this->container['remove_start_anchor']; + } + + /** + * Sets remove_start_anchor + * @param bool $remove_start_anchor + * @return $this + */ + public function setRemoveStartAnchor($remove_start_anchor) + { + $this->container['remove_start_anchor'] = $remove_start_anchor; + + return $this; + } + + /** + * Gets start_anchor + * @return string + */ + public function getStartAnchor() + { + return $this->container['start_anchor']; + } + + /** + * Sets start_anchor + * @param string $start_anchor + * @return $this + */ + public function setStartAnchor($start_anchor) + { + $this->container['start_anchor'] = $start_anchor; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/DocumentHtmlDisplaySettings.php b/src/Model/DocumentHtmlDisplaySettings.php new file mode 100644 index 00000000..3a68a631 --- /dev/null +++ b/src/Model/DocumentHtmlDisplaySettings.php @@ -0,0 +1,487 @@ + 'string', + 'collapsible_settings' => '\DocuSign\eSign\Model\DocumentHtmlCollapsibleDisplaySettings', + 'display' => 'string', + 'display_label' => 'string', + 'display_order' => 'int', + 'display_page_number' => 'int', + 'hide_label_when_opened' => 'bool', + 'inline_outer_style' => 'string', + 'label_when_opened' => 'string', + 'scroll_to_top_when_opened' => 'bool', + 'table_style' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'cell_style' => 'cellStyle', + 'collapsible_settings' => 'collapsibleSettings', + 'display' => 'display', + 'display_label' => 'displayLabel', + 'display_order' => 'displayOrder', + 'display_page_number' => 'displayPageNumber', + 'hide_label_when_opened' => 'hideLabelWhenOpened', + 'inline_outer_style' => 'inlineOuterStyle', + 'label_when_opened' => 'labelWhenOpened', + 'scroll_to_top_when_opened' => 'scrollToTopWhenOpened', + 'table_style' => 'tableStyle' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'cell_style' => 'setCellStyle', + 'collapsible_settings' => 'setCollapsibleSettings', + 'display' => 'setDisplay', + 'display_label' => 'setDisplayLabel', + 'display_order' => 'setDisplayOrder', + 'display_page_number' => 'setDisplayPageNumber', + 'hide_label_when_opened' => 'setHideLabelWhenOpened', + 'inline_outer_style' => 'setInlineOuterStyle', + 'label_when_opened' => 'setLabelWhenOpened', + 'scroll_to_top_when_opened' => 'setScrollToTopWhenOpened', + 'table_style' => 'setTableStyle' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'cell_style' => 'getCellStyle', + 'collapsible_settings' => 'getCollapsibleSettings', + 'display' => 'getDisplay', + 'display_label' => 'getDisplayLabel', + 'display_order' => 'getDisplayOrder', + 'display_page_number' => 'getDisplayPageNumber', + 'hide_label_when_opened' => 'getHideLabelWhenOpened', + 'inline_outer_style' => 'getInlineOuterStyle', + 'label_when_opened' => 'getLabelWhenOpened', + 'scroll_to_top_when_opened' => 'getScrollToTopWhenOpened', + 'table_style' => 'getTableStyle' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['cell_style'] = isset($data['cell_style']) ? $data['cell_style'] : null; + $this->container['collapsible_settings'] = isset($data['collapsible_settings']) ? $data['collapsible_settings'] : null; + $this->container['display'] = isset($data['display']) ? $data['display'] : null; + $this->container['display_label'] = isset($data['display_label']) ? $data['display_label'] : null; + $this->container['display_order'] = isset($data['display_order']) ? $data['display_order'] : null; + $this->container['display_page_number'] = isset($data['display_page_number']) ? $data['display_page_number'] : null; + $this->container['hide_label_when_opened'] = isset($data['hide_label_when_opened']) ? $data['hide_label_when_opened'] : null; + $this->container['inline_outer_style'] = isset($data['inline_outer_style']) ? $data['inline_outer_style'] : null; + $this->container['label_when_opened'] = isset($data['label_when_opened']) ? $data['label_when_opened'] : null; + $this->container['scroll_to_top_when_opened'] = isset($data['scroll_to_top_when_opened']) ? $data['scroll_to_top_when_opened'] : null; + $this->container['table_style'] = isset($data['table_style']) ? $data['table_style'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets cell_style + * @return string + */ + public function getCellStyle() + { + return $this->container['cell_style']; + } + + /** + * Sets cell_style + * @param string $cell_style + * @return $this + */ + public function setCellStyle($cell_style) + { + $this->container['cell_style'] = $cell_style; + + return $this; + } + + /** + * Gets collapsible_settings + * @return \DocuSign\eSign\Model\DocumentHtmlCollapsibleDisplaySettings + */ + public function getCollapsibleSettings() + { + return $this->container['collapsible_settings']; + } + + /** + * Sets collapsible_settings + * @param \DocuSign\eSign\Model\DocumentHtmlCollapsibleDisplaySettings $collapsible_settings + * @return $this + */ + public function setCollapsibleSettings($collapsible_settings) + { + $this->container['collapsible_settings'] = $collapsible_settings; + + return $this; + } + + /** + * Gets display + * @return string + */ + public function getDisplay() + { + return $this->container['display']; + } + + /** + * Sets display + * @param string $display + * @return $this + */ + public function setDisplay($display) + { + $this->container['display'] = $display; + + return $this; + } + + /** + * Gets display_label + * @return string + */ + public function getDisplayLabel() + { + return $this->container['display_label']; + } + + /** + * Sets display_label + * @param string $display_label + * @return $this + */ + public function setDisplayLabel($display_label) + { + $this->container['display_label'] = $display_label; + + return $this; + } + + /** + * Gets display_order + * @return int + */ + public function getDisplayOrder() + { + return $this->container['display_order']; + } + + /** + * Sets display_order + * @param int $display_order + * @return $this + */ + public function setDisplayOrder($display_order) + { + $this->container['display_order'] = $display_order; + + return $this; + } + + /** + * Gets display_page_number + * @return int + */ + public function getDisplayPageNumber() + { + return $this->container['display_page_number']; + } + + /** + * Sets display_page_number + * @param int $display_page_number + * @return $this + */ + public function setDisplayPageNumber($display_page_number) + { + $this->container['display_page_number'] = $display_page_number; + + return $this; + } + + /** + * Gets hide_label_when_opened + * @return bool + */ + public function getHideLabelWhenOpened() + { + return $this->container['hide_label_when_opened']; + } + + /** + * Sets hide_label_when_opened + * @param bool $hide_label_when_opened + * @return $this + */ + public function setHideLabelWhenOpened($hide_label_when_opened) + { + $this->container['hide_label_when_opened'] = $hide_label_when_opened; + + return $this; + } + + /** + * Gets inline_outer_style + * @return string + */ + public function getInlineOuterStyle() + { + return $this->container['inline_outer_style']; + } + + /** + * Sets inline_outer_style + * @param string $inline_outer_style + * @return $this + */ + public function setInlineOuterStyle($inline_outer_style) + { + $this->container['inline_outer_style'] = $inline_outer_style; + + return $this; + } + + /** + * Gets label_when_opened + * @return string + */ + public function getLabelWhenOpened() + { + return $this->container['label_when_opened']; + } + + /** + * Sets label_when_opened + * @param string $label_when_opened + * @return $this + */ + public function setLabelWhenOpened($label_when_opened) + { + $this->container['label_when_opened'] = $label_when_opened; + + return $this; + } + + /** + * Gets scroll_to_top_when_opened + * @return bool + */ + public function getScrollToTopWhenOpened() + { + return $this->container['scroll_to_top_when_opened']; + } + + /** + * Sets scroll_to_top_when_opened + * @param bool $scroll_to_top_when_opened + * @return $this + */ + public function setScrollToTopWhenOpened($scroll_to_top_when_opened) + { + $this->container['scroll_to_top_when_opened'] = $scroll_to_top_when_opened; + + return $this; + } + + /** + * Gets table_style + * @return string + */ + public function getTableStyle() + { + return $this->container['table_style']; + } + + /** + * Sets table_style + * @param string $table_style + * @return $this + */ + public function setTableStyle($table_style) + { + $this->container['table_style'] = $table_style; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/DocumentSecurityStore.php b/src/Model/DocumentSecurityStore.php new file mode 100644 index 00000000..7aa8ba50 --- /dev/null +++ b/src/Model/DocumentSecurityStore.php @@ -0,0 +1,279 @@ + 'string[]', + 'crls' => 'string[]', + 'ocsps' => 'string[]' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'certificates' => 'certificates', + 'crls' => 'crls', + 'ocsps' => 'ocsps' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'certificates' => 'setCertificates', + 'crls' => 'setCrls', + 'ocsps' => 'setOcsps' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'certificates' => 'getCertificates', + 'crls' => 'getCrls', + 'ocsps' => 'getOcsps' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['certificates'] = isset($data['certificates']) ? $data['certificates'] : null; + $this->container['crls'] = isset($data['crls']) ? $data['crls'] : null; + $this->container['ocsps'] = isset($data['ocsps']) ? $data['ocsps'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets certificates + * @return string[] + */ + public function getCertificates() + { + return $this->container['certificates']; + } + + /** + * Sets certificates + * @param string[] $certificates + * @return $this + */ + public function setCertificates($certificates) + { + $this->container['certificates'] = $certificates; + + return $this; + } + + /** + * Gets crls + * @return string[] + */ + public function getCrls() + { + return $this->container['crls']; + } + + /** + * Sets crls + * @param string[] $crls + * @return $this + */ + public function setCrls($crls) + { + $this->container['crls'] = $crls; + + return $this; + } + + /** + * Gets ocsps + * @return string[] + */ + public function getOcsps() + { + return $this->container['ocsps']; + } + + /** + * Sets ocsps + * @param string[] $ocsps + * @return $this + */ + public function setOcsps($ocsps) + { + $this->container['ocsps'] = $ocsps; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/DocumentUpdateInfo.php b/src/Model/DocumentUpdateInfo.php new file mode 100644 index 00000000..8d984f6b --- /dev/null +++ b/src/Model/DocumentUpdateInfo.php @@ -0,0 +1,383 @@ + 'string', + 'document_id' => 'string', + 'document_security_store' => '\DocuSign\eSign\Model\DocumentSecurityStore', + 'name' => 'string', + 'return_format' => 'string', + 'signature_data_infos' => '\DocuSign\eSign\Model\SignatureDataInfo[]', + 'time_stamp_field' => '\DocuSign\eSign\Model\TimeStampField' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'data' => 'data', + 'document_id' => 'documentId', + 'document_security_store' => 'documentSecurityStore', + 'name' => 'name', + 'return_format' => 'returnFormat', + 'signature_data_infos' => 'signatureDataInfos', + 'time_stamp_field' => 'timeStampField' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'data' => 'setData', + 'document_id' => 'setDocumentId', + 'document_security_store' => 'setDocumentSecurityStore', + 'name' => 'setName', + 'return_format' => 'setReturnFormat', + 'signature_data_infos' => 'setSignatureDataInfos', + 'time_stamp_field' => 'setTimeStampField' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'data' => 'getData', + 'document_id' => 'getDocumentId', + 'document_security_store' => 'getDocumentSecurityStore', + 'name' => 'getName', + 'return_format' => 'getReturnFormat', + 'signature_data_infos' => 'getSignatureDataInfos', + 'time_stamp_field' => 'getTimeStampField' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['data'] = isset($data['data']) ? $data['data'] : null; + $this->container['document_id'] = isset($data['document_id']) ? $data['document_id'] : null; + $this->container['document_security_store'] = isset($data['document_security_store']) ? $data['document_security_store'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['return_format'] = isset($data['return_format']) ? $data['return_format'] : null; + $this->container['signature_data_infos'] = isset($data['signature_data_infos']) ? $data['signature_data_infos'] : null; + $this->container['time_stamp_field'] = isset($data['time_stamp_field']) ? $data['time_stamp_field'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets data + * @return string + */ + public function getData() + { + return $this->container['data']; + } + + /** + * Sets data + * @param string $data + * @return $this + */ + public function setData($data) + { + $this->container['data'] = $data; + + return $this; + } + + /** + * Gets document_id + * @return string + */ + public function getDocumentId() + { + return $this->container['document_id']; + } + + /** + * Sets document_id + * @param string $document_id Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + * @return $this + */ + public function setDocumentId($document_id) + { + $this->container['document_id'] = $document_id; + + return $this; + } + + /** + * Gets document_security_store + * @return \DocuSign\eSign\Model\DocumentSecurityStore + */ + public function getDocumentSecurityStore() + { + return $this->container['document_security_store']; + } + + /** + * Sets document_security_store + * @param \DocuSign\eSign\Model\DocumentSecurityStore $document_security_store + * @return $this + */ + public function setDocumentSecurityStore($document_security_store) + { + $this->container['document_security_store'] = $document_security_store; + + return $this; + } + + /** + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + + /** + * Gets return_format + * @return string + */ + public function getReturnFormat() + { + return $this->container['return_format']; + } + + /** + * Sets return_format + * @param string $return_format + * @return $this + */ + public function setReturnFormat($return_format) + { + $this->container['return_format'] = $return_format; + + return $this; + } + + /** + * Gets signature_data_infos + * @return \DocuSign\eSign\Model\SignatureDataInfo[] + */ + public function getSignatureDataInfos() + { + return $this->container['signature_data_infos']; + } + + /** + * Sets signature_data_infos + * @param \DocuSign\eSign\Model\SignatureDataInfo[] $signature_data_infos + * @return $this + */ + public function setSignatureDataInfos($signature_data_infos) + { + $this->container['signature_data_infos'] = $signature_data_infos; + + return $this; + } + + /** + * Gets time_stamp_field + * @return \DocuSign\eSign\Model\TimeStampField + */ + public function getTimeStampField() + { + return $this->container['time_stamp_field']; + } + + /** + * Sets time_stamp_field + * @param \DocuSign\eSign\Model\TimeStampField $time_stamp_field + * @return $this + */ + public function setTimeStampField($time_stamp_field) + { + $this->container['time_stamp_field'] = $time_stamp_field; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Editor.php b/src/Model/Editor.php index 665fdf96..42d3c46f 100644 --- a/src/Model/Editor.php +++ b/src/Model/Editor.php @@ -69,9 +69,12 @@ class Editor implements ArrayAccess 'embedded_recipient_start_url' => 'string', 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', 'fax_number' => 'string', + 'first_name' => 'string', + 'full_name' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', 'inherit_email_notification_configuration' => 'string', + 'last_name' => 'string', 'name' => 'string', 'note' => 'string', 'phone_authentication' => '\DocuSign\eSign\Model\RecipientPhoneAuthentication', @@ -122,9 +125,12 @@ public static function swaggerTypes() 'embedded_recipient_start_url' => 'embeddedRecipientStartURL', 'error_details' => 'errorDetails', 'fax_number' => 'faxNumber', + 'first_name' => 'firstName', + 'full_name' => 'fullName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', + 'last_name' => 'lastName', 'name' => 'name', 'note' => 'note', 'phone_authentication' => 'phoneAuthentication', @@ -171,9 +177,12 @@ public static function swaggerTypes() 'embedded_recipient_start_url' => 'setEmbeddedRecipientStartUrl', 'error_details' => 'setErrorDetails', 'fax_number' => 'setFaxNumber', + 'first_name' => 'setFirstName', + 'full_name' => 'setFullName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', + 'last_name' => 'setLastName', 'name' => 'setName', 'note' => 'setNote', 'phone_authentication' => 'setPhoneAuthentication', @@ -220,9 +229,12 @@ public static function swaggerTypes() 'embedded_recipient_start_url' => 'getEmbeddedRecipientStartUrl', 'error_details' => 'getErrorDetails', 'fax_number' => 'getFaxNumber', + 'first_name' => 'getFirstName', + 'full_name' => 'getFullName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', + 'last_name' => 'getLastName', 'name' => 'getName', 'note' => 'getNote', 'phone_authentication' => 'getPhoneAuthentication', @@ -294,9 +306,12 @@ public function __construct(array $data = null) $this->container['embedded_recipient_start_url'] = isset($data['embedded_recipient_start_url']) ? $data['embedded_recipient_start_url'] : null; $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; $this->container['fax_number'] = isset($data['fax_number']) ? $data['fax_number'] : null; + $this->container['first_name'] = isset($data['first_name']) ? $data['first_name'] : null; + $this->container['full_name'] = isset($data['full_name']) ? $data['full_name'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; + $this->container['last_name'] = isset($data['last_name']) ? $data['last_name'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['note'] = isset($data['note']) ? $data['note'] : null; $this->container['phone_authentication'] = isset($data['phone_authentication']) ? $data['phone_authentication'] : null; @@ -356,7 +371,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) @@ -608,7 +623,7 @@ public function getEmbeddedRecipientStartUrl() /** * Sets embedded_recipient_start_url - * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -660,6 +675,48 @@ public function setFaxNumber($fax_number) return $this; } + /** + * Gets first_name + * @return string + */ + public function getFirstName() + { + return $this->container['first_name']; + } + + /** + * Sets first_name + * @param string $first_name The user's first name. Maximum Length: 50 characters. + * @return $this + */ + public function setFirstName($first_name) + { + $this->container['first_name'] = $first_name; + + return $this; + } + + /** + * Gets full_name + * @return string + */ + public function getFullName() + { + return $this->container['full_name']; + } + + /** + * Sets full_name + * @param string $full_name + * @return $this + */ + public function setFullName($full_name) + { + $this->container['full_name'] = $full_name; + + return $this; + } + /** * Gets id_check_configuration_name * @return string @@ -723,6 +780,27 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica return $this; } + /** + * Gets last_name + * @return string + */ + public function getLastName() + { + return $this->container['last_name']; + } + + /** + * Sets last_name + * @param string $last_name + * @return $this + */ + public function setLastName($last_name) + { + $this->container['last_name'] = $last_name; + + return $this; + } + /** * Gets name * @return string diff --git a/src/Model/Email.php b/src/Model/Email.php index 190bf336..29292119 100644 --- a/src/Model/Email.php +++ b/src/Model/Email.php @@ -87,11 +87,13 @@ class Email implements ArrayAccess 'sender_required' => 'string', 'shared' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'validation_message' => 'string', 'validation_pattern' => 'string', @@ -144,11 +146,13 @@ public static function swaggerTypes() 'sender_required' => 'senderRequired', 'shared' => 'shared', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'validation_message' => 'validationMessage', 'validation_pattern' => 'validationPattern', @@ -197,11 +201,13 @@ public static function swaggerTypes() 'sender_required' => 'setSenderRequired', 'shared' => 'setShared', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'validation_message' => 'setValidationMessage', 'validation_pattern' => 'setValidationPattern', @@ -250,11 +256,13 @@ public static function swaggerTypes() 'sender_required' => 'getSenderRequired', 'shared' => 'getShared', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'validation_message' => 'getValidationMessage', 'validation_pattern' => 'getValidationPattern', @@ -328,11 +336,13 @@ public function __construct(array $data = null) $this->container['sender_required'] = isset($data['sender_required']) ? $data['sender_required'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['validation_message'] = isset($data['validation_message']) ? $data['validation_message'] : null; $this->container['validation_pattern'] = isset($data['validation_pattern']) ? $data['validation_pattern'] : null; @@ -502,7 +512,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -523,7 +533,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -1058,6 +1068,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -1163,6 +1194,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -1216,7 +1268,7 @@ public function getValidationPattern() /** * Sets validation_pattern - * @param string $validation_pattern A regular expressionn used to validate input for the tab. + * @param string $validation_pattern A regular expression used to validate input for the tab. * @return $this */ public function setValidationPattern($validation_pattern) diff --git a/src/Model/EmailAddress.php b/src/Model/EmailAddress.php index 2439a1b8..298dd42e 100644 --- a/src/Model/EmailAddress.php +++ b/src/Model/EmailAddress.php @@ -77,12 +77,15 @@ class EmailAddress implements ArrayAccess 'page_number' => 'string', 'recipient_id' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', + 'value' => 'string', 'x_position' => 'string', 'y_position' => 'string' ]; @@ -120,12 +123,15 @@ public static function swaggerTypes() 'page_number' => 'pageNumber', 'recipient_id' => 'recipientId', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', + 'value' => 'value', 'x_position' => 'xPosition', 'y_position' => 'yPosition' ]; @@ -159,12 +165,15 @@ public static function swaggerTypes() 'page_number' => 'setPageNumber', 'recipient_id' => 'setRecipientId', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', + 'value' => 'setValue', 'x_position' => 'setXPosition', 'y_position' => 'setYPosition' ]; @@ -198,12 +207,15 @@ public static function swaggerTypes() 'page_number' => 'getPageNumber', 'recipient_id' => 'getRecipientId', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', + 'value' => 'getValue', 'x_position' => 'getXPosition', 'y_position' => 'getYPosition' ]; @@ -262,12 +274,15 @@ public function __construct(array $data = null) $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; + $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; } @@ -432,7 +447,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -453,7 +468,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -778,6 +793,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -883,6 +919,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -904,6 +961,27 @@ public function setUnderline($underline) return $this; } + /** + * Gets value + * @return string + */ + public function getValue() + { + return $this->container['value']; + } + + /** + * Sets value + * @param string $value Specifies the value of the tab. + * @return $this + */ + public function setValue($value) + { + $this->container['value'] = $value; + + return $this; + } + /** * Gets x_position * @return string diff --git a/src/Model/EmailSettings.php b/src/Model/EmailSettings.php index 7eff2db2..6b3934d0 100644 --- a/src/Model/EmailSettings.php +++ b/src/Model/EmailSettings.php @@ -35,7 +35,7 @@ * EmailSettings Class Doc Comment * * @category Class - * @description A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. **IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. *Example*: if your account has BCC for Email Archive set up for the email address ‘archive@mycompany.com’ and you send an envelope using the BCC Email Override to send a BCC email to ‘salesarchive@mycompany.com’, then a copy of the envelope is only sent to the ‘salesarchive@mycompany.com’ email address. + * @description A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. **IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. *Example*: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address. * @package DocuSign\eSign * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen diff --git a/src/Model/Envelope.php b/src/Model/Envelope.php index 73b9b476..4c42a6b3 100644 --- a/src/Model/Envelope.php +++ b/src/Model/Envelope.php @@ -56,9 +56,11 @@ class Envelope implements ArrayAccess protected static $swaggerTypes = [ 'allow_markup' => 'string', 'allow_reassign' => 'string', + 'allow_view_history' => 'string', 'asynchronous' => 'string', 'attachments_uri' => 'string', 'authoritative_copy' => 'string', + 'authoritative_copy_default' => 'string', 'auto_navigation' => 'string', 'brand_id' => 'string', 'brand_lock' => 'string', @@ -93,6 +95,7 @@ class Envelope implements ArrayAccess 'recipients_lock' => 'string', 'recipients_uri' => 'string', 'sent_date_time' => 'string', + 'signer_can_sign_on_mobile' => 'string', 'signing_location' => 'string', 'status' => 'string', 'status_changed_date_time' => 'string', @@ -115,9 +118,11 @@ public static function swaggerTypes() protected static $attributeMap = [ 'allow_markup' => 'allowMarkup', 'allow_reassign' => 'allowReassign', + 'allow_view_history' => 'allowViewHistory', 'asynchronous' => 'asynchronous', 'attachments_uri' => 'attachmentsUri', 'authoritative_copy' => 'authoritativeCopy', + 'authoritative_copy_default' => 'authoritativeCopyDefault', 'auto_navigation' => 'autoNavigation', 'brand_id' => 'brandId', 'brand_lock' => 'brandLock', @@ -152,6 +157,7 @@ public static function swaggerTypes() 'recipients_lock' => 'recipientsLock', 'recipients_uri' => 'recipientsUri', 'sent_date_time' => 'sentDateTime', + 'signer_can_sign_on_mobile' => 'signerCanSignOnMobile', 'signing_location' => 'signingLocation', 'status' => 'status', 'status_changed_date_time' => 'statusChangedDateTime', @@ -170,9 +176,11 @@ public static function swaggerTypes() protected static $setters = [ 'allow_markup' => 'setAllowMarkup', 'allow_reassign' => 'setAllowReassign', + 'allow_view_history' => 'setAllowViewHistory', 'asynchronous' => 'setAsynchronous', 'attachments_uri' => 'setAttachmentsUri', 'authoritative_copy' => 'setAuthoritativeCopy', + 'authoritative_copy_default' => 'setAuthoritativeCopyDefault', 'auto_navigation' => 'setAutoNavigation', 'brand_id' => 'setBrandId', 'brand_lock' => 'setBrandLock', @@ -207,6 +215,7 @@ public static function swaggerTypes() 'recipients_lock' => 'setRecipientsLock', 'recipients_uri' => 'setRecipientsUri', 'sent_date_time' => 'setSentDateTime', + 'signer_can_sign_on_mobile' => 'setSignerCanSignOnMobile', 'signing_location' => 'setSigningLocation', 'status' => 'setStatus', 'status_changed_date_time' => 'setStatusChangedDateTime', @@ -225,9 +234,11 @@ public static function swaggerTypes() protected static $getters = [ 'allow_markup' => 'getAllowMarkup', 'allow_reassign' => 'getAllowReassign', + 'allow_view_history' => 'getAllowViewHistory', 'asynchronous' => 'getAsynchronous', 'attachments_uri' => 'getAttachmentsUri', 'authoritative_copy' => 'getAuthoritativeCopy', + 'authoritative_copy_default' => 'getAuthoritativeCopyDefault', 'auto_navigation' => 'getAutoNavigation', 'brand_id' => 'getBrandId', 'brand_lock' => 'getBrandLock', @@ -262,6 +273,7 @@ public static function swaggerTypes() 'recipients_lock' => 'getRecipientsLock', 'recipients_uri' => 'getRecipientsUri', 'sent_date_time' => 'getSentDateTime', + 'signer_can_sign_on_mobile' => 'getSignerCanSignOnMobile', 'signing_location' => 'getSigningLocation', 'status' => 'getStatus', 'status_changed_date_time' => 'getStatusChangedDateTime', @@ -305,9 +317,11 @@ public function __construct(array $data = null) { $this->container['allow_markup'] = isset($data['allow_markup']) ? $data['allow_markup'] : null; $this->container['allow_reassign'] = isset($data['allow_reassign']) ? $data['allow_reassign'] : null; + $this->container['allow_view_history'] = isset($data['allow_view_history']) ? $data['allow_view_history'] : null; $this->container['asynchronous'] = isset($data['asynchronous']) ? $data['asynchronous'] : null; $this->container['attachments_uri'] = isset($data['attachments_uri']) ? $data['attachments_uri'] : null; $this->container['authoritative_copy'] = isset($data['authoritative_copy']) ? $data['authoritative_copy'] : null; + $this->container['authoritative_copy_default'] = isset($data['authoritative_copy_default']) ? $data['authoritative_copy_default'] : null; $this->container['auto_navigation'] = isset($data['auto_navigation']) ? $data['auto_navigation'] : null; $this->container['brand_id'] = isset($data['brand_id']) ? $data['brand_id'] : null; $this->container['brand_lock'] = isset($data['brand_lock']) ? $data['brand_lock'] : null; @@ -342,6 +356,7 @@ public function __construct(array $data = null) $this->container['recipients_lock'] = isset($data['recipients_lock']) ? $data['recipients_lock'] : null; $this->container['recipients_uri'] = isset($data['recipients_uri']) ? $data['recipients_uri'] : null; $this->container['sent_date_time'] = isset($data['sent_date_time']) ? $data['sent_date_time'] : null; + $this->container['signer_can_sign_on_mobile'] = isset($data['signer_can_sign_on_mobile']) ? $data['signer_can_sign_on_mobile'] : null; $this->container['signing_location'] = isset($data['signing_location']) ? $data['signing_location'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['status_changed_date_time'] = isset($data['status_changed_date_time']) ? $data['status_changed_date_time'] : null; @@ -417,6 +432,27 @@ public function setAllowReassign($allow_reassign) return $this; } + /** + * Gets allow_view_history + * @return string + */ + public function getAllowViewHistory() + { + return $this->container['allow_view_history']; + } + + /** + * Sets allow_view_history + * @param string $allow_view_history + * @return $this + */ + public function setAllowViewHistory($allow_view_history) + { + $this->container['allow_view_history'] = $allow_view_history; + + return $this; + } + /** * Gets asynchronous * @return string @@ -480,6 +516,27 @@ public function setAuthoritativeCopy($authoritative_copy) return $this; } + /** + * Gets authoritative_copy_default + * @return string + */ + public function getAuthoritativeCopyDefault() + { + return $this->container['authoritative_copy_default']; + } + + /** + * Sets authoritative_copy_default + * @param string $authoritative_copy_default + * @return $this + */ + public function setAuthoritativeCopyDefault($authoritative_copy_default) + { + $this->container['authoritative_copy_default'] = $authoritative_copy_default; + + return $this; + } + /** * Gets auto_navigation * @return string @@ -1194,6 +1251,27 @@ public function setSentDateTime($sent_date_time) return $this; } + /** + * Gets signer_can_sign_on_mobile + * @return string + */ + public function getSignerCanSignOnMobile() + { + return $this->container['signer_can_sign_on_mobile']; + } + + /** + * Sets signer_can_sign_on_mobile + * @param string $signer_can_sign_on_mobile + * @return $this + */ + public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) + { + $this->container['signer_can_sign_on_mobile'] = $signer_can_sign_on_mobile; + + return $this; + } + /** * Gets signing_location * @return string @@ -1310,7 +1388,7 @@ public function getUseDisclosure() /** * Sets use_disclosure - * @param string $use_disclosure When set to **true**, the disclosure is shown to recipients in accordance with the account’s Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. + * @param string $use_disclosure When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. * @return $this */ public function setUseDisclosure($use_disclosure) diff --git a/src/Model/EnvelopeDefinition.php b/src/Model/EnvelopeDefinition.php index 4bd09b9d..0fe018c7 100644 --- a/src/Model/EnvelopeDefinition.php +++ b/src/Model/EnvelopeDefinition.php @@ -58,10 +58,12 @@ class EnvelopeDefinition implements ArrayAccess 'allow_markup' => 'string', 'allow_reassign' => 'string', 'allow_recipient_recursion' => 'string', + 'allow_view_history' => 'string', 'asynchronous' => 'string', 'attachments' => '\DocuSign\eSign\Model\Attachment[]', 'attachments_uri' => 'string', 'authoritative_copy' => 'string', + 'authoritative_copy_default' => 'string', 'auto_navigation' => 'string', 'brand_id' => 'string', 'brand_lock' => 'string', @@ -100,6 +102,7 @@ class EnvelopeDefinition implements ArrayAccess 'recipients_lock' => 'string', 'recipients_uri' => 'string', 'sent_date_time' => 'string', + 'signer_can_sign_on_mobile' => 'string', 'signing_location' => 'string', 'status' => 'string', 'status_changed_date_time' => 'string', @@ -126,10 +129,12 @@ public static function swaggerTypes() 'allow_markup' => 'allowMarkup', 'allow_reassign' => 'allowReassign', 'allow_recipient_recursion' => 'allowRecipientRecursion', + 'allow_view_history' => 'allowViewHistory', 'asynchronous' => 'asynchronous', 'attachments' => 'attachments', 'attachments_uri' => 'attachmentsUri', 'authoritative_copy' => 'authoritativeCopy', + 'authoritative_copy_default' => 'authoritativeCopyDefault', 'auto_navigation' => 'autoNavigation', 'brand_id' => 'brandId', 'brand_lock' => 'brandLock', @@ -168,6 +173,7 @@ public static function swaggerTypes() 'recipients_lock' => 'recipientsLock', 'recipients_uri' => 'recipientsUri', 'sent_date_time' => 'sentDateTime', + 'signer_can_sign_on_mobile' => 'signerCanSignOnMobile', 'signing_location' => 'signingLocation', 'status' => 'status', 'status_changed_date_time' => 'statusChangedDateTime', @@ -190,10 +196,12 @@ public static function swaggerTypes() 'allow_markup' => 'setAllowMarkup', 'allow_reassign' => 'setAllowReassign', 'allow_recipient_recursion' => 'setAllowRecipientRecursion', + 'allow_view_history' => 'setAllowViewHistory', 'asynchronous' => 'setAsynchronous', 'attachments' => 'setAttachments', 'attachments_uri' => 'setAttachmentsUri', 'authoritative_copy' => 'setAuthoritativeCopy', + 'authoritative_copy_default' => 'setAuthoritativeCopyDefault', 'auto_navigation' => 'setAutoNavigation', 'brand_id' => 'setBrandId', 'brand_lock' => 'setBrandLock', @@ -232,6 +240,7 @@ public static function swaggerTypes() 'recipients_lock' => 'setRecipientsLock', 'recipients_uri' => 'setRecipientsUri', 'sent_date_time' => 'setSentDateTime', + 'signer_can_sign_on_mobile' => 'setSignerCanSignOnMobile', 'signing_location' => 'setSigningLocation', 'status' => 'setStatus', 'status_changed_date_time' => 'setStatusChangedDateTime', @@ -254,10 +263,12 @@ public static function swaggerTypes() 'allow_markup' => 'getAllowMarkup', 'allow_reassign' => 'getAllowReassign', 'allow_recipient_recursion' => 'getAllowRecipientRecursion', + 'allow_view_history' => 'getAllowViewHistory', 'asynchronous' => 'getAsynchronous', 'attachments' => 'getAttachments', 'attachments_uri' => 'getAttachmentsUri', 'authoritative_copy' => 'getAuthoritativeCopy', + 'authoritative_copy_default' => 'getAuthoritativeCopyDefault', 'auto_navigation' => 'getAutoNavigation', 'brand_id' => 'getBrandId', 'brand_lock' => 'getBrandLock', @@ -296,6 +307,7 @@ public static function swaggerTypes() 'recipients_lock' => 'getRecipientsLock', 'recipients_uri' => 'getRecipientsUri', 'sent_date_time' => 'getSentDateTime', + 'signer_can_sign_on_mobile' => 'getSignerCanSignOnMobile', 'signing_location' => 'getSigningLocation', 'status' => 'getStatus', 'status_changed_date_time' => 'getStatusChangedDateTime', @@ -343,10 +355,12 @@ public function __construct(array $data = null) $this->container['allow_markup'] = isset($data['allow_markup']) ? $data['allow_markup'] : null; $this->container['allow_reassign'] = isset($data['allow_reassign']) ? $data['allow_reassign'] : null; $this->container['allow_recipient_recursion'] = isset($data['allow_recipient_recursion']) ? $data['allow_recipient_recursion'] : null; + $this->container['allow_view_history'] = isset($data['allow_view_history']) ? $data['allow_view_history'] : null; $this->container['asynchronous'] = isset($data['asynchronous']) ? $data['asynchronous'] : null; $this->container['attachments'] = isset($data['attachments']) ? $data['attachments'] : null; $this->container['attachments_uri'] = isset($data['attachments_uri']) ? $data['attachments_uri'] : null; $this->container['authoritative_copy'] = isset($data['authoritative_copy']) ? $data['authoritative_copy'] : null; + $this->container['authoritative_copy_default'] = isset($data['authoritative_copy_default']) ? $data['authoritative_copy_default'] : null; $this->container['auto_navigation'] = isset($data['auto_navigation']) ? $data['auto_navigation'] : null; $this->container['brand_id'] = isset($data['brand_id']) ? $data['brand_id'] : null; $this->container['brand_lock'] = isset($data['brand_lock']) ? $data['brand_lock'] : null; @@ -385,6 +399,7 @@ public function __construct(array $data = null) $this->container['recipients_lock'] = isset($data['recipients_lock']) ? $data['recipients_lock'] : null; $this->container['recipients_uri'] = isset($data['recipients_uri']) ? $data['recipients_uri'] : null; $this->container['sent_date_time'] = isset($data['sent_date_time']) ? $data['sent_date_time'] : null; + $this->container['signer_can_sign_on_mobile'] = isset($data['signer_can_sign_on_mobile']) ? $data['signer_can_sign_on_mobile'] : null; $this->container['signing_location'] = isset($data['signing_location']) ? $data['signing_location'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['status_changed_date_time'] = isset($data['status_changed_date_time']) ? $data['status_changed_date_time'] : null; @@ -504,6 +519,27 @@ public function setAllowRecipientRecursion($allow_recipient_recursion) return $this; } + /** + * Gets allow_view_history + * @return string + */ + public function getAllowViewHistory() + { + return $this->container['allow_view_history']; + } + + /** + * Sets allow_view_history + * @param string $allow_view_history + * @return $this + */ + public function setAllowViewHistory($allow_view_history) + { + $this->container['allow_view_history'] = $allow_view_history; + + return $this; + } + /** * Gets asynchronous * @return string @@ -588,6 +624,27 @@ public function setAuthoritativeCopy($authoritative_copy) return $this; } + /** + * Gets authoritative_copy_default + * @return string + */ + public function getAuthoritativeCopyDefault() + { + return $this->container['authoritative_copy_default']; + } + + /** + * Sets authoritative_copy_default + * @param string $authoritative_copy_default + * @return $this + */ + public function setAuthoritativeCopyDefault($authoritative_copy_default) + { + $this->container['authoritative_copy_default'] = $authoritative_copy_default; + + return $this; + } + /** * Gets auto_navigation * @return string @@ -1386,6 +1443,27 @@ public function setSentDateTime($sent_date_time) return $this; } + /** + * Gets signer_can_sign_on_mobile + * @return string + */ + public function getSignerCanSignOnMobile() + { + return $this->container['signer_can_sign_on_mobile']; + } + + /** + * Sets signer_can_sign_on_mobile + * @param string $signer_can_sign_on_mobile + * @return $this + */ + public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) + { + $this->container['signer_can_sign_on_mobile'] = $signer_can_sign_on_mobile; + + return $this; + } + /** * Gets signing_location * @return string @@ -1481,7 +1559,7 @@ public function getTemplateRoles() /** * Sets template_roles - * @param \DocuSign\eSign\Model\TemplateRole[] $template_roles Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up elements: * email - The recipient’s email address. * name - The recipient’s name. * roleName - The template roleName associated with the recipient. * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. * defaultRecipient - Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. * routingOrder - This specifies the routing order of the recipient in the envelope. * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. * emailNotification - This is an optional complex element that has a role specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. * tabs - This allows the tab values to be specified for matching to tabs in the template. + * @param \DocuSign\eSign\Model\TemplateRole[] $template_roles Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up elements: * email - The recipient's email address. * name - The recipient's name. * roleName - The template roleName associated with the recipient. * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. * defaultRecipient - Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. * routingOrder - This specifies the routing order of the recipient in the envelope. * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. * emailNotification - This is an optional complex element that has a role specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. * tabs - This allows the tab values to be specified for matching to tabs in the template. * @return $this */ public function setTemplateRoles($template_roles) @@ -1544,7 +1622,7 @@ public function getUseDisclosure() /** * Sets use_disclosure - * @param string $use_disclosure When set to **true**, the disclosure is shown to recipients in accordance with the account’s Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. + * @param string $use_disclosure When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. * @return $this */ public function setUseDisclosure($use_disclosure) diff --git a/src/Model/EnvelopeDocument.php b/src/Model/EnvelopeDocument.php index 9f57add5..efff98aa 100644 --- a/src/Model/EnvelopeDocument.php +++ b/src/Model/EnvelopeDocument.php @@ -55,6 +55,7 @@ class EnvelopeDocument implements ArrayAccess */ protected static $swaggerTypes = [ 'attachment_tab_id' => 'string', + 'authoritative_copy' => 'string', 'available_document_types' => '\DocuSign\eSign\Model\SignatureType[]', 'contains_pdf_form_fields' => 'string', 'display' => 'string', @@ -67,8 +68,6 @@ class EnvelopeDocument implements ArrayAccess 'order' => 'string', 'pages' => 'string', 'signer_must_acknowledge' => 'string', - 'template_locked' => 'string', - 'template_required' => 'string', 'type' => 'string', 'uri' => 'string' ]; @@ -84,6 +83,7 @@ public static function swaggerTypes() */ protected static $attributeMap = [ 'attachment_tab_id' => 'attachmentTabId', + 'authoritative_copy' => 'authoritativeCopy', 'available_document_types' => 'availableDocumentTypes', 'contains_pdf_form_fields' => 'containsPdfFormFields', 'display' => 'display', @@ -96,8 +96,6 @@ public static function swaggerTypes() 'order' => 'order', 'pages' => 'pages', 'signer_must_acknowledge' => 'signerMustAcknowledge', - 'template_locked' => 'templateLocked', - 'template_required' => 'templateRequired', 'type' => 'type', 'uri' => 'uri' ]; @@ -109,6 +107,7 @@ public static function swaggerTypes() */ protected static $setters = [ 'attachment_tab_id' => 'setAttachmentTabId', + 'authoritative_copy' => 'setAuthoritativeCopy', 'available_document_types' => 'setAvailableDocumentTypes', 'contains_pdf_form_fields' => 'setContainsPdfFormFields', 'display' => 'setDisplay', @@ -121,8 +120,6 @@ public static function swaggerTypes() 'order' => 'setOrder', 'pages' => 'setPages', 'signer_must_acknowledge' => 'setSignerMustAcknowledge', - 'template_locked' => 'setTemplateLocked', - 'template_required' => 'setTemplateRequired', 'type' => 'setType', 'uri' => 'setUri' ]; @@ -134,6 +131,7 @@ public static function swaggerTypes() */ protected static $getters = [ 'attachment_tab_id' => 'getAttachmentTabId', + 'authoritative_copy' => 'getAuthoritativeCopy', 'available_document_types' => 'getAvailableDocumentTypes', 'contains_pdf_form_fields' => 'getContainsPdfFormFields', 'display' => 'getDisplay', @@ -146,8 +144,6 @@ public static function swaggerTypes() 'order' => 'getOrder', 'pages' => 'getPages', 'signer_must_acknowledge' => 'getSignerMustAcknowledge', - 'template_locked' => 'getTemplateLocked', - 'template_required' => 'getTemplateRequired', 'type' => 'getType', 'uri' => 'getUri' ]; @@ -184,6 +180,7 @@ public static function getters() public function __construct(array $data = null) { $this->container['attachment_tab_id'] = isset($data['attachment_tab_id']) ? $data['attachment_tab_id'] : null; + $this->container['authoritative_copy'] = isset($data['authoritative_copy']) ? $data['authoritative_copy'] : null; $this->container['available_document_types'] = isset($data['available_document_types']) ? $data['available_document_types'] : null; $this->container['contains_pdf_form_fields'] = isset($data['contains_pdf_form_fields']) ? $data['contains_pdf_form_fields'] : null; $this->container['display'] = isset($data['display']) ? $data['display'] : null; @@ -196,8 +193,6 @@ public function __construct(array $data = null) $this->container['order'] = isset($data['order']) ? $data['order'] : null; $this->container['pages'] = isset($data['pages']) ? $data['pages'] : null; $this->container['signer_must_acknowledge'] = isset($data['signer_must_acknowledge']) ? $data['signer_must_acknowledge'] : null; - $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; - $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['uri'] = isset($data['uri']) ? $data['uri'] : null; } @@ -246,6 +241,27 @@ public function setAttachmentTabId($attachment_tab_id) return $this; } + /** + * Gets authoritative_copy + * @return string + */ + public function getAuthoritativeCopy() + { + return $this->container['authoritative_copy']; + } + + /** + * Sets authoritative_copy + * @param string $authoritative_copy Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. + * @return $this + */ + public function setAuthoritativeCopy($authoritative_copy) + { + $this->container['authoritative_copy'] = $authoritative_copy; + + return $this; + } + /** * Gets available_document_types * @return \DocuSign\eSign\Model\SignatureType[] @@ -498,48 +514,6 @@ public function setSignerMustAcknowledge($signer_must_acknowledge) return $this; } - /** - * Gets template_locked - * @return string - */ - public function getTemplateLocked() - { - return $this->container['template_locked']; - } - - /** - * Sets template_locked - * @param string $template_locked When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - * @return $this - */ - public function setTemplateLocked($template_locked) - { - $this->container['template_locked'] = $template_locked; - - return $this; - } - - /** - * Gets template_required - * @return string - */ - public function getTemplateRequired() - { - return $this->container['template_required']; - } - - /** - * Sets template_required - * @param string $template_required When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - * @return $this - */ - public function setTemplateRequired($template_required) - { - $this->container['template_required'] = $template_required; - - return $this; - } - /** * Gets type * @return string diff --git a/src/Model/EnvelopeId.php b/src/Model/EnvelopeId.php index b60db46f..83d298ad 100644 --- a/src/Model/EnvelopeId.php +++ b/src/Model/EnvelopeId.php @@ -77,11 +77,13 @@ class EnvelopeId implements ArrayAccess 'page_number' => 'string', 'recipient_id' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'x_position' => 'string', 'y_position' => 'string' @@ -120,11 +122,13 @@ public static function swaggerTypes() 'page_number' => 'pageNumber', 'recipient_id' => 'recipientId', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'x_position' => 'xPosition', 'y_position' => 'yPosition' @@ -159,11 +163,13 @@ public static function swaggerTypes() 'page_number' => 'setPageNumber', 'recipient_id' => 'setRecipientId', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'x_position' => 'setXPosition', 'y_position' => 'setYPosition' @@ -198,11 +204,13 @@ public static function swaggerTypes() 'page_number' => 'getPageNumber', 'recipient_id' => 'getRecipientId', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'x_position' => 'getXPosition', 'y_position' => 'getYPosition' @@ -262,11 +270,13 @@ public function __construct(array $data = null) $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; @@ -432,7 +442,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -453,7 +463,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -778,6 +788,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -883,6 +914,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string diff --git a/src/Model/EnvelopeTemplate.php b/src/Model/EnvelopeTemplate.php index ea803f27..36c94bff 100644 --- a/src/Model/EnvelopeTemplate.php +++ b/src/Model/EnvelopeTemplate.php @@ -56,9 +56,11 @@ class EnvelopeTemplate implements ArrayAccess protected static $swaggerTypes = [ 'allow_markup' => 'string', 'allow_reassign' => 'string', + 'allow_view_history' => 'string', 'asynchronous' => 'string', 'attachments_uri' => 'string', 'authoritative_copy' => 'string', + 'authoritative_copy_default' => 'string', 'auto_navigation' => 'string', 'brand_id' => 'string', 'brand_lock' => 'string', @@ -95,6 +97,7 @@ class EnvelopeTemplate implements ArrayAccess 'recipients_lock' => 'string', 'recipients_uri' => 'string', 'sent_date_time' => 'string', + 'signer_can_sign_on_mobile' => 'string', 'signing_location' => 'string', 'status' => 'string', 'status_changed_date_time' => 'string', @@ -117,9 +120,11 @@ public static function swaggerTypes() protected static $attributeMap = [ 'allow_markup' => 'allowMarkup', 'allow_reassign' => 'allowReassign', + 'allow_view_history' => 'allowViewHistory', 'asynchronous' => 'asynchronous', 'attachments_uri' => 'attachmentsUri', 'authoritative_copy' => 'authoritativeCopy', + 'authoritative_copy_default' => 'authoritativeCopyDefault', 'auto_navigation' => 'autoNavigation', 'brand_id' => 'brandId', 'brand_lock' => 'brandLock', @@ -156,6 +161,7 @@ public static function swaggerTypes() 'recipients_lock' => 'recipientsLock', 'recipients_uri' => 'recipientsUri', 'sent_date_time' => 'sentDateTime', + 'signer_can_sign_on_mobile' => 'signerCanSignOnMobile', 'signing_location' => 'signingLocation', 'status' => 'status', 'status_changed_date_time' => 'statusChangedDateTime', @@ -174,9 +180,11 @@ public static function swaggerTypes() protected static $setters = [ 'allow_markup' => 'setAllowMarkup', 'allow_reassign' => 'setAllowReassign', + 'allow_view_history' => 'setAllowViewHistory', 'asynchronous' => 'setAsynchronous', 'attachments_uri' => 'setAttachmentsUri', 'authoritative_copy' => 'setAuthoritativeCopy', + 'authoritative_copy_default' => 'setAuthoritativeCopyDefault', 'auto_navigation' => 'setAutoNavigation', 'brand_id' => 'setBrandId', 'brand_lock' => 'setBrandLock', @@ -213,6 +221,7 @@ public static function swaggerTypes() 'recipients_lock' => 'setRecipientsLock', 'recipients_uri' => 'setRecipientsUri', 'sent_date_time' => 'setSentDateTime', + 'signer_can_sign_on_mobile' => 'setSignerCanSignOnMobile', 'signing_location' => 'setSigningLocation', 'status' => 'setStatus', 'status_changed_date_time' => 'setStatusChangedDateTime', @@ -231,9 +240,11 @@ public static function swaggerTypes() protected static $getters = [ 'allow_markup' => 'getAllowMarkup', 'allow_reassign' => 'getAllowReassign', + 'allow_view_history' => 'getAllowViewHistory', 'asynchronous' => 'getAsynchronous', 'attachments_uri' => 'getAttachmentsUri', 'authoritative_copy' => 'getAuthoritativeCopy', + 'authoritative_copy_default' => 'getAuthoritativeCopyDefault', 'auto_navigation' => 'getAutoNavigation', 'brand_id' => 'getBrandId', 'brand_lock' => 'getBrandLock', @@ -270,6 +281,7 @@ public static function swaggerTypes() 'recipients_lock' => 'getRecipientsLock', 'recipients_uri' => 'getRecipientsUri', 'sent_date_time' => 'getSentDateTime', + 'signer_can_sign_on_mobile' => 'getSignerCanSignOnMobile', 'signing_location' => 'getSigningLocation', 'status' => 'getStatus', 'status_changed_date_time' => 'getStatusChangedDateTime', @@ -313,9 +325,11 @@ public function __construct(array $data = null) { $this->container['allow_markup'] = isset($data['allow_markup']) ? $data['allow_markup'] : null; $this->container['allow_reassign'] = isset($data['allow_reassign']) ? $data['allow_reassign'] : null; + $this->container['allow_view_history'] = isset($data['allow_view_history']) ? $data['allow_view_history'] : null; $this->container['asynchronous'] = isset($data['asynchronous']) ? $data['asynchronous'] : null; $this->container['attachments_uri'] = isset($data['attachments_uri']) ? $data['attachments_uri'] : null; $this->container['authoritative_copy'] = isset($data['authoritative_copy']) ? $data['authoritative_copy'] : null; + $this->container['authoritative_copy_default'] = isset($data['authoritative_copy_default']) ? $data['authoritative_copy_default'] : null; $this->container['auto_navigation'] = isset($data['auto_navigation']) ? $data['auto_navigation'] : null; $this->container['brand_id'] = isset($data['brand_id']) ? $data['brand_id'] : null; $this->container['brand_lock'] = isset($data['brand_lock']) ? $data['brand_lock'] : null; @@ -352,6 +366,7 @@ public function __construct(array $data = null) $this->container['recipients_lock'] = isset($data['recipients_lock']) ? $data['recipients_lock'] : null; $this->container['recipients_uri'] = isset($data['recipients_uri']) ? $data['recipients_uri'] : null; $this->container['sent_date_time'] = isset($data['sent_date_time']) ? $data['sent_date_time'] : null; + $this->container['signer_can_sign_on_mobile'] = isset($data['signer_can_sign_on_mobile']) ? $data['signer_can_sign_on_mobile'] : null; $this->container['signing_location'] = isset($data['signing_location']) ? $data['signing_location'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['status_changed_date_time'] = isset($data['status_changed_date_time']) ? $data['status_changed_date_time'] : null; @@ -427,6 +442,27 @@ public function setAllowReassign($allow_reassign) return $this; } + /** + * Gets allow_view_history + * @return string + */ + public function getAllowViewHistory() + { + return $this->container['allow_view_history']; + } + + /** + * Sets allow_view_history + * @param string $allow_view_history + * @return $this + */ + public function setAllowViewHistory($allow_view_history) + { + $this->container['allow_view_history'] = $allow_view_history; + + return $this; + } + /** * Gets asynchronous * @return string @@ -490,6 +526,27 @@ public function setAuthoritativeCopy($authoritative_copy) return $this; } + /** + * Gets authoritative_copy_default + * @return string + */ + public function getAuthoritativeCopyDefault() + { + return $this->container['authoritative_copy_default']; + } + + /** + * Sets authoritative_copy_default + * @param string $authoritative_copy_default + * @return $this + */ + public function setAuthoritativeCopyDefault($authoritative_copy_default) + { + $this->container['authoritative_copy_default'] = $authoritative_copy_default; + + return $this; + } + /** * Gets auto_navigation * @return string @@ -1246,6 +1303,27 @@ public function setSentDateTime($sent_date_time) return $this; } + /** + * Gets signer_can_sign_on_mobile + * @return string + */ + public function getSignerCanSignOnMobile() + { + return $this->container['signer_can_sign_on_mobile']; + } + + /** + * Sets signer_can_sign_on_mobile + * @param string $signer_can_sign_on_mobile + * @return $this + */ + public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) + { + $this->container['signer_can_sign_on_mobile'] = $signer_can_sign_on_mobile; + + return $this; + } + /** * Gets signing_location * @return string @@ -1362,7 +1440,7 @@ public function getUseDisclosure() /** * Sets use_disclosure - * @param string $use_disclosure When set to **true**, the disclosure is shown to recipients in accordance with the account’s Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. + * @param string $use_disclosure When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. * @return $this */ public function setUseDisclosure($use_disclosure) diff --git a/src/Model/EnvelopeTemplateDefinition.php b/src/Model/EnvelopeTemplateDefinition.php index cf93d2da..8841f55f 100644 --- a/src/Model/EnvelopeTemplateDefinition.php +++ b/src/Model/EnvelopeTemplateDefinition.php @@ -55,6 +55,7 @@ class EnvelopeTemplateDefinition implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ + 'created' => 'string', 'description' => 'string', 'folder_id' => 'string', 'folder_name' => 'string', @@ -82,6 +83,7 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ + 'created' => 'created', 'description' => 'description', 'folder_id' => 'folderId', 'folder_name' => 'folderName', @@ -105,6 +107,7 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ + 'created' => 'setCreated', 'description' => 'setDescription', 'folder_id' => 'setFolderId', 'folder_name' => 'setFolderName', @@ -128,6 +131,7 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ + 'created' => 'getCreated', 'description' => 'getDescription', 'folder_id' => 'getFolderId', 'folder_name' => 'getFolderName', @@ -176,6 +180,7 @@ public static function getters() */ public function __construct(array $data = null) { + $this->container['created'] = isset($data['created']) ? $data['created'] : null; $this->container['description'] = isset($data['description']) ? $data['description'] : null; $this->container['folder_id'] = isset($data['folder_id']) ? $data['folder_id'] : null; $this->container['folder_name'] = isset($data['folder_name']) ? $data['folder_name'] : null; @@ -216,6 +221,27 @@ public function valid() } + /** + * Gets created + * @return string + */ + public function getCreated() + { + return $this->container['created']; + } + + /** + * Sets created + * @param string $created + * @return $this + */ + public function setCreated($created) + { + $this->container['created'] = $created; + + return $this; + } + /** * Gets description * @return string diff --git a/src/Model/EnvelopeTemplateResult.php b/src/Model/EnvelopeTemplateResult.php index de9c0068..39467ad4 100644 --- a/src/Model/EnvelopeTemplateResult.php +++ b/src/Model/EnvelopeTemplateResult.php @@ -56,14 +56,17 @@ class EnvelopeTemplateResult implements ArrayAccess protected static $swaggerTypes = [ 'allow_markup' => 'string', 'allow_reassign' => 'string', + 'allow_view_history' => 'string', 'asynchronous' => 'string', 'attachments_uri' => 'string', 'authoritative_copy' => 'string', + 'authoritative_copy_default' => 'string', 'auto_navigation' => 'string', 'brand_id' => 'string', 'brand_lock' => 'string', 'certificate_uri' => 'string', 'completed_date_time' => 'string', + 'created' => 'string', 'created_date_time' => 'string', 'custom_fields' => '\DocuSign\eSign\Model\CustomFields', 'custom_fields_uri' => 'string', @@ -105,6 +108,7 @@ class EnvelopeTemplateResult implements ArrayAccess 'recipients_uri' => 'string', 'sent_date_time' => 'string', 'shared' => 'string', + 'signer_can_sign_on_mobile' => 'string', 'signing_location' => 'string', 'status' => 'string', 'status_changed_date_time' => 'string', @@ -129,14 +133,17 @@ public static function swaggerTypes() protected static $attributeMap = [ 'allow_markup' => 'allowMarkup', 'allow_reassign' => 'allowReassign', + 'allow_view_history' => 'allowViewHistory', 'asynchronous' => 'asynchronous', 'attachments_uri' => 'attachmentsUri', 'authoritative_copy' => 'authoritativeCopy', + 'authoritative_copy_default' => 'authoritativeCopyDefault', 'auto_navigation' => 'autoNavigation', 'brand_id' => 'brandId', 'brand_lock' => 'brandLock', 'certificate_uri' => 'certificateUri', 'completed_date_time' => 'completedDateTime', + 'created' => 'created', 'created_date_time' => 'createdDateTime', 'custom_fields' => 'customFields', 'custom_fields_uri' => 'customFieldsUri', @@ -178,6 +185,7 @@ public static function swaggerTypes() 'recipients_uri' => 'recipientsUri', 'sent_date_time' => 'sentDateTime', 'shared' => 'shared', + 'signer_can_sign_on_mobile' => 'signerCanSignOnMobile', 'signing_location' => 'signingLocation', 'status' => 'status', 'status_changed_date_time' => 'statusChangedDateTime', @@ -198,14 +206,17 @@ public static function swaggerTypes() protected static $setters = [ 'allow_markup' => 'setAllowMarkup', 'allow_reassign' => 'setAllowReassign', + 'allow_view_history' => 'setAllowViewHistory', 'asynchronous' => 'setAsynchronous', 'attachments_uri' => 'setAttachmentsUri', 'authoritative_copy' => 'setAuthoritativeCopy', + 'authoritative_copy_default' => 'setAuthoritativeCopyDefault', 'auto_navigation' => 'setAutoNavigation', 'brand_id' => 'setBrandId', 'brand_lock' => 'setBrandLock', 'certificate_uri' => 'setCertificateUri', 'completed_date_time' => 'setCompletedDateTime', + 'created' => 'setCreated', 'created_date_time' => 'setCreatedDateTime', 'custom_fields' => 'setCustomFields', 'custom_fields_uri' => 'setCustomFieldsUri', @@ -247,6 +258,7 @@ public static function swaggerTypes() 'recipients_uri' => 'setRecipientsUri', 'sent_date_time' => 'setSentDateTime', 'shared' => 'setShared', + 'signer_can_sign_on_mobile' => 'setSignerCanSignOnMobile', 'signing_location' => 'setSigningLocation', 'status' => 'setStatus', 'status_changed_date_time' => 'setStatusChangedDateTime', @@ -267,14 +279,17 @@ public static function swaggerTypes() protected static $getters = [ 'allow_markup' => 'getAllowMarkup', 'allow_reassign' => 'getAllowReassign', + 'allow_view_history' => 'getAllowViewHistory', 'asynchronous' => 'getAsynchronous', 'attachments_uri' => 'getAttachmentsUri', 'authoritative_copy' => 'getAuthoritativeCopy', + 'authoritative_copy_default' => 'getAuthoritativeCopyDefault', 'auto_navigation' => 'getAutoNavigation', 'brand_id' => 'getBrandId', 'brand_lock' => 'getBrandLock', 'certificate_uri' => 'getCertificateUri', 'completed_date_time' => 'getCompletedDateTime', + 'created' => 'getCreated', 'created_date_time' => 'getCreatedDateTime', 'custom_fields' => 'getCustomFields', 'custom_fields_uri' => 'getCustomFieldsUri', @@ -316,6 +331,7 @@ public static function swaggerTypes() 'recipients_uri' => 'getRecipientsUri', 'sent_date_time' => 'getSentDateTime', 'shared' => 'getShared', + 'signer_can_sign_on_mobile' => 'getSignerCanSignOnMobile', 'signing_location' => 'getSigningLocation', 'status' => 'getStatus', 'status_changed_date_time' => 'getStatusChangedDateTime', @@ -361,14 +377,17 @@ public function __construct(array $data = null) { $this->container['allow_markup'] = isset($data['allow_markup']) ? $data['allow_markup'] : null; $this->container['allow_reassign'] = isset($data['allow_reassign']) ? $data['allow_reassign'] : null; + $this->container['allow_view_history'] = isset($data['allow_view_history']) ? $data['allow_view_history'] : null; $this->container['asynchronous'] = isset($data['asynchronous']) ? $data['asynchronous'] : null; $this->container['attachments_uri'] = isset($data['attachments_uri']) ? $data['attachments_uri'] : null; $this->container['authoritative_copy'] = isset($data['authoritative_copy']) ? $data['authoritative_copy'] : null; + $this->container['authoritative_copy_default'] = isset($data['authoritative_copy_default']) ? $data['authoritative_copy_default'] : null; $this->container['auto_navigation'] = isset($data['auto_navigation']) ? $data['auto_navigation'] : null; $this->container['brand_id'] = isset($data['brand_id']) ? $data['brand_id'] : null; $this->container['brand_lock'] = isset($data['brand_lock']) ? $data['brand_lock'] : null; $this->container['certificate_uri'] = isset($data['certificate_uri']) ? $data['certificate_uri'] : null; $this->container['completed_date_time'] = isset($data['completed_date_time']) ? $data['completed_date_time'] : null; + $this->container['created'] = isset($data['created']) ? $data['created'] : null; $this->container['created_date_time'] = isset($data['created_date_time']) ? $data['created_date_time'] : null; $this->container['custom_fields'] = isset($data['custom_fields']) ? $data['custom_fields'] : null; $this->container['custom_fields_uri'] = isset($data['custom_fields_uri']) ? $data['custom_fields_uri'] : null; @@ -410,6 +429,7 @@ public function __construct(array $data = null) $this->container['recipients_uri'] = isset($data['recipients_uri']) ? $data['recipients_uri'] : null; $this->container['sent_date_time'] = isset($data['sent_date_time']) ? $data['sent_date_time'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; + $this->container['signer_can_sign_on_mobile'] = isset($data['signer_can_sign_on_mobile']) ? $data['signer_can_sign_on_mobile'] : null; $this->container['signing_location'] = isset($data['signing_location']) ? $data['signing_location'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['status_changed_date_time'] = isset($data['status_changed_date_time']) ? $data['status_changed_date_time'] : null; @@ -487,6 +507,27 @@ public function setAllowReassign($allow_reassign) return $this; } + /** + * Gets allow_view_history + * @return string + */ + public function getAllowViewHistory() + { + return $this->container['allow_view_history']; + } + + /** + * Sets allow_view_history + * @param string $allow_view_history + * @return $this + */ + public function setAllowViewHistory($allow_view_history) + { + $this->container['allow_view_history'] = $allow_view_history; + + return $this; + } + /** * Gets asynchronous * @return string @@ -550,6 +591,27 @@ public function setAuthoritativeCopy($authoritative_copy) return $this; } + /** + * Gets authoritative_copy_default + * @return string + */ + public function getAuthoritativeCopyDefault() + { + return $this->container['authoritative_copy_default']; + } + + /** + * Sets authoritative_copy_default + * @param string $authoritative_copy_default + * @return $this + */ + public function setAuthoritativeCopyDefault($authoritative_copy_default) + { + $this->container['authoritative_copy_default'] = $authoritative_copy_default; + + return $this; + } + /** * Gets auto_navigation * @return string @@ -655,6 +717,27 @@ public function setCompletedDateTime($completed_date_time) return $this; } + /** + * Gets created + * @return string + */ + public function getCreated() + { + return $this->container['created']; + } + + /** + * Sets created + * @param string $created + * @return $this + */ + public function setCreated($created) + { + $this->container['created'] = $created; + + return $this; + } + /** * Gets created_date_time * @return string @@ -1516,6 +1599,27 @@ public function setShared($shared) return $this; } + /** + * Gets signer_can_sign_on_mobile + * @return string + */ + public function getSignerCanSignOnMobile() + { + return $this->container['signer_can_sign_on_mobile']; + } + + /** + * Sets signer_can_sign_on_mobile + * @param string $signer_can_sign_on_mobile + * @return $this + */ + public function setSignerCanSignOnMobile($signer_can_sign_on_mobile) + { + $this->container['signer_can_sign_on_mobile'] = $signer_can_sign_on_mobile; + + return $this; + } + /** * Gets signing_location * @return string @@ -1674,7 +1778,7 @@ public function getUseDisclosure() /** * Sets use_disclosure - * @param string $use_disclosure When set to **true**, the disclosure is shown to recipients in accordance with the account’s Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. + * @param string $use_disclosure When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. * @return $this */ public function setUseDisclosure($use_disclosure) diff --git a/src/Model/EnvelopesInformation.php b/src/Model/EnvelopesInformation.php index 6244ed17..eb172fd5 100644 --- a/src/Model/EnvelopesInformation.php +++ b/src/Model/EnvelopesInformation.php @@ -54,9 +54,11 @@ class EnvelopesInformation implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ + 'continuation_token' => 'string', 'end_position' => 'string', 'envelopes' => '\DocuSign\eSign\Model\Envelope[]', 'envelope_transaction_statuses' => '\DocuSign\eSign\Model\EnvelopeTransactionStatus[]', + 'last_queried_date_time' => 'string', 'next_uri' => 'string', 'previous_uri' => 'string', 'result_set_size' => 'string', @@ -74,9 +76,11 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ + 'continuation_token' => 'continuationToken', 'end_position' => 'endPosition', 'envelopes' => 'envelopes', 'envelope_transaction_statuses' => 'envelopeTransactionStatuses', + 'last_queried_date_time' => 'lastQueriedDateTime', 'next_uri' => 'nextUri', 'previous_uri' => 'previousUri', 'result_set_size' => 'resultSetSize', @@ -90,9 +94,11 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ + 'continuation_token' => 'setContinuationToken', 'end_position' => 'setEndPosition', 'envelopes' => 'setEnvelopes', 'envelope_transaction_statuses' => 'setEnvelopeTransactionStatuses', + 'last_queried_date_time' => 'setLastQueriedDateTime', 'next_uri' => 'setNextUri', 'previous_uri' => 'setPreviousUri', 'result_set_size' => 'setResultSetSize', @@ -106,9 +112,11 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ + 'continuation_token' => 'getContinuationToken', 'end_position' => 'getEndPosition', 'envelopes' => 'getEnvelopes', 'envelope_transaction_statuses' => 'getEnvelopeTransactionStatuses', + 'last_queried_date_time' => 'getLastQueriedDateTime', 'next_uri' => 'getNextUri', 'previous_uri' => 'getPreviousUri', 'result_set_size' => 'getResultSetSize', @@ -147,9 +155,11 @@ public static function getters() */ public function __construct(array $data = null) { + $this->container['continuation_token'] = isset($data['continuation_token']) ? $data['continuation_token'] : null; $this->container['end_position'] = isset($data['end_position']) ? $data['end_position'] : null; $this->container['envelopes'] = isset($data['envelopes']) ? $data['envelopes'] : null; $this->container['envelope_transaction_statuses'] = isset($data['envelope_transaction_statuses']) ? $data['envelope_transaction_statuses'] : null; + $this->container['last_queried_date_time'] = isset($data['last_queried_date_time']) ? $data['last_queried_date_time'] : null; $this->container['next_uri'] = isset($data['next_uri']) ? $data['next_uri'] : null; $this->container['previous_uri'] = isset($data['previous_uri']) ? $data['previous_uri'] : null; $this->container['result_set_size'] = isset($data['result_set_size']) ? $data['result_set_size'] : null; @@ -180,6 +190,27 @@ public function valid() } + /** + * Gets continuation_token + * @return string + */ + public function getContinuationToken() + { + return $this->container['continuation_token']; + } + + /** + * Sets continuation_token + * @param string $continuation_token + * @return $this + */ + public function setContinuationToken($continuation_token) + { + $this->container['continuation_token'] = $continuation_token; + + return $this; + } + /** * Gets end_position * @return string @@ -243,6 +274,27 @@ public function setEnvelopeTransactionStatuses($envelope_transaction_statuses) return $this; } + /** + * Gets last_queried_date_time + * @return string + */ + public function getLastQueriedDateTime() + { + return $this->container['last_queried_date_time']; + } + + /** + * Sets last_queried_date_time + * @param string $last_queried_date_time + * @return $this + */ + public function setLastQueriedDateTime($last_queried_date_time) + { + $this->container['last_queried_date_time'] = $last_queried_date_time; + + return $this; + } + /** * Gets next_uri * @return string diff --git a/src/Model/FirstName.php b/src/Model/FirstName.php index 4bfc49a2..db2ae4b2 100644 --- a/src/Model/FirstName.php +++ b/src/Model/FirstName.php @@ -77,12 +77,15 @@ class FirstName implements ArrayAccess 'page_number' => 'string', 'recipient_id' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', + 'value' => 'string', 'x_position' => 'string', 'y_position' => 'string' ]; @@ -120,12 +123,15 @@ public static function swaggerTypes() 'page_number' => 'pageNumber', 'recipient_id' => 'recipientId', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', + 'value' => 'value', 'x_position' => 'xPosition', 'y_position' => 'yPosition' ]; @@ -159,12 +165,15 @@ public static function swaggerTypes() 'page_number' => 'setPageNumber', 'recipient_id' => 'setRecipientId', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', + 'value' => 'setValue', 'x_position' => 'setXPosition', 'y_position' => 'setYPosition' ]; @@ -198,12 +207,15 @@ public static function swaggerTypes() 'page_number' => 'getPageNumber', 'recipient_id' => 'getRecipientId', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', + 'value' => 'getValue', 'x_position' => 'getXPosition', 'y_position' => 'getYPosition' ]; @@ -262,12 +274,15 @@ public function __construct(array $data = null) $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; + $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; } @@ -432,7 +447,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -453,7 +468,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -778,6 +793,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -883,6 +919,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -904,6 +961,27 @@ public function setUnderline($underline) return $this; } + /** + * Gets value + * @return string + */ + public function getValue() + { + return $this->container['value']; + } + + /** + * Sets value + * @param string $value Specifies the value of the tab. + * @return $this + */ + public function setValue($value) + { + $this->container['value'] = $value; + + return $this; + } + /** * Gets x_position * @return string diff --git a/src/Model/FormulaTab.php b/src/Model/FormulaTab.php index 418317e2..739e36e0 100644 --- a/src/Model/FormulaTab.php +++ b/src/Model/FormulaTab.php @@ -74,6 +74,7 @@ class FormulaTab implements ArrayAccess 'font_color' => 'string', 'font_size' => 'string', 'formula' => 'string', + 'hidden' => 'string', 'is_payment_amount' => 'string', 'italic' => 'string', 'locked' => 'string', @@ -91,11 +92,13 @@ class FormulaTab implements ArrayAccess 'sender_required' => 'string', 'shared' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'validation_message' => 'string', 'validation_pattern' => 'string', @@ -135,6 +138,7 @@ public static function swaggerTypes() 'font_color' => 'fontColor', 'font_size' => 'fontSize', 'formula' => 'formula', + 'hidden' => 'hidden', 'is_payment_amount' => 'isPaymentAmount', 'italic' => 'italic', 'locked' => 'locked', @@ -152,11 +156,13 @@ public static function swaggerTypes() 'sender_required' => 'senderRequired', 'shared' => 'shared', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'validation_message' => 'validationMessage', 'validation_pattern' => 'validationPattern', @@ -192,6 +198,7 @@ public static function swaggerTypes() 'font_color' => 'setFontColor', 'font_size' => 'setFontSize', 'formula' => 'setFormula', + 'hidden' => 'setHidden', 'is_payment_amount' => 'setIsPaymentAmount', 'italic' => 'setItalic', 'locked' => 'setLocked', @@ -209,11 +216,13 @@ public static function swaggerTypes() 'sender_required' => 'setSenderRequired', 'shared' => 'setShared', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'validation_message' => 'setValidationMessage', 'validation_pattern' => 'setValidationPattern', @@ -249,6 +258,7 @@ public static function swaggerTypes() 'font_color' => 'getFontColor', 'font_size' => 'getFontSize', 'formula' => 'getFormula', + 'hidden' => 'getHidden', 'is_payment_amount' => 'getIsPaymentAmount', 'italic' => 'getItalic', 'locked' => 'getLocked', @@ -266,11 +276,13 @@ public static function swaggerTypes() 'sender_required' => 'getSenderRequired', 'shared' => 'getShared', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'validation_message' => 'getValidationMessage', 'validation_pattern' => 'getValidationPattern', @@ -331,6 +343,7 @@ public function __construct(array $data = null) $this->container['font_color'] = isset($data['font_color']) ? $data['font_color'] : null; $this->container['font_size'] = isset($data['font_size']) ? $data['font_size'] : null; $this->container['formula'] = isset($data['formula']) ? $data['formula'] : null; + $this->container['hidden'] = isset($data['hidden']) ? $data['hidden'] : null; $this->container['is_payment_amount'] = isset($data['is_payment_amount']) ? $data['is_payment_amount'] : null; $this->container['italic'] = isset($data['italic']) ? $data['italic'] : null; $this->container['locked'] = isset($data['locked']) ? $data['locked'] : null; @@ -348,11 +361,13 @@ public function __construct(array $data = null) $this->container['sender_required'] = isset($data['sender_required']) ? $data['sender_required'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['validation_message'] = isset($data['validation_message']) ? $data['validation_message'] : null; $this->container['validation_pattern'] = isset($data['validation_pattern']) ? $data['validation_pattern'] : null; @@ -522,7 +537,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -543,7 +558,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -805,6 +820,27 @@ public function setFormula($formula) return $this; } + /** + * Gets hidden + * @return string + */ + public function getHidden() + { + return $this->container['hidden']; + } + + /** + * Sets hidden + * @param string $hidden + * @return $this + */ + public function setHidden($hidden) + { + $this->container['hidden'] = $hidden; + + return $this; + } + /** * Gets is_payment_amount * @return string @@ -1162,6 +1198,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -1267,6 +1324,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -1320,7 +1398,7 @@ public function getValidationPattern() /** * Sets validation_pattern - * @param string $validation_pattern A regular expressionn used to validate input for the tab. + * @param string $validation_pattern A regular expression used to validate input for the tab. * @return $this */ public function setValidationPattern($validation_pattern) diff --git a/src/Model/FullName.php b/src/Model/FullName.php index fd692a35..94d80e1d 100644 --- a/src/Model/FullName.php +++ b/src/Model/FullName.php @@ -77,12 +77,15 @@ class FullName implements ArrayAccess 'page_number' => 'string', 'recipient_id' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', + 'value' => 'string', 'x_position' => 'string', 'y_position' => 'string' ]; @@ -120,12 +123,15 @@ public static function swaggerTypes() 'page_number' => 'pageNumber', 'recipient_id' => 'recipientId', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', + 'value' => 'value', 'x_position' => 'xPosition', 'y_position' => 'yPosition' ]; @@ -159,12 +165,15 @@ public static function swaggerTypes() 'page_number' => 'setPageNumber', 'recipient_id' => 'setRecipientId', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', + 'value' => 'setValue', 'x_position' => 'setXPosition', 'y_position' => 'setYPosition' ]; @@ -198,12 +207,15 @@ public static function swaggerTypes() 'page_number' => 'getPageNumber', 'recipient_id' => 'getRecipientId', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', + 'value' => 'getValue', 'x_position' => 'getXPosition', 'y_position' => 'getYPosition' ]; @@ -262,12 +274,15 @@ public function __construct(array $data = null) $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; + $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; } @@ -432,7 +447,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -453,7 +468,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -778,6 +793,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -883,6 +919,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -904,6 +961,27 @@ public function setUnderline($underline) return $this; } + /** + * Gets value + * @return string + */ + public function getValue() + { + return $this->container['value']; + } + + /** + * Sets value + * @param string $value Specifies the value of the tab. + * @return $this + */ + public function setValue($value) + { + $this->container['value'] = $value; + + return $this; + } + /** * Gets x_position * @return string diff --git a/src/Model/IdCheckInformationInput.php b/src/Model/IdCheckInformationInput.php index 30a29936..bd3a4c61 100644 --- a/src/Model/IdCheckInformationInput.php +++ b/src/Model/IdCheckInformationInput.php @@ -35,7 +35,7 @@ * IdCheckInformationInput Class Doc Comment * * @category Class - * @description A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient’s date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient’s SSN information and consists of: * ssn4: Specifies the last four digits of the recipient’s SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient’s SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient’s SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. + * @description A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * @package DocuSign\eSign * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen diff --git a/src/Model/InPersonSigner.php b/src/Model/InPersonSigner.php index 43136e8a..1b98cfe7 100644 --- a/src/Model/InPersonSigner.php +++ b/src/Model/InPersonSigner.php @@ -59,6 +59,7 @@ class InPersonSigner implements ArrayAccess 'auto_navigation' => 'string', 'can_sign_offline' => 'string', 'client_user_id' => 'string', + 'creation_reason' => 'string', 'custom_fields' => 'string[]', 'declined_date_time' => 'string', 'declined_reason' => 'string', @@ -66,9 +67,11 @@ class InPersonSigner implements ArrayAccess 'delivered_date_time' => 'string', 'delivery_method' => 'string', 'document_visibility' => '\DocuSign\eSign\Model\DocumentVisibility[]', + 'email' => 'string', 'email_notification' => '\DocuSign\eSign\Model\RecipientEmailNotification', 'embedded_recipient_start_url' => 'string', 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', + 'excluded_documents' => 'string[]', 'fax_number' => 'string', 'host_email' => 'string', 'host_name' => 'string', @@ -76,6 +79,7 @@ class InPersonSigner implements ArrayAccess 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', 'inherit_email_notification_configuration' => 'string', 'in_person_signing_type' => 'string', + 'name' => 'string', 'notary_host' => '\DocuSign\eSign\Model\NotaryHost', 'note' => 'string', 'offline_attributes' => '\DocuSign\eSign\Model\OfflineAttributes', @@ -126,6 +130,7 @@ public static function swaggerTypes() 'auto_navigation' => 'autoNavigation', 'can_sign_offline' => 'canSignOffline', 'client_user_id' => 'clientUserId', + 'creation_reason' => 'creationReason', 'custom_fields' => 'customFields', 'declined_date_time' => 'declinedDateTime', 'declined_reason' => 'declinedReason', @@ -133,9 +138,11 @@ public static function swaggerTypes() 'delivered_date_time' => 'deliveredDateTime', 'delivery_method' => 'deliveryMethod', 'document_visibility' => 'documentVisibility', + 'email' => 'email', 'email_notification' => 'emailNotification', 'embedded_recipient_start_url' => 'embeddedRecipientStartURL', 'error_details' => 'errorDetails', + 'excluded_documents' => 'excludedDocuments', 'fax_number' => 'faxNumber', 'host_email' => 'hostEmail', 'host_name' => 'hostName', @@ -143,6 +150,7 @@ public static function swaggerTypes() 'id_check_information_input' => 'idCheckInformationInput', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'in_person_signing_type' => 'inPersonSigningType', + 'name' => 'name', 'notary_host' => 'notaryHost', 'note' => 'note', 'offline_attributes' => 'offlineAttributes', @@ -189,6 +197,7 @@ public static function swaggerTypes() 'auto_navigation' => 'setAutoNavigation', 'can_sign_offline' => 'setCanSignOffline', 'client_user_id' => 'setClientUserId', + 'creation_reason' => 'setCreationReason', 'custom_fields' => 'setCustomFields', 'declined_date_time' => 'setDeclinedDateTime', 'declined_reason' => 'setDeclinedReason', @@ -196,9 +205,11 @@ public static function swaggerTypes() 'delivered_date_time' => 'setDeliveredDateTime', 'delivery_method' => 'setDeliveryMethod', 'document_visibility' => 'setDocumentVisibility', + 'email' => 'setEmail', 'email_notification' => 'setEmailNotification', 'embedded_recipient_start_url' => 'setEmbeddedRecipientStartUrl', 'error_details' => 'setErrorDetails', + 'excluded_documents' => 'setExcludedDocuments', 'fax_number' => 'setFaxNumber', 'host_email' => 'setHostEmail', 'host_name' => 'setHostName', @@ -206,6 +217,7 @@ public static function swaggerTypes() 'id_check_information_input' => 'setIdCheckInformationInput', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'in_person_signing_type' => 'setInPersonSigningType', + 'name' => 'setName', 'notary_host' => 'setNotaryHost', 'note' => 'setNote', 'offline_attributes' => 'setOfflineAttributes', @@ -252,6 +264,7 @@ public static function swaggerTypes() 'auto_navigation' => 'getAutoNavigation', 'can_sign_offline' => 'getCanSignOffline', 'client_user_id' => 'getClientUserId', + 'creation_reason' => 'getCreationReason', 'custom_fields' => 'getCustomFields', 'declined_date_time' => 'getDeclinedDateTime', 'declined_reason' => 'getDeclinedReason', @@ -259,9 +272,11 @@ public static function swaggerTypes() 'delivered_date_time' => 'getDeliveredDateTime', 'delivery_method' => 'getDeliveryMethod', 'document_visibility' => 'getDocumentVisibility', + 'email' => 'getEmail', 'email_notification' => 'getEmailNotification', 'embedded_recipient_start_url' => 'getEmbeddedRecipientStartUrl', 'error_details' => 'getErrorDetails', + 'excluded_documents' => 'getExcludedDocuments', 'fax_number' => 'getFaxNumber', 'host_email' => 'getHostEmail', 'host_name' => 'getHostName', @@ -269,6 +284,7 @@ public static function swaggerTypes() 'id_check_information_input' => 'getIdCheckInformationInput', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'in_person_signing_type' => 'getInPersonSigningType', + 'name' => 'getName', 'notary_host' => 'getNotaryHost', 'note' => 'getNote', 'offline_attributes' => 'getOfflineAttributes', @@ -340,6 +356,7 @@ public function __construct(array $data = null) $this->container['auto_navigation'] = isset($data['auto_navigation']) ? $data['auto_navigation'] : null; $this->container['can_sign_offline'] = isset($data['can_sign_offline']) ? $data['can_sign_offline'] : null; $this->container['client_user_id'] = isset($data['client_user_id']) ? $data['client_user_id'] : null; + $this->container['creation_reason'] = isset($data['creation_reason']) ? $data['creation_reason'] : null; $this->container['custom_fields'] = isset($data['custom_fields']) ? $data['custom_fields'] : null; $this->container['declined_date_time'] = isset($data['declined_date_time']) ? $data['declined_date_time'] : null; $this->container['declined_reason'] = isset($data['declined_reason']) ? $data['declined_reason'] : null; @@ -347,9 +364,11 @@ public function __construct(array $data = null) $this->container['delivered_date_time'] = isset($data['delivered_date_time']) ? $data['delivered_date_time'] : null; $this->container['delivery_method'] = isset($data['delivery_method']) ? $data['delivery_method'] : null; $this->container['document_visibility'] = isset($data['document_visibility']) ? $data['document_visibility'] : null; + $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['email_notification'] = isset($data['email_notification']) ? $data['email_notification'] : null; $this->container['embedded_recipient_start_url'] = isset($data['embedded_recipient_start_url']) ? $data['embedded_recipient_start_url'] : null; $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; + $this->container['excluded_documents'] = isset($data['excluded_documents']) ? $data['excluded_documents'] : null; $this->container['fax_number'] = isset($data['fax_number']) ? $data['fax_number'] : null; $this->container['host_email'] = isset($data['host_email']) ? $data['host_email'] : null; $this->container['host_name'] = isset($data['host_name']) ? $data['host_name'] : null; @@ -357,6 +376,7 @@ public function __construct(array $data = null) $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; $this->container['in_person_signing_type'] = isset($data['in_person_signing_type']) ? $data['in_person_signing_type'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['notary_host'] = isset($data['notary_host']) ? $data['notary_host'] : null; $this->container['note'] = isset($data['note']) ? $data['note'] : null; $this->container['offline_attributes'] = isset($data['offline_attributes']) ? $data['offline_attributes'] : null; @@ -426,7 +446,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) @@ -520,6 +540,27 @@ public function setClientUserId($client_user_id) return $this; } + /** + * Gets creation_reason + * @return string + */ + public function getCreationReason() + { + return $this->container['creation_reason']; + } + + /** + * Sets creation_reason + * @param string $creation_reason + * @return $this + */ + public function setCreationReason($creation_reason) + { + $this->container['creation_reason'] = $creation_reason; + + return $this; + } + /** * Gets custom_fields * @return string[] @@ -667,6 +708,27 @@ public function setDocumentVisibility($document_visibility) return $this; } + /** + * Gets email + * @return string + */ + public function getEmail() + { + return $this->container['email']; + } + + /** + * Sets email + * @param string $email + * @return $this + */ + public function setEmail($email) + { + $this->container['email'] = $email; + + return $this; + } + /** * Gets email_notification * @return \DocuSign\eSign\Model\RecipientEmailNotification @@ -699,7 +761,7 @@ public function getEmbeddedRecipientStartUrl() /** * Sets embedded_recipient_start_url - * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -730,6 +792,27 @@ public function setErrorDetails($error_details) return $this; } + /** + * Gets excluded_documents + * @return string[] + */ + public function getExcludedDocuments() + { + return $this->container['excluded_documents']; + } + + /** + * Sets excluded_documents + * @param string[] $excluded_documents Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. + * @return $this + */ + public function setExcludedDocuments($excluded_documents) + { + $this->container['excluded_documents'] = $excluded_documents; + + return $this; + } + /** * Gets fax_number * @return string @@ -877,6 +960,27 @@ public function setInPersonSigningType($in_person_signing_type) return $this; } + /** + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + /** * Gets notary_host * @return \DocuSign\eSign\Model\NotaryHost diff --git a/src/Model/InitialHere.php b/src/Model/InitialHere.php index 2a05bbab..d837536f 100644 --- a/src/Model/InitialHere.php +++ b/src/Model/InitialHere.php @@ -72,13 +72,15 @@ class InitialHere implements ArrayAccess 'optional' => 'string', 'page_number' => 'string', 'recipient_id' => 'string', - 'scale_value' => 'Number', + 'scale_value' => 'float', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'x_position' => 'string', 'y_position' => 'string' ]; @@ -113,11 +115,13 @@ public static function swaggerTypes() 'recipient_id' => 'recipientId', 'scale_value' => 'scaleValue', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'x_position' => 'xPosition', 'y_position' => 'yPosition' ]; @@ -148,11 +152,13 @@ public static function swaggerTypes() 'recipient_id' => 'setRecipientId', 'scale_value' => 'setScaleValue', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'x_position' => 'setXPosition', 'y_position' => 'setYPosition' ]; @@ -183,11 +189,13 @@ public static function swaggerTypes() 'recipient_id' => 'getRecipientId', 'scale_value' => 'getScaleValue', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'x_position' => 'getXPosition', 'y_position' => 'getYPosition' ]; @@ -243,11 +251,13 @@ public function __construct(array $data = null) $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['scale_value'] = isset($data['scale_value']) ? $data['scale_value'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; } @@ -412,7 +422,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -433,7 +443,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -655,7 +665,7 @@ public function setRecipientId($recipient_id) /** * Gets scale_value - * @return Number + * @return float */ public function getScaleValue() { @@ -664,7 +674,7 @@ public function getScaleValue() /** * Sets scale_value - * @param Number $scale_value Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. + * @param float $scale_value Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. * @return $this */ public function setScaleValue($scale_value) @@ -695,6 +705,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -800,6 +831,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets x_position * @return string diff --git a/src/Model/Intermediary.php b/src/Model/Intermediary.php index e744f482..d67334be 100644 --- a/src/Model/Intermediary.php +++ b/src/Model/Intermediary.php @@ -70,9 +70,12 @@ class Intermediary implements ArrayAccess 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', 'excluded_documents' => 'string[]', 'fax_number' => 'string', + 'first_name' => 'string', + 'full_name' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', 'inherit_email_notification_configuration' => 'string', + 'last_name' => 'string', 'name' => 'string', 'note' => 'string', 'phone_authentication' => '\DocuSign\eSign\Model\RecipientPhoneAuthentication', @@ -124,9 +127,12 @@ public static function swaggerTypes() 'error_details' => 'errorDetails', 'excluded_documents' => 'excludedDocuments', 'fax_number' => 'faxNumber', + 'first_name' => 'firstName', + 'full_name' => 'fullName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', + 'last_name' => 'lastName', 'name' => 'name', 'note' => 'note', 'phone_authentication' => 'phoneAuthentication', @@ -174,9 +180,12 @@ public static function swaggerTypes() 'error_details' => 'setErrorDetails', 'excluded_documents' => 'setExcludedDocuments', 'fax_number' => 'setFaxNumber', + 'first_name' => 'setFirstName', + 'full_name' => 'setFullName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', + 'last_name' => 'setLastName', 'name' => 'setName', 'note' => 'setNote', 'phone_authentication' => 'setPhoneAuthentication', @@ -224,9 +233,12 @@ public static function swaggerTypes() 'error_details' => 'getErrorDetails', 'excluded_documents' => 'getExcludedDocuments', 'fax_number' => 'getFaxNumber', + 'first_name' => 'getFirstName', + 'full_name' => 'getFullName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', + 'last_name' => 'getLastName', 'name' => 'getName', 'note' => 'getNote', 'phone_authentication' => 'getPhoneAuthentication', @@ -299,9 +311,12 @@ public function __construct(array $data = null) $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; $this->container['excluded_documents'] = isset($data['excluded_documents']) ? $data['excluded_documents'] : null; $this->container['fax_number'] = isset($data['fax_number']) ? $data['fax_number'] : null; + $this->container['first_name'] = isset($data['first_name']) ? $data['first_name'] : null; + $this->container['full_name'] = isset($data['full_name']) ? $data['full_name'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; + $this->container['last_name'] = isset($data['last_name']) ? $data['last_name'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['note'] = isset($data['note']) ? $data['note'] : null; $this->container['phone_authentication'] = isset($data['phone_authentication']) ? $data['phone_authentication'] : null; @@ -361,7 +376,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) @@ -613,7 +628,7 @@ public function getEmbeddedRecipientStartUrl() /** * Sets embedded_recipient_start_url - * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -686,6 +701,48 @@ public function setFaxNumber($fax_number) return $this; } + /** + * Gets first_name + * @return string + */ + public function getFirstName() + { + return $this->container['first_name']; + } + + /** + * Sets first_name + * @param string $first_name The user's first name. Maximum Length: 50 characters. + * @return $this + */ + public function setFirstName($first_name) + { + $this->container['first_name'] = $first_name; + + return $this; + } + + /** + * Gets full_name + * @return string + */ + public function getFullName() + { + return $this->container['full_name']; + } + + /** + * Sets full_name + * @param string $full_name + * @return $this + */ + public function setFullName($full_name) + { + $this->container['full_name'] = $full_name; + + return $this; + } + /** * Gets id_check_configuration_name * @return string @@ -749,6 +806,27 @@ public function setInheritEmailNotificationConfiguration($inherit_email_notifica return $this; } + /** + * Gets last_name + * @return string + */ + public function getLastName() + { + return $this->container['last_name']; + } + + /** + * Sets last_name + * @param string $last_name + * @return $this + */ + public function setLastName($last_name) + { + $this->container['last_name'] = $last_name; + + return $this; + } + /** * Gets name * @return string diff --git a/src/Model/Jurisdiction.php b/src/Model/Jurisdiction.php new file mode 100644 index 00000000..7844b2ac --- /dev/null +++ b/src/Model/Jurisdiction.php @@ -0,0 +1,461 @@ + 'string', + 'allow_user_uploaded_seal' => 'string', + 'commission_id_in_seal' => 'string', + 'county' => 'string', + 'county_in_seal' => 'string', + 'enabled' => 'string', + 'jurisdiction_id' => 'string', + 'name' => 'string', + 'notary_public_in_seal' => 'string', + 'state_name_in_seal' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'allow_system_created_seal' => 'allowSystemCreatedSeal', + 'allow_user_uploaded_seal' => 'allowUserUploadedSeal', + 'commission_id_in_seal' => 'commissionIdInSeal', + 'county' => 'county', + 'county_in_seal' => 'countyInSeal', + 'enabled' => 'enabled', + 'jurisdiction_id' => 'jurisdictionId', + 'name' => 'name', + 'notary_public_in_seal' => 'notaryPublicInSeal', + 'state_name_in_seal' => 'stateNameInSeal' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'allow_system_created_seal' => 'setAllowSystemCreatedSeal', + 'allow_user_uploaded_seal' => 'setAllowUserUploadedSeal', + 'commission_id_in_seal' => 'setCommissionIdInSeal', + 'county' => 'setCounty', + 'county_in_seal' => 'setCountyInSeal', + 'enabled' => 'setEnabled', + 'jurisdiction_id' => 'setJurisdictionId', + 'name' => 'setName', + 'notary_public_in_seal' => 'setNotaryPublicInSeal', + 'state_name_in_seal' => 'setStateNameInSeal' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'allow_system_created_seal' => 'getAllowSystemCreatedSeal', + 'allow_user_uploaded_seal' => 'getAllowUserUploadedSeal', + 'commission_id_in_seal' => 'getCommissionIdInSeal', + 'county' => 'getCounty', + 'county_in_seal' => 'getCountyInSeal', + 'enabled' => 'getEnabled', + 'jurisdiction_id' => 'getJurisdictionId', + 'name' => 'getName', + 'notary_public_in_seal' => 'getNotaryPublicInSeal', + 'state_name_in_seal' => 'getStateNameInSeal' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['allow_system_created_seal'] = isset($data['allow_system_created_seal']) ? $data['allow_system_created_seal'] : null; + $this->container['allow_user_uploaded_seal'] = isset($data['allow_user_uploaded_seal']) ? $data['allow_user_uploaded_seal'] : null; + $this->container['commission_id_in_seal'] = isset($data['commission_id_in_seal']) ? $data['commission_id_in_seal'] : null; + $this->container['county'] = isset($data['county']) ? $data['county'] : null; + $this->container['county_in_seal'] = isset($data['county_in_seal']) ? $data['county_in_seal'] : null; + $this->container['enabled'] = isset($data['enabled']) ? $data['enabled'] : null; + $this->container['jurisdiction_id'] = isset($data['jurisdiction_id']) ? $data['jurisdiction_id'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['notary_public_in_seal'] = isset($data['notary_public_in_seal']) ? $data['notary_public_in_seal'] : null; + $this->container['state_name_in_seal'] = isset($data['state_name_in_seal']) ? $data['state_name_in_seal'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets allow_system_created_seal + * @return string + */ + public function getAllowSystemCreatedSeal() + { + return $this->container['allow_system_created_seal']; + } + + /** + * Sets allow_system_created_seal + * @param string $allow_system_created_seal + * @return $this + */ + public function setAllowSystemCreatedSeal($allow_system_created_seal) + { + $this->container['allow_system_created_seal'] = $allow_system_created_seal; + + return $this; + } + + /** + * Gets allow_user_uploaded_seal + * @return string + */ + public function getAllowUserUploadedSeal() + { + return $this->container['allow_user_uploaded_seal']; + } + + /** + * Sets allow_user_uploaded_seal + * @param string $allow_user_uploaded_seal + * @return $this + */ + public function setAllowUserUploadedSeal($allow_user_uploaded_seal) + { + $this->container['allow_user_uploaded_seal'] = $allow_user_uploaded_seal; + + return $this; + } + + /** + * Gets commission_id_in_seal + * @return string + */ + public function getCommissionIdInSeal() + { + return $this->container['commission_id_in_seal']; + } + + /** + * Sets commission_id_in_seal + * @param string $commission_id_in_seal + * @return $this + */ + public function setCommissionIdInSeal($commission_id_in_seal) + { + $this->container['commission_id_in_seal'] = $commission_id_in_seal; + + return $this; + } + + /** + * Gets county + * @return string + */ + public function getCounty() + { + return $this->container['county']; + } + + /** + * Sets county + * @param string $county + * @return $this + */ + public function setCounty($county) + { + $this->container['county'] = $county; + + return $this; + } + + /** + * Gets county_in_seal + * @return string + */ + public function getCountyInSeal() + { + return $this->container['county_in_seal']; + } + + /** + * Sets county_in_seal + * @param string $county_in_seal + * @return $this + */ + public function setCountyInSeal($county_in_seal) + { + $this->container['county_in_seal'] = $county_in_seal; + + return $this; + } + + /** + * Gets enabled + * @return string + */ + public function getEnabled() + { + return $this->container['enabled']; + } + + /** + * Sets enabled + * @param string $enabled + * @return $this + */ + public function setEnabled($enabled) + { + $this->container['enabled'] = $enabled; + + return $this; + } + + /** + * Gets jurisdiction_id + * @return string + */ + public function getJurisdictionId() + { + return $this->container['jurisdiction_id']; + } + + /** + * Sets jurisdiction_id + * @param string $jurisdiction_id + * @return $this + */ + public function setJurisdictionId($jurisdiction_id) + { + $this->container['jurisdiction_id'] = $jurisdiction_id; + + return $this; + } + + /** + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + + /** + * Gets notary_public_in_seal + * @return string + */ + public function getNotaryPublicInSeal() + { + return $this->container['notary_public_in_seal']; + } + + /** + * Sets notary_public_in_seal + * @param string $notary_public_in_seal + * @return $this + */ + public function setNotaryPublicInSeal($notary_public_in_seal) + { + $this->container['notary_public_in_seal'] = $notary_public_in_seal; + + return $this; + } + + /** + * Gets state_name_in_seal + * @return string + */ + public function getStateNameInSeal() + { + return $this->container['state_name_in_seal']; + } + + /** + * Sets state_name_in_seal + * @param string $state_name_in_seal + * @return $this + */ + public function setStateNameInSeal($state_name_in_seal) + { + $this->container['state_name_in_seal'] = $state_name_in_seal; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/LastName.php b/src/Model/LastName.php index c80593ba..b14552ff 100644 --- a/src/Model/LastName.php +++ b/src/Model/LastName.php @@ -77,12 +77,15 @@ class LastName implements ArrayAccess 'page_number' => 'string', 'recipient_id' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', + 'value' => 'string', 'x_position' => 'string', 'y_position' => 'string' ]; @@ -120,12 +123,15 @@ public static function swaggerTypes() 'page_number' => 'pageNumber', 'recipient_id' => 'recipientId', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', + 'value' => 'value', 'x_position' => 'xPosition', 'y_position' => 'yPosition' ]; @@ -159,12 +165,15 @@ public static function swaggerTypes() 'page_number' => 'setPageNumber', 'recipient_id' => 'setRecipientId', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', + 'value' => 'setValue', 'x_position' => 'setXPosition', 'y_position' => 'setYPosition' ]; @@ -198,12 +207,15 @@ public static function swaggerTypes() 'page_number' => 'getPageNumber', 'recipient_id' => 'getRecipientId', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', + 'value' => 'getValue', 'x_position' => 'getXPosition', 'y_position' => 'getYPosition' ]; @@ -262,12 +274,15 @@ public function __construct(array $data = null) $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; + $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; } @@ -432,7 +447,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -453,7 +468,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -778,6 +793,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -883,6 +919,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -904,6 +961,27 @@ public function setUnderline($underline) return $this; } + /** + * Gets value + * @return string + */ + public function getValue() + { + return $this->container['value']; + } + + /** + * Sets value + * @param string $value Specifies the value of the tab. + * @return $this + */ + public function setValue($value) + { + $this->container['value'] = $value; + + return $this; + } + /** * Gets x_position * @return string diff --git a/src/Model/List.php b/src/Model/List.php deleted file mode 100644 index 80abc082..00000000 --- a/src/Model/List.php +++ /dev/null @@ -1,1358 +0,0 @@ - '\DocuSign\eSign\Model\ListItem[]', - 'value' => 'string', - 'width' => 'int', - 'shared' => 'string', - 'require_initial_on_shared_change' => 'string', - 'required' => 'string', - 'locked' => 'string', - 'sender_required' => 'string', - 'require_all' => 'string', - 'tab_label' => 'string', - 'font' => 'string', - 'bold' => 'string', - 'italic' => 'string', - 'underline' => 'string', - 'font_color' => 'string', - 'font_size' => 'string', - 'document_id' => 'string', - 'recipient_id' => 'string', - 'page_number' => 'string', - 'x_position' => 'string', - 'y_position' => 'string', - 'anchor_string' => 'string', - 'anchor_x_offset' => 'string', - 'anchor_y_offset' => 'string', - 'anchor_units' => 'string', - 'anchor_ignore_if_not_present' => 'string', - 'anchor_case_sensitive' => 'string', - 'anchor_match_whole_word' => 'string', - 'anchor_horizontal_alignment' => 'string', - 'tab_id' => 'string', - 'template_locked' => 'string', - 'template_required' => 'string', - 'conditional_parent_label' => 'string', - 'conditional_parent_value' => 'string', - 'custom_tab_id' => 'string', - 'merge_field' => '\DocuSign\eSign\Model\MergeField', - 'status' => 'string', - 'error_details' => '\DocuSign\eSign\Model\ErrorDetails' - ); - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - static $attributeMap = array( - 'list_items' => 'listItems', - 'value' => 'value', - 'width' => 'width', - 'shared' => 'shared', - 'require_initial_on_shared_change' => 'requireInitialOnSharedChange', - 'required' => 'required', - 'locked' => 'locked', - 'sender_required' => 'senderRequired', - 'require_all' => 'requireAll', - 'tab_label' => 'tabLabel', - 'font' => 'font', - 'bold' => 'bold', - 'italic' => 'italic', - 'underline' => 'underline', - 'font_color' => 'fontColor', - 'font_size' => 'fontSize', - 'document_id' => 'documentId', - 'recipient_id' => 'recipientId', - 'page_number' => 'pageNumber', - 'x_position' => 'xPosition', - 'y_position' => 'yPosition', - 'anchor_string' => 'anchorString', - 'anchor_x_offset' => 'anchorXOffset', - 'anchor_y_offset' => 'anchorYOffset', - 'anchor_units' => 'anchorUnits', - 'anchor_ignore_if_not_present' => 'anchorIgnoreIfNotPresent', - 'anchor_case_sensitive' => 'anchorCaseSensitive', - 'anchor_match_whole_word' => 'anchorMatchWholeWord', - 'anchor_horizontal_alignment' => 'anchorHorizontalAlignment', - 'tab_id' => 'tabId', - 'template_locked' => 'templateLocked', - 'template_required' => 'templateRequired', - 'conditional_parent_label' => 'conditionalParentLabel', - 'conditional_parent_value' => 'conditionalParentValue', - 'custom_tab_id' => 'customTabId', - 'merge_field' => 'mergeField', - 'status' => 'status', - 'error_details' => 'errorDetails' - ); - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - static $setters = array( - 'list_items' => 'setListItems', - 'value' => 'setValue', - 'width' => 'setWidth', - 'shared' => 'setShared', - 'require_initial_on_shared_change' => 'setRequireInitialOnSharedChange', - 'required' => 'setRequired', - 'locked' => 'setLocked', - 'sender_required' => 'setSenderRequired', - 'require_all' => 'setRequireAll', - 'tab_label' => 'setTabLabel', - 'font' => 'setFont', - 'bold' => 'setBold', - 'italic' => 'setItalic', - 'underline' => 'setUnderline', - 'font_color' => 'setFontColor', - 'font_size' => 'setFontSize', - 'document_id' => 'setDocumentId', - 'recipient_id' => 'setRecipientId', - 'page_number' => 'setPageNumber', - 'x_position' => 'setXPosition', - 'y_position' => 'setYPosition', - 'anchor_string' => 'setAnchorString', - 'anchor_x_offset' => 'setAnchorXOffset', - 'anchor_y_offset' => 'setAnchorYOffset', - 'anchor_units' => 'setAnchorUnits', - 'anchor_ignore_if_not_present' => 'setAnchorIgnoreIfNotPresent', - 'anchor_case_sensitive' => 'setAnchorCaseSensitive', - 'anchor_match_whole_word' => 'setAnchorMatchWholeWord', - 'anchor_horizontal_alignment' => 'setAnchorHorizontalAlignment', - 'tab_id' => 'setTabId', - 'template_locked' => 'setTemplateLocked', - 'template_required' => 'setTemplateRequired', - 'conditional_parent_label' => 'setConditionalParentLabel', - 'conditional_parent_value' => 'setConditionalParentValue', - 'custom_tab_id' => 'setCustomTabId', - 'merge_field' => 'setMergeField', - 'status' => 'setStatus', - 'error_details' => 'setErrorDetails' - ); - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - static $getters = array( - 'list_items' => 'getListItems', - 'value' => 'getValue', - 'width' => 'getWidth', - 'shared' => 'getShared', - 'require_initial_on_shared_change' => 'getRequireInitialOnSharedChange', - 'required' => 'getRequired', - 'locked' => 'getLocked', - 'sender_required' => 'getSenderRequired', - 'require_all' => 'getRequireAll', - 'tab_label' => 'getTabLabel', - 'font' => 'getFont', - 'bold' => 'getBold', - 'italic' => 'getItalic', - 'underline' => 'getUnderline', - 'font_color' => 'getFontColor', - 'font_size' => 'getFontSize', - 'document_id' => 'getDocumentId', - 'recipient_id' => 'getRecipientId', - 'page_number' => 'getPageNumber', - 'x_position' => 'getXPosition', - 'y_position' => 'getYPosition', - 'anchor_string' => 'getAnchorString', - 'anchor_x_offset' => 'getAnchorXOffset', - 'anchor_y_offset' => 'getAnchorYOffset', - 'anchor_units' => 'getAnchorUnits', - 'anchor_ignore_if_not_present' => 'getAnchorIgnoreIfNotPresent', - 'anchor_case_sensitive' => 'getAnchorCaseSensitive', - 'anchor_match_whole_word' => 'getAnchorMatchWholeWord', - 'anchor_horizontal_alignment' => 'getAnchorHorizontalAlignment', - 'tab_id' => 'getTabId', - 'template_locked' => 'getTemplateLocked', - 'template_required' => 'getTemplateRequired', - 'conditional_parent_label' => 'getConditionalParentLabel', - 'conditional_parent_value' => 'getConditionalParentValue', - 'custom_tab_id' => 'getCustomTabId', - 'merge_field' => 'getMergeField', - 'status' => 'getStatus', - 'error_details' => 'getErrorDetails' - ); - - - /** - * $list_items The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]\n\nMaximum Length of listItems: 2048 characters.\nMaximum Length of items in the list: 100 characters. - * @var \DocuSign\eSign\Model\ListItem[] - */ - protected $list_items; - - /** - * $value The value to use when the item is selected. - * @var string - */ - protected $value; - - /** - * $width Width of the tab in pixels. - * @var int - */ - protected $width; - - /** - * $shared When set to **true**, this custom tab is shared. - * @var string - */ - protected $shared; - - /** - * $require_initial_on_shared_change Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - * @var string - */ - protected $require_initial_on_shared_change; - - /** - * $required When set to **true**, the signer is required to fill out this tab - * @var string - */ - protected $required; - - /** - * $locked When set to **true**, the signer cannot change the data of the custom tab. - * @var string - */ - protected $locked; - - /** - * $sender_required When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope. - * @var string - */ - protected $sender_required; - - /** - * $require_all When set to **true** and shared is true, information must be entered in this field to complete the envelope. - * @var string - */ - protected $require_all; - - /** - * $tab_label The label string associated with the tab. - * @var string - */ - protected $tab_label; - - /** - * $font The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. - * @var string - */ - protected $font; - - /** - * $bold When set to **true**, the information in the tab is bold. - * @var string - */ - protected $bold; - - /** - * $italic When set to **true**, the information in the tab is italic. - * @var string - */ - protected $italic; - - /** - * $underline When set to **true**, the information in the tab is underlined. - * @var string - */ - protected $underline; - - /** - * $font_color The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. - * @var string - */ - protected $font_color; - - /** - * $font_size The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. - * @var string - */ - protected $font_size; - - /** - * $document_id Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - * @var string - */ - protected $document_id; - - /** - * $recipient_id Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - * @var string - */ - protected $recipient_id; - - /** - * $page_number Specifies the page number on which the tab is located. - * @var string - */ - protected $page_number; - - /** - * $x_position This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. - * @var string - */ - protected $x_position; - - /** - * $y_position This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. - * @var string - */ - protected $y_position; - - /** - * $anchor_string Anchor text information for a radio button. - * @var string - */ - protected $anchor_string; - - /** - * $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. - * @var string - */ - protected $anchor_x_offset; - - /** - * $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. - * @var string - */ - protected $anchor_y_offset; - - /** - * $anchor_units Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. - * @var string - */ - protected $anchor_units; - - /** - * $anchor_ignore_if_not_present When set to **true**, this tab is ignored if anchorString is not found in the document. - * @var string - */ - protected $anchor_ignore_if_not_present; - - /** - * $anchor_case_sensitive When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. - * @var string - */ - protected $anchor_case_sensitive; - - /** - * $anchor_match_whole_word When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. - * @var string - */ - protected $anchor_match_whole_word; - - /** - * $anchor_horizontal_alignment Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. - * @var string - */ - protected $anchor_horizontal_alignment; - - /** - * $tab_id The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. - * @var string - */ - protected $tab_id; - - /** - * $template_locked When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - * @var string - */ - protected $template_locked; - - /** - * $template_required When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - * @var string - */ - protected $template_required; - - /** - * $conditional_parent_label For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - * @var string - */ - protected $conditional_parent_label; - - /** - * $conditional_parent_value For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. - * @var string - */ - protected $conditional_parent_value; - - /** - * $custom_tab_id The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - * @var string - */ - protected $custom_tab_id; - - /** - * $merge_field - * @var \DocuSign\eSign\Model\MergeField - */ - protected $merge_field; - - /** - * $status Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later. - * @var string - */ - protected $status; - - /** - * $error_details - * @var \DocuSign\eSign\Model\ErrorDetails - */ - protected $error_details; - - - /** - * Constructor - * @param mixed[] $data Associated array of property value initalizing the model - */ - public function __construct(array $data = null) - { - if ($data != null) { - $this->list_items = $data["list_items"]; - $this->value = $data["value"]; - $this->width = $data["width"]; - $this->shared = $data["shared"]; - $this->require_initial_on_shared_change = $data["require_initial_on_shared_change"]; - $this->required = $data["required"]; - $this->locked = $data["locked"]; - $this->sender_required = $data["sender_required"]; - $this->require_all = $data["require_all"]; - $this->tab_label = $data["tab_label"]; - $this->font = $data["font"]; - $this->bold = $data["bold"]; - $this->italic = $data["italic"]; - $this->underline = $data["underline"]; - $this->font_color = $data["font_color"]; - $this->font_size = $data["font_size"]; - $this->document_id = $data["document_id"]; - $this->recipient_id = $data["recipient_id"]; - $this->page_number = $data["page_number"]; - $this->x_position = $data["x_position"]; - $this->y_position = $data["y_position"]; - $this->anchor_string = $data["anchor_string"]; - $this->anchor_x_offset = $data["anchor_x_offset"]; - $this->anchor_y_offset = $data["anchor_y_offset"]; - $this->anchor_units = $data["anchor_units"]; - $this->anchor_ignore_if_not_present = $data["anchor_ignore_if_not_present"]; - $this->anchor_case_sensitive = $data["anchor_case_sensitive"]; - $this->anchor_match_whole_word = $data["anchor_match_whole_word"]; - $this->anchor_horizontal_alignment = $data["anchor_horizontal_alignment"]; - $this->tab_id = $data["tab_id"]; - $this->template_locked = $data["template_locked"]; - $this->template_required = $data["template_required"]; - $this->conditional_parent_label = $data["conditional_parent_label"]; - $this->conditional_parent_value = $data["conditional_parent_value"]; - $this->custom_tab_id = $data["custom_tab_id"]; - $this->merge_field = $data["merge_field"]; - $this->status = $data["status"]; - $this->error_details = $data["error_details"]; - } - } - - /** - * Gets list_items - * @return \DocuSign\eSign\Model\ListItem[] - */ - public function getListItems() - { - return $this->list_items; - } - - /** - * Sets list_items - * @param \DocuSign\eSign\Model\ListItem[] $list_items The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]\n\nMaximum Length of listItems: 2048 characters.\nMaximum Length of items in the list: 100 characters. - * @return $this - */ - public function setListItems($list_items) - { - - $this->list_items = $list_items; - return $this; - } - - /** - * Gets value - * @return string - */ - public function getValue() - { - return $this->value; - } - - /** - * Sets value - * @param string $value The value to use when the item is selected. - * @return $this - */ - public function setValue($value) - { - - $this->value = $value; - return $this; - } - - /** - * Gets width - * @return int - */ - public function getWidth() - { - return $this->width; - } - - /** - * Sets width - * @param int $width Width of the tab in pixels. - * @return $this - */ - public function setWidth($width) - { - - $this->width = $width; - return $this; - } - - /** - * Gets shared - * @return string - */ - public function getShared() - { - return $this->shared; - } - - /** - * Sets shared - * @param string $shared When set to **true**, this custom tab is shared. - * @return $this - */ - public function setShared($shared) - { - - $this->shared = $shared; - return $this; - } - - /** - * Gets require_initial_on_shared_change - * @return string - */ - public function getRequireInitialOnSharedChange() - { - return $this->require_initial_on_shared_change; - } - - /** - * Sets require_initial_on_shared_change - * @param string $require_initial_on_shared_change Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - * @return $this - */ - public function setRequireInitialOnSharedChange($require_initial_on_shared_change) - { - - $this->require_initial_on_shared_change = $require_initial_on_shared_change; - return $this; - } - - /** - * Gets required - * @return string - */ - public function getRequired() - { - return $this->required; - } - - /** - * Sets required - * @param string $required When set to **true**, the signer is required to fill out this tab - * @return $this - */ - public function setRequired($required) - { - - $this->required = $required; - return $this; - } - - /** - * Gets locked - * @return string - */ - public function getLocked() - { - return $this->locked; - } - - /** - * Sets locked - * @param string $locked When set to **true**, the signer cannot change the data of the custom tab. - * @return $this - */ - public function setLocked($locked) - { - - $this->locked = $locked; - return $this; - } - - /** - * Gets sender_required - * @return string - */ - public function getSenderRequired() - { - return $this->sender_required; - } - - /** - * Sets sender_required - * @param string $sender_required When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope. - * @return $this - */ - public function setSenderRequired($sender_required) - { - - $this->sender_required = $sender_required; - return $this; - } - - /** - * Gets require_all - * @return string - */ - public function getRequireAll() - { - return $this->require_all; - } - - /** - * Sets require_all - * @param string $require_all When set to **true** and shared is true, information must be entered in this field to complete the envelope. - * @return $this - */ - public function setRequireAll($require_all) - { - - $this->require_all = $require_all; - return $this; - } - - /** - * Gets tab_label - * @return string - */ - public function getTabLabel() - { - return $this->tab_label; - } - - /** - * Sets tab_label - * @param string $tab_label The label string associated with the tab. - * @return $this - */ - public function setTabLabel($tab_label) - { - - $this->tab_label = $tab_label; - return $this; - } - - /** - * Gets font - * @return string - */ - public function getFont() - { - return $this->font; - } - - /** - * Sets font - * @param string $font The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. - * @return $this - */ - public function setFont($font) - { - - $this->font = $font; - return $this; - } - - /** - * Gets bold - * @return string - */ - public function getBold() - { - return $this->bold; - } - - /** - * Sets bold - * @param string $bold When set to **true**, the information in the tab is bold. - * @return $this - */ - public function setBold($bold) - { - - $this->bold = $bold; - return $this; - } - - /** - * Gets italic - * @return string - */ - public function getItalic() - { - return $this->italic; - } - - /** - * Sets italic - * @param string $italic When set to **true**, the information in the tab is italic. - * @return $this - */ - public function setItalic($italic) - { - - $this->italic = $italic; - return $this; - } - - /** - * Gets underline - * @return string - */ - public function getUnderline() - { - return $this->underline; - } - - /** - * Sets underline - * @param string $underline When set to **true**, the information in the tab is underlined. - * @return $this - */ - public function setUnderline($underline) - { - - $this->underline = $underline; - return $this; - } - - /** - * Gets font_color - * @return string - */ - public function getFontColor() - { - return $this->font_color; - } - - /** - * Sets font_color - * @param string $font_color The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. - * @return $this - */ - public function setFontColor($font_color) - { - - $this->font_color = $font_color; - return $this; - } - - /** - * Gets font_size - * @return string - */ - public function getFontSize() - { - return $this->font_size; - } - - /** - * Sets font_size - * @param string $font_size The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. - * @return $this - */ - public function setFontSize($font_size) - { - - $this->font_size = $font_size; - return $this; - } - - /** - * Gets document_id - * @return string - */ - public function getDocumentId() - { - return $this->document_id; - } - - /** - * Sets document_id - * @param string $document_id Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - * @return $this - */ - public function setDocumentId($document_id) - { - - $this->document_id = $document_id; - return $this; - } - - /** - * Gets recipient_id - * @return string - */ - public function getRecipientId() - { - return $this->recipient_id; - } - - /** - * Sets recipient_id - * @param string $recipient_id Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - * @return $this - */ - public function setRecipientId($recipient_id) - { - - $this->recipient_id = $recipient_id; - return $this; - } - - /** - * Gets page_number - * @return string - */ - public function getPageNumber() - { - return $this->page_number; - } - - /** - * Sets page_number - * @param string $page_number Specifies the page number on which the tab is located. - * @return $this - */ - public function setPageNumber($page_number) - { - - $this->page_number = $page_number; - return $this; - } - - /** - * Gets x_position - * @return string - */ - public function getXPosition() - { - return $this->x_position; - } - - /** - * Sets x_position - * @param string $x_position This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. - * @return $this - */ - public function setXPosition($x_position) - { - - $this->x_position = $x_position; - return $this; - } - - /** - * Gets y_position - * @return string - */ - public function getYPosition() - { - return $this->y_position; - } - - /** - * Sets y_position - * @param string $y_position This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. - * @return $this - */ - public function setYPosition($y_position) - { - - $this->y_position = $y_position; - return $this; - } - - /** - * Gets anchor_string - * @return string - */ - public function getAnchorString() - { - return $this->anchor_string; - } - - /** - * Sets anchor_string - * @param string $anchor_string Anchor text information for a radio button. - * @return $this - */ - public function setAnchorString($anchor_string) - { - - $this->anchor_string = $anchor_string; - return $this; - } - - /** - * Gets anchor_x_offset - * @return string - */ - public function getAnchorXOffset() - { - return $this->anchor_x_offset; - } - - /** - * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. - * @return $this - */ - public function setAnchorXOffset($anchor_x_offset) - { - - $this->anchor_x_offset = $anchor_x_offset; - return $this; - } - - /** - * Gets anchor_y_offset - * @return string - */ - public function getAnchorYOffset() - { - return $this->anchor_y_offset; - } - - /** - * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. - * @return $this - */ - public function setAnchorYOffset($anchor_y_offset) - { - - $this->anchor_y_offset = $anchor_y_offset; - return $this; - } - - /** - * Gets anchor_units - * @return string - */ - public function getAnchorUnits() - { - return $this->anchor_units; - } - - /** - * Sets anchor_units - * @param string $anchor_units Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. - * @return $this - */ - public function setAnchorUnits($anchor_units) - { - - $this->anchor_units = $anchor_units; - return $this; - } - - /** - * Gets anchor_ignore_if_not_present - * @return string - */ - public function getAnchorIgnoreIfNotPresent() - { - return $this->anchor_ignore_if_not_present; - } - - /** - * Sets anchor_ignore_if_not_present - * @param string $anchor_ignore_if_not_present When set to **true**, this tab is ignored if anchorString is not found in the document. - * @return $this - */ - public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) - { - - $this->anchor_ignore_if_not_present = $anchor_ignore_if_not_present; - return $this; - } - - /** - * Gets anchor_case_sensitive - * @return string - */ - public function getAnchorCaseSensitive() - { - return $this->anchor_case_sensitive; - } - - /** - * Sets anchor_case_sensitive - * @param string $anchor_case_sensitive When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. - * @return $this - */ - public function setAnchorCaseSensitive($anchor_case_sensitive) - { - - $this->anchor_case_sensitive = $anchor_case_sensitive; - return $this; - } - - /** - * Gets anchor_match_whole_word - * @return string - */ - public function getAnchorMatchWholeWord() - { - return $this->anchor_match_whole_word; - } - - /** - * Sets anchor_match_whole_word - * @param string $anchor_match_whole_word When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. - * @return $this - */ - public function setAnchorMatchWholeWord($anchor_match_whole_word) - { - - $this->anchor_match_whole_word = $anchor_match_whole_word; - return $this; - } - - /** - * Gets anchor_horizontal_alignment - * @return string - */ - public function getAnchorHorizontalAlignment() - { - return $this->anchor_horizontal_alignment; - } - - /** - * Sets anchor_horizontal_alignment - * @param string $anchor_horizontal_alignment Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. - * @return $this - */ - public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) - { - - $this->anchor_horizontal_alignment = $anchor_horizontal_alignment; - return $this; - } - - /** - * Gets tab_id - * @return string - */ - public function getTabId() - { - return $this->tab_id; - } - - /** - * Sets tab_id - * @param string $tab_id The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. - * @return $this - */ - public function setTabId($tab_id) - { - - $this->tab_id = $tab_id; - return $this; - } - - /** - * Gets template_locked - * @return string - */ - public function getTemplateLocked() - { - return $this->template_locked; - } - - /** - * Sets template_locked - * @param string $template_locked When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - * @return $this - */ - public function setTemplateLocked($template_locked) - { - - $this->template_locked = $template_locked; - return $this; - } - - /** - * Gets template_required - * @return string - */ - public function getTemplateRequired() - { - return $this->template_required; - } - - /** - * Sets template_required - * @param string $template_required When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - * @return $this - */ - public function setTemplateRequired($template_required) - { - - $this->template_required = $template_required; - return $this; - } - - /** - * Gets conditional_parent_label - * @return string - */ - public function getConditionalParentLabel() - { - return $this->conditional_parent_label; - } - - /** - * Sets conditional_parent_label - * @param string $conditional_parent_label For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - * @return $this - */ - public function setConditionalParentLabel($conditional_parent_label) - { - - $this->conditional_parent_label = $conditional_parent_label; - return $this; - } - - /** - * Gets conditional_parent_value - * @return string - */ - public function getConditionalParentValue() - { - return $this->conditional_parent_value; - } - - /** - * Sets conditional_parent_value - * @param string $conditional_parent_value For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. - * @return $this - */ - public function setConditionalParentValue($conditional_parent_value) - { - - $this->conditional_parent_value = $conditional_parent_value; - return $this; - } - - /** - * Gets custom_tab_id - * @return string - */ - public function getCustomTabId() - { - return $this->custom_tab_id; - } - - /** - * Sets custom_tab_id - * @param string $custom_tab_id The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - * @return $this - */ - public function setCustomTabId($custom_tab_id) - { - - $this->custom_tab_id = $custom_tab_id; - return $this; - } - - /** - * Gets merge_field - * @return \DocuSign\eSign\Model\MergeField - */ - public function getMergeField() - { - return $this->merge_field; - } - - /** - * Sets merge_field - * @param \DocuSign\eSign\Model\MergeField $merge_field - * @return $this - */ - public function setMergeField($merge_field) - { - - $this->merge_field = $merge_field; - return $this; - } - - /** - * Gets status - * @return string - */ - public function getStatus() - { - return $this->status; - } - - /** - * Sets status - * @param string $status Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later. - * @return $this - */ - public function setStatus($status) - { - - $this->status = $status; - return $this; - } - - /** - * Gets error_details - * @return \DocuSign\eSign\Model\ErrorDetails - */ - public function getErrorDetails() - { - return $this->error_details; - } - - /** - * Sets error_details - * @param \DocuSign\eSign\Model\ErrorDetails $error_details - * @return $this - */ - public function setErrorDetails($error_details) - { - - $this->error_details = $error_details; - return $this; - } - - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - public function offsetExists($offset) - { - return isset($this->$offset); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - public function offsetGet($offset) - { - return $this->$offset; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - public function offsetSet($offset, $value) - { - $this->$offset = $value; - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - public function offsetUnset($offset) - { - unset($this->$offset); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } else { - return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); - } - } -} diff --git a/src/Model/ModelList.php b/src/Model/ModelList.php index 816f3400..61396094 100644 --- a/src/Model/ModelList.php +++ b/src/Model/ModelList.php @@ -83,11 +83,13 @@ class ModelList implements ArrayAccess 'sender_required' => 'string', 'shared' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'value' => 'string', 'width' => 'int', @@ -134,11 +136,13 @@ public static function swaggerTypes() 'sender_required' => 'senderRequired', 'shared' => 'shared', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'value' => 'value', 'width' => 'width', @@ -181,11 +185,13 @@ public static function swaggerTypes() 'sender_required' => 'setSenderRequired', 'shared' => 'setShared', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'value' => 'setValue', 'width' => 'setWidth', @@ -228,11 +234,13 @@ public static function swaggerTypes() 'sender_required' => 'getSenderRequired', 'shared' => 'getShared', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'value' => 'getValue', 'width' => 'getWidth', @@ -300,11 +308,13 @@ public function __construct(array $data = null) $this->container['sender_required'] = isset($data['sender_required']) ? $data['sender_required'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['width'] = isset($data['width']) ? $data['width'] : null; @@ -472,7 +482,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -493,7 +503,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -944,6 +954,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -1049,6 +1080,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string diff --git a/src/Model/NewAccountDefinition.php b/src/Model/NewAccountDefinition.php index 98d99390..619f218a 100644 --- a/src/Model/NewAccountDefinition.php +++ b/src/Model/NewAccountDefinition.php @@ -61,6 +61,7 @@ class NewAccountDefinition implements ArrayAccess 'distributor_code' => 'string', 'distributor_password' => 'string', 'initial_user' => '\DocuSign\eSign\Model\UserInformation', + 'payment_processor_information' => '\DocuSign\eSign\Model\PaymentProcessorInformation', 'plan_information' => '\DocuSign\eSign\Model\PlanInformation', 'referral_information' => '\DocuSign\eSign\Model\ReferralInformation', 'social_account_information' => '\DocuSign\eSign\Model\SocialAccountInformation' @@ -83,6 +84,7 @@ public static function swaggerTypes() 'distributor_code' => 'distributorCode', 'distributor_password' => 'distributorPassword', 'initial_user' => 'initialUser', + 'payment_processor_information' => 'PaymentProcessorInformation', 'plan_information' => 'planInformation', 'referral_information' => 'referralInformation', 'social_account_information' => 'socialAccountInformation' @@ -101,6 +103,7 @@ public static function swaggerTypes() 'distributor_code' => 'setDistributorCode', 'distributor_password' => 'setDistributorPassword', 'initial_user' => 'setInitialUser', + 'payment_processor_information' => 'setPaymentProcessorInformation', 'plan_information' => 'setPlanInformation', 'referral_information' => 'setReferralInformation', 'social_account_information' => 'setSocialAccountInformation' @@ -119,6 +122,7 @@ public static function swaggerTypes() 'distributor_code' => 'getDistributorCode', 'distributor_password' => 'getDistributorPassword', 'initial_user' => 'getInitialUser', + 'payment_processor_information' => 'getPaymentProcessorInformation', 'plan_information' => 'getPlanInformation', 'referral_information' => 'getReferralInformation', 'social_account_information' => 'getSocialAccountInformation' @@ -162,6 +166,7 @@ public function __construct(array $data = null) $this->container['distributor_code'] = isset($data['distributor_code']) ? $data['distributor_code'] : null; $this->container['distributor_password'] = isset($data['distributor_password']) ? $data['distributor_password'] : null; $this->container['initial_user'] = isset($data['initial_user']) ? $data['initial_user'] : null; + $this->container['payment_processor_information'] = isset($data['payment_processor_information']) ? $data['payment_processor_information'] : null; $this->container['plan_information'] = isset($data['plan_information']) ? $data['plan_information'] : null; $this->container['referral_information'] = isset($data['referral_information']) ? $data['referral_information'] : null; $this->container['social_account_information'] = isset($data['social_account_information']) ? $data['social_account_information'] : null; @@ -337,6 +342,27 @@ public function setInitialUser($initial_user) return $this; } + /** + * Gets payment_processor_information + * @return \DocuSign\eSign\Model\PaymentProcessorInformation + */ + public function getPaymentProcessorInformation() + { + return $this->container['payment_processor_information']; + } + + /** + * Sets payment_processor_information + * @param \DocuSign\eSign\Model\PaymentProcessorInformation $payment_processor_information + * @return $this + */ + public function setPaymentProcessorInformation($payment_processor_information) + { + $this->container['payment_processor_information'] = $payment_processor_information; + + return $this; + } + /** * Gets plan_information * @return \DocuSign\eSign\Model\PlanInformation diff --git a/src/Model/Notarize.php b/src/Model/Notarize.php new file mode 100644 index 00000000..3fe64f5a --- /dev/null +++ b/src/Model/Notarize.php @@ -0,0 +1,903 @@ + 'string', + 'anchor_horizontal_alignment' => 'string', + 'anchor_ignore_if_not_present' => 'string', + 'anchor_match_whole_word' => 'string', + 'anchor_string' => 'string', + 'anchor_units' => 'string', + 'anchor_x_offset' => 'string', + 'anchor_y_offset' => 'string', + 'conditional_parent_label' => 'string', + 'conditional_parent_value' => 'string', + 'custom_tab_id' => 'string', + 'document_id' => 'string', + 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', + 'locked' => 'string', + 'merge_field' => '\DocuSign\eSign\Model\MergeField', + 'page_number' => 'string', + 'recipient_id' => 'string', + 'required' => 'string', + 'status' => 'string', + 'tab_group_labels' => 'string[]', + 'tab_id' => 'string', + 'tab_order' => 'string', + 'template_locked' => 'string', + 'template_required' => 'string', + 'tooltip' => 'string', + 'x_position' => 'string', + 'y_position' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'anchor_case_sensitive' => 'anchorCaseSensitive', + 'anchor_horizontal_alignment' => 'anchorHorizontalAlignment', + 'anchor_ignore_if_not_present' => 'anchorIgnoreIfNotPresent', + 'anchor_match_whole_word' => 'anchorMatchWholeWord', + 'anchor_string' => 'anchorString', + 'anchor_units' => 'anchorUnits', + 'anchor_x_offset' => 'anchorXOffset', + 'anchor_y_offset' => 'anchorYOffset', + 'conditional_parent_label' => 'conditionalParentLabel', + 'conditional_parent_value' => 'conditionalParentValue', + 'custom_tab_id' => 'customTabId', + 'document_id' => 'documentId', + 'error_details' => 'errorDetails', + 'locked' => 'locked', + 'merge_field' => 'mergeField', + 'page_number' => 'pageNumber', + 'recipient_id' => 'recipientId', + 'required' => 'required', + 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', + 'tab_id' => 'tabId', + 'tab_order' => 'tabOrder', + 'template_locked' => 'templateLocked', + 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', + 'x_position' => 'xPosition', + 'y_position' => 'yPosition' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'anchor_case_sensitive' => 'setAnchorCaseSensitive', + 'anchor_horizontal_alignment' => 'setAnchorHorizontalAlignment', + 'anchor_ignore_if_not_present' => 'setAnchorIgnoreIfNotPresent', + 'anchor_match_whole_word' => 'setAnchorMatchWholeWord', + 'anchor_string' => 'setAnchorString', + 'anchor_units' => 'setAnchorUnits', + 'anchor_x_offset' => 'setAnchorXOffset', + 'anchor_y_offset' => 'setAnchorYOffset', + 'conditional_parent_label' => 'setConditionalParentLabel', + 'conditional_parent_value' => 'setConditionalParentValue', + 'custom_tab_id' => 'setCustomTabId', + 'document_id' => 'setDocumentId', + 'error_details' => 'setErrorDetails', + 'locked' => 'setLocked', + 'merge_field' => 'setMergeField', + 'page_number' => 'setPageNumber', + 'recipient_id' => 'setRecipientId', + 'required' => 'setRequired', + 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', + 'tab_id' => 'setTabId', + 'tab_order' => 'setTabOrder', + 'template_locked' => 'setTemplateLocked', + 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', + 'x_position' => 'setXPosition', + 'y_position' => 'setYPosition' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'anchor_case_sensitive' => 'getAnchorCaseSensitive', + 'anchor_horizontal_alignment' => 'getAnchorHorizontalAlignment', + 'anchor_ignore_if_not_present' => 'getAnchorIgnoreIfNotPresent', + 'anchor_match_whole_word' => 'getAnchorMatchWholeWord', + 'anchor_string' => 'getAnchorString', + 'anchor_units' => 'getAnchorUnits', + 'anchor_x_offset' => 'getAnchorXOffset', + 'anchor_y_offset' => 'getAnchorYOffset', + 'conditional_parent_label' => 'getConditionalParentLabel', + 'conditional_parent_value' => 'getConditionalParentValue', + 'custom_tab_id' => 'getCustomTabId', + 'document_id' => 'getDocumentId', + 'error_details' => 'getErrorDetails', + 'locked' => 'getLocked', + 'merge_field' => 'getMergeField', + 'page_number' => 'getPageNumber', + 'recipient_id' => 'getRecipientId', + 'required' => 'getRequired', + 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', + 'tab_id' => 'getTabId', + 'tab_order' => 'getTabOrder', + 'template_locked' => 'getTemplateLocked', + 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', + 'x_position' => 'getXPosition', + 'y_position' => 'getYPosition' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['anchor_case_sensitive'] = isset($data['anchor_case_sensitive']) ? $data['anchor_case_sensitive'] : null; + $this->container['anchor_horizontal_alignment'] = isset($data['anchor_horizontal_alignment']) ? $data['anchor_horizontal_alignment'] : null; + $this->container['anchor_ignore_if_not_present'] = isset($data['anchor_ignore_if_not_present']) ? $data['anchor_ignore_if_not_present'] : null; + $this->container['anchor_match_whole_word'] = isset($data['anchor_match_whole_word']) ? $data['anchor_match_whole_word'] : null; + $this->container['anchor_string'] = isset($data['anchor_string']) ? $data['anchor_string'] : null; + $this->container['anchor_units'] = isset($data['anchor_units']) ? $data['anchor_units'] : null; + $this->container['anchor_x_offset'] = isset($data['anchor_x_offset']) ? $data['anchor_x_offset'] : null; + $this->container['anchor_y_offset'] = isset($data['anchor_y_offset']) ? $data['anchor_y_offset'] : null; + $this->container['conditional_parent_label'] = isset($data['conditional_parent_label']) ? $data['conditional_parent_label'] : null; + $this->container['conditional_parent_value'] = isset($data['conditional_parent_value']) ? $data['conditional_parent_value'] : null; + $this->container['custom_tab_id'] = isset($data['custom_tab_id']) ? $data['custom_tab_id'] : null; + $this->container['document_id'] = isset($data['document_id']) ? $data['document_id'] : null; + $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; + $this->container['locked'] = isset($data['locked']) ? $data['locked'] : null; + $this->container['merge_field'] = isset($data['merge_field']) ? $data['merge_field'] : null; + $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; + $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; + $this->container['required'] = isset($data['required']) ? $data['required'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; + $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; + $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; + $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; + $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; + $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; + $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets anchor_case_sensitive + * @return string + */ + public function getAnchorCaseSensitive() + { + return $this->container['anchor_case_sensitive']; + } + + /** + * Sets anchor_case_sensitive + * @param string $anchor_case_sensitive When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. + * @return $this + */ + public function setAnchorCaseSensitive($anchor_case_sensitive) + { + $this->container['anchor_case_sensitive'] = $anchor_case_sensitive; + + return $this; + } + + /** + * Gets anchor_horizontal_alignment + * @return string + */ + public function getAnchorHorizontalAlignment() + { + return $this->container['anchor_horizontal_alignment']; + } + + /** + * Sets anchor_horizontal_alignment + * @param string $anchor_horizontal_alignment Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. + * @return $this + */ + public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) + { + $this->container['anchor_horizontal_alignment'] = $anchor_horizontal_alignment; + + return $this; + } + + /** + * Gets anchor_ignore_if_not_present + * @return string + */ + public function getAnchorIgnoreIfNotPresent() + { + return $this->container['anchor_ignore_if_not_present']; + } + + /** + * Sets anchor_ignore_if_not_present + * @param string $anchor_ignore_if_not_present When set to **true**, this tab is ignored if anchorString is not found in the document. + * @return $this + */ + public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) + { + $this->container['anchor_ignore_if_not_present'] = $anchor_ignore_if_not_present; + + return $this; + } + + /** + * Gets anchor_match_whole_word + * @return string + */ + public function getAnchorMatchWholeWord() + { + return $this->container['anchor_match_whole_word']; + } + + /** + * Sets anchor_match_whole_word + * @param string $anchor_match_whole_word When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. + * @return $this + */ + public function setAnchorMatchWholeWord($anchor_match_whole_word) + { + $this->container['anchor_match_whole_word'] = $anchor_match_whole_word; + + return $this; + } + + /** + * Gets anchor_string + * @return string + */ + public function getAnchorString() + { + return $this->container['anchor_string']; + } + + /** + * Sets anchor_string + * @param string $anchor_string Anchor text information for a radio button. + * @return $this + */ + public function setAnchorString($anchor_string) + { + $this->container['anchor_string'] = $anchor_string; + + return $this; + } + + /** + * Gets anchor_units + * @return string + */ + public function getAnchorUnits() + { + return $this->container['anchor_units']; + } + + /** + * Sets anchor_units + * @param string $anchor_units Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. + * @return $this + */ + public function setAnchorUnits($anchor_units) + { + $this->container['anchor_units'] = $anchor_units; + + return $this; + } + + /** + * Gets anchor_x_offset + * @return string + */ + public function getAnchorXOffset() + { + return $this->container['anchor_x_offset']; + } + + /** + * Sets anchor_x_offset + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. + * @return $this + */ + public function setAnchorXOffset($anchor_x_offset) + { + $this->container['anchor_x_offset'] = $anchor_x_offset; + + return $this; + } + + /** + * Gets anchor_y_offset + * @return string + */ + public function getAnchorYOffset() + { + return $this->container['anchor_y_offset']; + } + + /** + * Sets anchor_y_offset + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. + * @return $this + */ + public function setAnchorYOffset($anchor_y_offset) + { + $this->container['anchor_y_offset'] = $anchor_y_offset; + + return $this; + } + + /** + * Gets conditional_parent_label + * @return string + */ + public function getConditionalParentLabel() + { + return $this->container['conditional_parent_label']; + } + + /** + * Sets conditional_parent_label + * @param string $conditional_parent_label For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. + * @return $this + */ + public function setConditionalParentLabel($conditional_parent_label) + { + $this->container['conditional_parent_label'] = $conditional_parent_label; + + return $this; + } + + /** + * Gets conditional_parent_value + * @return string + */ + public function getConditionalParentValue() + { + return $this->container['conditional_parent_value']; + } + + /** + * Sets conditional_parent_value + * @param string $conditional_parent_value For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. + * @return $this + */ + public function setConditionalParentValue($conditional_parent_value) + { + $this->container['conditional_parent_value'] = $conditional_parent_value; + + return $this; + } + + /** + * Gets custom_tab_id + * @return string + */ + public function getCustomTabId() + { + return $this->container['custom_tab_id']; + } + + /** + * Sets custom_tab_id + * @param string $custom_tab_id The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + * @return $this + */ + public function setCustomTabId($custom_tab_id) + { + $this->container['custom_tab_id'] = $custom_tab_id; + + return $this; + } + + /** + * Gets document_id + * @return string + */ + public function getDocumentId() + { + return $this->container['document_id']; + } + + /** + * Sets document_id + * @param string $document_id Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + * @return $this + */ + public function setDocumentId($document_id) + { + $this->container['document_id'] = $document_id; + + return $this; + } + + /** + * Gets error_details + * @return \DocuSign\eSign\Model\ErrorDetails + */ + public function getErrorDetails() + { + return $this->container['error_details']; + } + + /** + * Sets error_details + * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * @return $this + */ + public function setErrorDetails($error_details) + { + $this->container['error_details'] = $error_details; + + return $this; + } + + /** + * Gets locked + * @return string + */ + public function getLocked() + { + return $this->container['locked']; + } + + /** + * Sets locked + * @param string $locked When set to **true**, the signer cannot change the data of the custom tab. + * @return $this + */ + public function setLocked($locked) + { + $this->container['locked'] = $locked; + + return $this; + } + + /** + * Gets merge_field + * @return \DocuSign\eSign\Model\MergeField + */ + public function getMergeField() + { + return $this->container['merge_field']; + } + + /** + * Sets merge_field + * @param \DocuSign\eSign\Model\MergeField $merge_field + * @return $this + */ + public function setMergeField($merge_field) + { + $this->container['merge_field'] = $merge_field; + + return $this; + } + + /** + * Gets page_number + * @return string + */ + public function getPageNumber() + { + return $this->container['page_number']; + } + + /** + * Sets page_number + * @param string $page_number Specifies the page number on which the tab is located. + * @return $this + */ + public function setPageNumber($page_number) + { + $this->container['page_number'] = $page_number; + + return $this; + } + + /** + * Gets recipient_id + * @return string + */ + public function getRecipientId() + { + return $this->container['recipient_id']; + } + + /** + * Sets recipient_id + * @param string $recipient_id Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + * @return $this + */ + public function setRecipientId($recipient_id) + { + $this->container['recipient_id'] = $recipient_id; + + return $this; + } + + /** + * Gets required + * @return string + */ + public function getRequired() + { + return $this->container['required']; + } + + /** + * Sets required + * @param string $required When set to **true**, the signer is required to fill out this tab + * @return $this + */ + public function setRequired($required) + { + $this->container['required'] = $required; + + return $this; + } + + /** + * Gets status + * @return string + */ + public function getStatus() + { + return $this->container['status']; + } + + /** + * Sets status + * @param string $status Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. + * @return $this + */ + public function setStatus($status) + { + $this->container['status'] = $status; + + return $this; + } + + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + + /** + * Gets tab_id + * @return string + */ + public function getTabId() + { + return $this->container['tab_id']; + } + + /** + * Sets tab_id + * @param string $tab_id The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. + * @return $this + */ + public function setTabId($tab_id) + { + $this->container['tab_id'] = $tab_id; + + return $this; + } + + /** + * Gets tab_order + * @return string + */ + public function getTabOrder() + { + return $this->container['tab_order']; + } + + /** + * Sets tab_order + * @param string $tab_order + * @return $this + */ + public function setTabOrder($tab_order) + { + $this->container['tab_order'] = $tab_order; + + return $this; + } + + /** + * Gets template_locked + * @return string + */ + public function getTemplateLocked() + { + return $this->container['template_locked']; + } + + /** + * Sets template_locked + * @param string $template_locked When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + * @return $this + */ + public function setTemplateLocked($template_locked) + { + $this->container['template_locked'] = $template_locked; + + return $this; + } + + /** + * Gets template_required + * @return string + */ + public function getTemplateRequired() + { + return $this->container['template_required']; + } + + /** + * Sets template_required + * @param string $template_required When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + * @return $this + */ + public function setTemplateRequired($template_required) + { + $this->container['template_required'] = $template_required; + + return $this; + } + + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + + /** + * Gets x_position + * @return string + */ + public function getXPosition() + { + return $this->container['x_position']; + } + + /** + * Sets x_position + * @param string $x_position This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. + * @return $this + */ + public function setXPosition($x_position) + { + $this->container['x_position'] = $x_position; + + return $this; + } + + /** + * Gets y_position + * @return string + */ + public function getYPosition() + { + return $this->container['y_position']; + } + + /** + * Sets y_position + * @param string $y_position This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. + * @return $this + */ + public function setYPosition($y_position) + { + $this->container['y_position'] = $y_position; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/NotaryHost.php b/src/Model/NotaryHost.php index f86285f8..3d14aa8c 100644 --- a/src/Model/NotaryHost.php +++ b/src/Model/NotaryHost.php @@ -73,8 +73,6 @@ class NotaryHost implements ArrayAccess 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', 'inherit_email_notification_configuration' => 'string', 'name' => 'string', - 'notary_email_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', - 'notary_name_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'note' => 'string', 'phone_authentication' => '\DocuSign\eSign\Model\RecipientPhoneAuthentication', 'recipient_attachments' => '\DocuSign\eSign\Model\RecipientAttachment[]', @@ -90,6 +88,7 @@ class NotaryHost implements ArrayAccess 'sms_authentication' => '\DocuSign\eSign\Model\RecipientSMSAuthentication', 'social_authentications' => '\DocuSign\eSign\Model\SocialAuthentication[]', 'status' => 'string', + 'tabs' => '\DocuSign\eSign\Model\Tabs', 'template_locked' => 'string', 'template_required' => 'string', 'total_tab_count' => 'string', @@ -125,8 +124,6 @@ public static function swaggerTypes() 'id_check_information_input' => 'idCheckInformationInput', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'name' => 'name', - 'notary_email_metadata' => 'notaryEmailMetadata', - 'notary_name_metadata' => 'notaryNameMetadata', 'note' => 'note', 'phone_authentication' => 'phoneAuthentication', 'recipient_attachments' => 'recipientAttachments', @@ -142,6 +139,7 @@ public static function swaggerTypes() 'sms_authentication' => 'smsAuthentication', 'social_authentications' => 'socialAuthentications', 'status' => 'status', + 'tabs' => 'tabs', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', 'total_tab_count' => 'totalTabCount', @@ -173,8 +171,6 @@ public static function swaggerTypes() 'id_check_information_input' => 'setIdCheckInformationInput', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'name' => 'setName', - 'notary_email_metadata' => 'setNotaryEmailMetadata', - 'notary_name_metadata' => 'setNotaryNameMetadata', 'note' => 'setNote', 'phone_authentication' => 'setPhoneAuthentication', 'recipient_attachments' => 'setRecipientAttachments', @@ -190,6 +186,7 @@ public static function swaggerTypes() 'sms_authentication' => 'setSmsAuthentication', 'social_authentications' => 'setSocialAuthentications', 'status' => 'setStatus', + 'tabs' => 'setTabs', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', 'total_tab_count' => 'setTotalTabCount', @@ -221,8 +218,6 @@ public static function swaggerTypes() 'id_check_information_input' => 'getIdCheckInformationInput', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'name' => 'getName', - 'notary_email_metadata' => 'getNotaryEmailMetadata', - 'notary_name_metadata' => 'getNotaryNameMetadata', 'note' => 'getNote', 'phone_authentication' => 'getPhoneAuthentication', 'recipient_attachments' => 'getRecipientAttachments', @@ -238,6 +233,7 @@ public static function swaggerTypes() 'sms_authentication' => 'getSmsAuthentication', 'social_authentications' => 'getSocialAuthentications', 'status' => 'getStatus', + 'tabs' => 'getTabs', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', 'total_tab_count' => 'getTotalTabCount', @@ -294,8 +290,6 @@ public function __construct(array $data = null) $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; - $this->container['notary_email_metadata'] = isset($data['notary_email_metadata']) ? $data['notary_email_metadata'] : null; - $this->container['notary_name_metadata'] = isset($data['notary_name_metadata']) ? $data['notary_name_metadata'] : null; $this->container['note'] = isset($data['note']) ? $data['note'] : null; $this->container['phone_authentication'] = isset($data['phone_authentication']) ? $data['phone_authentication'] : null; $this->container['recipient_attachments'] = isset($data['recipient_attachments']) ? $data['recipient_attachments'] : null; @@ -311,6 +305,7 @@ public function __construct(array $data = null) $this->container['sms_authentication'] = isset($data['sms_authentication']) ? $data['sms_authentication'] : null; $this->container['social_authentications'] = isset($data['social_authentications']) ? $data['social_authentications'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tabs'] = isset($data['tabs']) ? $data['tabs'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; $this->container['total_tab_count'] = isset($data['total_tab_count']) ? $data['total_tab_count'] : null; @@ -351,7 +346,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) @@ -582,7 +577,7 @@ public function getEmbeddedRecipientStartUrl() /** * Sets embedded_recipient_start_url - * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -739,48 +734,6 @@ public function setName($name) return $this; } - /** - * Gets notary_email_metadata - * @return \DocuSign\eSign\Model\PropertyMetadata - */ - public function getNotaryEmailMetadata() - { - return $this->container['notary_email_metadata']; - } - - /** - * Sets notary_email_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $notary_email_metadata - * @return $this - */ - public function setNotaryEmailMetadata($notary_email_metadata) - { - $this->container['notary_email_metadata'] = $notary_email_metadata; - - return $this; - } - - /** - * Gets notary_name_metadata - * @return \DocuSign\eSign\Model\PropertyMetadata - */ - public function getNotaryNameMetadata() - { - return $this->container['notary_name_metadata']; - } - - /** - * Sets notary_name_metadata - * @param \DocuSign\eSign\Model\PropertyMetadata $notary_name_metadata - * @return $this - */ - public function setNotaryNameMetadata($notary_name_metadata) - { - $this->container['notary_name_metadata'] = $notary_name_metadata; - - return $this; - } - /** * Gets note * @return string @@ -1096,6 +1049,27 @@ public function setStatus($status) return $this; } + /** + * Gets tabs + * @return \DocuSign\eSign\Model\Tabs + */ + public function getTabs() + { + return $this->container['tabs']; + } + + /** + * Sets tabs + * @param \DocuSign\eSign\Model\Tabs $tabs + * @return $this + */ + public function setTabs($tabs) + { + $this->container['tabs'] = $tabs; + + return $this; + } + /** * Gets template_locked * @return string diff --git a/src/Model/NotaryJournal.php b/src/Model/NotaryJournal.php new file mode 100644 index 00000000..a9c1194d --- /dev/null +++ b/src/Model/NotaryJournal.php @@ -0,0 +1,357 @@ + 'string', + 'document_name' => 'string', + 'jurisdiction' => '\DocuSign\eSign\Model\Jurisdiction', + 'notary_journal_id' => 'string', + 'notary_journal_meta_data' => '\DocuSign\eSign\Model\NotaryJournalMetaData', + 'signer_name' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'created_date' => 'createdDate', + 'document_name' => 'documentName', + 'jurisdiction' => 'jurisdiction', + 'notary_journal_id' => 'notaryJournalId', + 'notary_journal_meta_data' => 'notaryJournalMetaData', + 'signer_name' => 'signerName' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'created_date' => 'setCreatedDate', + 'document_name' => 'setDocumentName', + 'jurisdiction' => 'setJurisdiction', + 'notary_journal_id' => 'setNotaryJournalId', + 'notary_journal_meta_data' => 'setNotaryJournalMetaData', + 'signer_name' => 'setSignerName' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'created_date' => 'getCreatedDate', + 'document_name' => 'getDocumentName', + 'jurisdiction' => 'getJurisdiction', + 'notary_journal_id' => 'getNotaryJournalId', + 'notary_journal_meta_data' => 'getNotaryJournalMetaData', + 'signer_name' => 'getSignerName' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['created_date'] = isset($data['created_date']) ? $data['created_date'] : null; + $this->container['document_name'] = isset($data['document_name']) ? $data['document_name'] : null; + $this->container['jurisdiction'] = isset($data['jurisdiction']) ? $data['jurisdiction'] : null; + $this->container['notary_journal_id'] = isset($data['notary_journal_id']) ? $data['notary_journal_id'] : null; + $this->container['notary_journal_meta_data'] = isset($data['notary_journal_meta_data']) ? $data['notary_journal_meta_data'] : null; + $this->container['signer_name'] = isset($data['signer_name']) ? $data['signer_name'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets created_date + * @return string + */ + public function getCreatedDate() + { + return $this->container['created_date']; + } + + /** + * Sets created_date + * @param string $created_date + * @return $this + */ + public function setCreatedDate($created_date) + { + $this->container['created_date'] = $created_date; + + return $this; + } + + /** + * Gets document_name + * @return string + */ + public function getDocumentName() + { + return $this->container['document_name']; + } + + /** + * Sets document_name + * @param string $document_name + * @return $this + */ + public function setDocumentName($document_name) + { + $this->container['document_name'] = $document_name; + + return $this; + } + + /** + * Gets jurisdiction + * @return \DocuSign\eSign\Model\Jurisdiction + */ + public function getJurisdiction() + { + return $this->container['jurisdiction']; + } + + /** + * Sets jurisdiction + * @param \DocuSign\eSign\Model\Jurisdiction $jurisdiction + * @return $this + */ + public function setJurisdiction($jurisdiction) + { + $this->container['jurisdiction'] = $jurisdiction; + + return $this; + } + + /** + * Gets notary_journal_id + * @return string + */ + public function getNotaryJournalId() + { + return $this->container['notary_journal_id']; + } + + /** + * Sets notary_journal_id + * @param string $notary_journal_id + * @return $this + */ + public function setNotaryJournalId($notary_journal_id) + { + $this->container['notary_journal_id'] = $notary_journal_id; + + return $this; + } + + /** + * Gets notary_journal_meta_data + * @return \DocuSign\eSign\Model\NotaryJournalMetaData + */ + public function getNotaryJournalMetaData() + { + return $this->container['notary_journal_meta_data']; + } + + /** + * Sets notary_journal_meta_data + * @param \DocuSign\eSign\Model\NotaryJournalMetaData $notary_journal_meta_data + * @return $this + */ + public function setNotaryJournalMetaData($notary_journal_meta_data) + { + $this->container['notary_journal_meta_data'] = $notary_journal_meta_data; + + return $this; + } + + /** + * Gets signer_name + * @return string + */ + public function getSignerName() + { + return $this->container['signer_name']; + } + + /** + * Sets signer_name + * @param string $signer_name + * @return $this + */ + public function setSignerName($signer_name) + { + $this->container['signer_name'] = $signer_name; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/NotaryJournalCredibleWitness.php b/src/Model/NotaryJournalCredibleWitness.php new file mode 100644 index 00000000..ac4777d9 --- /dev/null +++ b/src/Model/NotaryJournalCredibleWitness.php @@ -0,0 +1,279 @@ + 'string', + 'name' => 'string', + 'signature_image' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'address' => 'address', + 'name' => 'name', + 'signature_image' => 'signatureImage' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'address' => 'setAddress', + 'name' => 'setName', + 'signature_image' => 'setSignatureImage' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'address' => 'getAddress', + 'name' => 'getName', + 'signature_image' => 'getSignatureImage' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['address'] = isset($data['address']) ? $data['address'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['signature_image'] = isset($data['signature_image']) ? $data['signature_image'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets address + * @return string + */ + public function getAddress() + { + return $this->container['address']; + } + + /** + * Sets address + * @param string $address + * @return $this + */ + public function setAddress($address) + { + $this->container['address'] = $address; + + return $this; + } + + /** + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + + /** + * Gets signature_image + * @return string + */ + public function getSignatureImage() + { + return $this->container['signature_image']; + } + + /** + * Sets signature_image + * @param string $signature_image + * @return $this + */ + public function setSignatureImage($signature_image) + { + $this->container['signature_image'] = $signature_image; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/NotaryJournalList.php b/src/Model/NotaryJournalList.php new file mode 100644 index 00000000..0ebfd255 --- /dev/null +++ b/src/Model/NotaryJournalList.php @@ -0,0 +1,383 @@ + 'string', + 'next_uri' => 'string', + 'notary_journals' => '\DocuSign\eSign\Model\NotaryJournal[]', + 'previous_uri' => 'string', + 'result_set_size' => 'string', + 'start_position' => 'string', + 'total_set_size' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'end_position' => 'endPosition', + 'next_uri' => 'nextUri', + 'notary_journals' => 'notaryJournals', + 'previous_uri' => 'previousUri', + 'result_set_size' => 'resultSetSize', + 'start_position' => 'startPosition', + 'total_set_size' => 'totalSetSize' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'end_position' => 'setEndPosition', + 'next_uri' => 'setNextUri', + 'notary_journals' => 'setNotaryJournals', + 'previous_uri' => 'setPreviousUri', + 'result_set_size' => 'setResultSetSize', + 'start_position' => 'setStartPosition', + 'total_set_size' => 'setTotalSetSize' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'end_position' => 'getEndPosition', + 'next_uri' => 'getNextUri', + 'notary_journals' => 'getNotaryJournals', + 'previous_uri' => 'getPreviousUri', + 'result_set_size' => 'getResultSetSize', + 'start_position' => 'getStartPosition', + 'total_set_size' => 'getTotalSetSize' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['end_position'] = isset($data['end_position']) ? $data['end_position'] : null; + $this->container['next_uri'] = isset($data['next_uri']) ? $data['next_uri'] : null; + $this->container['notary_journals'] = isset($data['notary_journals']) ? $data['notary_journals'] : null; + $this->container['previous_uri'] = isset($data['previous_uri']) ? $data['previous_uri'] : null; + $this->container['result_set_size'] = isset($data['result_set_size']) ? $data['result_set_size'] : null; + $this->container['start_position'] = isset($data['start_position']) ? $data['start_position'] : null; + $this->container['total_set_size'] = isset($data['total_set_size']) ? $data['total_set_size'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets end_position + * @return string + */ + public function getEndPosition() + { + return $this->container['end_position']; + } + + /** + * Sets end_position + * @param string $end_position The last position in the result set. + * @return $this + */ + public function setEndPosition($end_position) + { + $this->container['end_position'] = $end_position; + + return $this; + } + + /** + * Gets next_uri + * @return string + */ + public function getNextUri() + { + return $this->container['next_uri']; + } + + /** + * Sets next_uri + * @param string $next_uri The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. + * @return $this + */ + public function setNextUri($next_uri) + { + $this->container['next_uri'] = $next_uri; + + return $this; + } + + /** + * Gets notary_journals + * @return \DocuSign\eSign\Model\NotaryJournal[] + */ + public function getNotaryJournals() + { + return $this->container['notary_journals']; + } + + /** + * Sets notary_journals + * @param \DocuSign\eSign\Model\NotaryJournal[] $notary_journals + * @return $this + */ + public function setNotaryJournals($notary_journals) + { + $this->container['notary_journals'] = $notary_journals; + + return $this; + } + + /** + * Gets previous_uri + * @return string + */ + public function getPreviousUri() + { + return $this->container['previous_uri']; + } + + /** + * Sets previous_uri + * @param string $previous_uri The postal code for the billing address. + * @return $this + */ + public function setPreviousUri($previous_uri) + { + $this->container['previous_uri'] = $previous_uri; + + return $this; + } + + /** + * Gets result_set_size + * @return string + */ + public function getResultSetSize() + { + return $this->container['result_set_size']; + } + + /** + * Sets result_set_size + * @param string $result_set_size The number of results returned in this response. + * @return $this + */ + public function setResultSetSize($result_set_size) + { + $this->container['result_set_size'] = $result_set_size; + + return $this; + } + + /** + * Gets start_position + * @return string + */ + public function getStartPosition() + { + return $this->container['start_position']; + } + + /** + * Sets start_position + * @param string $start_position Starting position of the current result set. + * @return $this + */ + public function setStartPosition($start_position) + { + $this->container['start_position'] = $start_position; + + return $this; + } + + /** + * Gets total_set_size + * @return string + */ + public function getTotalSetSize() + { + return $this->container['total_set_size']; + } + + /** + * Sets total_set_size + * @param string $total_set_size The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. + * @return $this + */ + public function setTotalSetSize($total_set_size) + { + $this->container['total_set_size'] = $total_set_size; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/NotaryJournalMetaData.php b/src/Model/NotaryJournalMetaData.php new file mode 100644 index 00000000..0fb384fc --- /dev/null +++ b/src/Model/NotaryJournalMetaData.php @@ -0,0 +1,305 @@ + 'string', + 'credible_witnesses' => '\DocuSign\eSign\Model\NotaryJournalCredibleWitness[]', + 'signature_image' => 'string', + 'signer_id_type' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'comment' => 'comment', + 'credible_witnesses' => 'credibleWitnesses', + 'signature_image' => 'signatureImage', + 'signer_id_type' => 'signerIdType' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'comment' => 'setComment', + 'credible_witnesses' => 'setCredibleWitnesses', + 'signature_image' => 'setSignatureImage', + 'signer_id_type' => 'setSignerIdType' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'comment' => 'getComment', + 'credible_witnesses' => 'getCredibleWitnesses', + 'signature_image' => 'getSignatureImage', + 'signer_id_type' => 'getSignerIdType' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['comment'] = isset($data['comment']) ? $data['comment'] : null; + $this->container['credible_witnesses'] = isset($data['credible_witnesses']) ? $data['credible_witnesses'] : null; + $this->container['signature_image'] = isset($data['signature_image']) ? $data['signature_image'] : null; + $this->container['signer_id_type'] = isset($data['signer_id_type']) ? $data['signer_id_type'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets comment + * @return string + */ + public function getComment() + { + return $this->container['comment']; + } + + /** + * Sets comment + * @param string $comment + * @return $this + */ + public function setComment($comment) + { + $this->container['comment'] = $comment; + + return $this; + } + + /** + * Gets credible_witnesses + * @return \DocuSign\eSign\Model\NotaryJournalCredibleWitness[] + */ + public function getCredibleWitnesses() + { + return $this->container['credible_witnesses']; + } + + /** + * Sets credible_witnesses + * @param \DocuSign\eSign\Model\NotaryJournalCredibleWitness[] $credible_witnesses + * @return $this + */ + public function setCredibleWitnesses($credible_witnesses) + { + $this->container['credible_witnesses'] = $credible_witnesses; + + return $this; + } + + /** + * Gets signature_image + * @return string + */ + public function getSignatureImage() + { + return $this->container['signature_image']; + } + + /** + * Sets signature_image + * @param string $signature_image + * @return $this + */ + public function setSignatureImage($signature_image) + { + $this->container['signature_image'] = $signature_image; + + return $this; + } + + /** + * Gets signer_id_type + * @return string + */ + public function getSignerIdType() + { + return $this->container['signer_id_type']; + } + + /** + * Sets signer_id_type + * @param string $signer_id_type + * @return $this + */ + public function setSignerIdType($signer_id_type) + { + $this->container['signer_id_type'] = $signer_id_type; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Note.php b/src/Model/Note.php index 4bfb2b28..9bf81dad 100644 --- a/src/Model/Note.php +++ b/src/Model/Note.php @@ -79,11 +79,13 @@ class Note implements ArrayAccess 'recipient_id' => 'string', 'shared' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'value' => 'string', 'width' => 'int', @@ -126,11 +128,13 @@ public static function swaggerTypes() 'recipient_id' => 'recipientId', 'shared' => 'shared', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'value' => 'value', 'width' => 'width', @@ -169,11 +173,13 @@ public static function swaggerTypes() 'recipient_id' => 'setRecipientId', 'shared' => 'setShared', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'value' => 'setValue', 'width' => 'setWidth', @@ -212,11 +218,13 @@ public static function swaggerTypes() 'recipient_id' => 'getRecipientId', 'shared' => 'getShared', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'value' => 'getValue', 'width' => 'getWidth', @@ -280,11 +288,13 @@ public function __construct(array $data = null) $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['width'] = isset($data['width']) ? $data['width'] : null; @@ -452,7 +462,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -473,7 +483,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -840,6 +850,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -945,6 +976,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string diff --git a/src/Model/Number.php b/src/Model/Number.php index 0cbe60f4..5e2f9742 100644 --- a/src/Model/Number.php +++ b/src/Model/Number.php @@ -89,11 +89,13 @@ class Number implements ArrayAccess 'sender_required' => 'string', 'shared' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'validation_message' => 'string', 'validation_pattern' => 'string', @@ -148,11 +150,13 @@ public static function swaggerTypes() 'sender_required' => 'senderRequired', 'shared' => 'shared', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'validation_message' => 'validationMessage', 'validation_pattern' => 'validationPattern', @@ -203,11 +207,13 @@ public static function swaggerTypes() 'sender_required' => 'setSenderRequired', 'shared' => 'setShared', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'validation_message' => 'setValidationMessage', 'validation_pattern' => 'setValidationPattern', @@ -258,11 +264,13 @@ public static function swaggerTypes() 'sender_required' => 'getSenderRequired', 'shared' => 'getShared', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'validation_message' => 'getValidationMessage', 'validation_pattern' => 'getValidationPattern', @@ -338,11 +346,13 @@ public function __construct(array $data = null) $this->container['sender_required'] = isset($data['sender_required']) ? $data['sender_required'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['validation_message'] = isset($data['validation_message']) ? $data['validation_message'] : null; $this->container['validation_pattern'] = isset($data['validation_pattern']) ? $data['validation_pattern'] : null; @@ -512,7 +522,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -533,7 +543,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -1110,6 +1120,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -1215,6 +1246,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -1268,7 +1320,7 @@ public function getValidationPattern() /** * Sets validation_pattern - * @param string $validation_pattern A regular expressionn used to validate input for the tab. + * @param string $validation_pattern A regular expression used to validate input for the tab. * @return $this */ public function setValidationPattern($validation_pattern) diff --git a/src/Model/PaymentDetails.php b/src/Model/PaymentDetails.php index 1798190e..8c62caff 100644 --- a/src/Model/PaymentDetails.php +++ b/src/Model/PaymentDetails.php @@ -54,9 +54,14 @@ class PaymentDetails implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ + 'allowed_payment_methods' => 'string[]', + 'charge_id' => 'string', 'currency_code' => 'string', 'gateway_account_id' => 'string', + 'gateway_display_name' => 'string', + 'gateway_name' => 'string', 'line_items' => '\DocuSign\eSign\Model\PaymentLineItem[]', + 'payment_option' => 'string', 'status' => 'string', 'total' => '\DocuSign\eSign\Model\Money' ]; @@ -71,9 +76,14 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ + 'allowed_payment_methods' => 'allowedPaymentMethods', + 'charge_id' => 'chargeId', 'currency_code' => 'currencyCode', 'gateway_account_id' => 'gatewayAccountId', + 'gateway_display_name' => 'gatewayDisplayName', + 'gateway_name' => 'gatewayName', 'line_items' => 'lineItems', + 'payment_option' => 'paymentOption', 'status' => 'status', 'total' => 'total' ]; @@ -84,9 +94,14 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ + 'allowed_payment_methods' => 'setAllowedPaymentMethods', + 'charge_id' => 'setChargeId', 'currency_code' => 'setCurrencyCode', 'gateway_account_id' => 'setGatewayAccountId', + 'gateway_display_name' => 'setGatewayDisplayName', + 'gateway_name' => 'setGatewayName', 'line_items' => 'setLineItems', + 'payment_option' => 'setPaymentOption', 'status' => 'setStatus', 'total' => 'setTotal' ]; @@ -97,9 +112,14 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ + 'allowed_payment_methods' => 'getAllowedPaymentMethods', + 'charge_id' => 'getChargeId', 'currency_code' => 'getCurrencyCode', 'gateway_account_id' => 'getGatewayAccountId', + 'gateway_display_name' => 'getGatewayDisplayName', + 'gateway_name' => 'getGatewayName', 'line_items' => 'getLineItems', + 'payment_option' => 'getPaymentOption', 'status' => 'getStatus', 'total' => 'getTotal' ]; @@ -135,9 +155,14 @@ public static function getters() */ public function __construct(array $data = null) { + $this->container['allowed_payment_methods'] = isset($data['allowed_payment_methods']) ? $data['allowed_payment_methods'] : null; + $this->container['charge_id'] = isset($data['charge_id']) ? $data['charge_id'] : null; $this->container['currency_code'] = isset($data['currency_code']) ? $data['currency_code'] : null; $this->container['gateway_account_id'] = isset($data['gateway_account_id']) ? $data['gateway_account_id'] : null; + $this->container['gateway_display_name'] = isset($data['gateway_display_name']) ? $data['gateway_display_name'] : null; + $this->container['gateway_name'] = isset($data['gateway_name']) ? $data['gateway_name'] : null; $this->container['line_items'] = isset($data['line_items']) ? $data['line_items'] : null; + $this->container['payment_option'] = isset($data['payment_option']) ? $data['payment_option'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['total'] = isset($data['total']) ? $data['total'] : null; } @@ -165,6 +190,48 @@ public function valid() } + /** + * Gets allowed_payment_methods + * @return string[] + */ + public function getAllowedPaymentMethods() + { + return $this->container['allowed_payment_methods']; + } + + /** + * Sets allowed_payment_methods + * @param string[] $allowed_payment_methods + * @return $this + */ + public function setAllowedPaymentMethods($allowed_payment_methods) + { + $this->container['allowed_payment_methods'] = $allowed_payment_methods; + + return $this; + } + + /** + * Gets charge_id + * @return string + */ + public function getChargeId() + { + return $this->container['charge_id']; + } + + /** + * Sets charge_id + * @param string $charge_id + * @return $this + */ + public function setChargeId($charge_id) + { + $this->container['charge_id'] = $charge_id; + + return $this; + } + /** * Gets currency_code * @return string @@ -207,6 +274,48 @@ public function setGatewayAccountId($gateway_account_id) return $this; } + /** + * Gets gateway_display_name + * @return string + */ + public function getGatewayDisplayName() + { + return $this->container['gateway_display_name']; + } + + /** + * Sets gateway_display_name + * @param string $gateway_display_name + * @return $this + */ + public function setGatewayDisplayName($gateway_display_name) + { + $this->container['gateway_display_name'] = $gateway_display_name; + + return $this; + } + + /** + * Gets gateway_name + * @return string + */ + public function getGatewayName() + { + return $this->container['gateway_name']; + } + + /** + * Sets gateway_name + * @param string $gateway_name + * @return $this + */ + public function setGatewayName($gateway_name) + { + $this->container['gateway_name'] = $gateway_name; + + return $this; + } + /** * Gets line_items * @return \DocuSign\eSign\Model\PaymentLineItem[] @@ -228,6 +337,27 @@ public function setLineItems($line_items) return $this; } + /** + * Gets payment_option + * @return string + */ + public function getPaymentOption() + { + return $this->container['payment_option']; + } + + /** + * Sets payment_option + * @param string $payment_option + * @return $this + */ + public function setPaymentOption($payment_option) + { + $this->container['payment_option'] = $payment_option; + + return $this; + } + /** * Gets status * @return string diff --git a/src/Model/PaymentGatewayAccount.php b/src/Model/PaymentGatewayAccount.php new file mode 100644 index 00000000..79198690 --- /dev/null +++ b/src/Model/PaymentGatewayAccount.php @@ -0,0 +1,305 @@ + 'string', + 'payment_gateway' => 'string', + 'payment_gateway_account_id' => 'string', + 'payment_gateway_display_name' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'display_name' => 'displayName', + 'payment_gateway' => 'paymentGateway', + 'payment_gateway_account_id' => 'paymentGatewayAccountId', + 'payment_gateway_display_name' => 'paymentGatewayDisplayName' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'display_name' => 'setDisplayName', + 'payment_gateway' => 'setPaymentGateway', + 'payment_gateway_account_id' => 'setPaymentGatewayAccountId', + 'payment_gateway_display_name' => 'setPaymentGatewayDisplayName' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'display_name' => 'getDisplayName', + 'payment_gateway' => 'getPaymentGateway', + 'payment_gateway_account_id' => 'getPaymentGatewayAccountId', + 'payment_gateway_display_name' => 'getPaymentGatewayDisplayName' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['display_name'] = isset($data['display_name']) ? $data['display_name'] : null; + $this->container['payment_gateway'] = isset($data['payment_gateway']) ? $data['payment_gateway'] : null; + $this->container['payment_gateway_account_id'] = isset($data['payment_gateway_account_id']) ? $data['payment_gateway_account_id'] : null; + $this->container['payment_gateway_display_name'] = isset($data['payment_gateway_display_name']) ? $data['payment_gateway_display_name'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets display_name + * @return string + */ + public function getDisplayName() + { + return $this->container['display_name']; + } + + /** + * Sets display_name + * @param string $display_name + * @return $this + */ + public function setDisplayName($display_name) + { + $this->container['display_name'] = $display_name; + + return $this; + } + + /** + * Gets payment_gateway + * @return string + */ + public function getPaymentGateway() + { + return $this->container['payment_gateway']; + } + + /** + * Sets payment_gateway + * @param string $payment_gateway + * @return $this + */ + public function setPaymentGateway($payment_gateway) + { + $this->container['payment_gateway'] = $payment_gateway; + + return $this; + } + + /** + * Gets payment_gateway_account_id + * @return string + */ + public function getPaymentGatewayAccountId() + { + return $this->container['payment_gateway_account_id']; + } + + /** + * Sets payment_gateway_account_id + * @param string $payment_gateway_account_id + * @return $this + */ + public function setPaymentGatewayAccountId($payment_gateway_account_id) + { + $this->container['payment_gateway_account_id'] = $payment_gateway_account_id; + + return $this; + } + + /** + * Gets payment_gateway_display_name + * @return string + */ + public function getPaymentGatewayDisplayName() + { + return $this->container['payment_gateway_display_name']; + } + + /** + * Sets payment_gateway_display_name + * @param string $payment_gateway_display_name + * @return $this + */ + public function setPaymentGatewayDisplayName($payment_gateway_display_name) + { + $this->container['payment_gateway_display_name'] = $payment_gateway_display_name; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/PaymentGatewayAccountsInfo.php b/src/Model/PaymentGatewayAccountsInfo.php new file mode 100644 index 00000000..9acfa7a9 --- /dev/null +++ b/src/Model/PaymentGatewayAccountsInfo.php @@ -0,0 +1,227 @@ + '\DocuSign\eSign\Model\PaymentGatewayAccount[]' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'payment_gateway_accounts' => 'paymentGatewayAccounts' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'payment_gateway_accounts' => 'setPaymentGatewayAccounts' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'payment_gateway_accounts' => 'getPaymentGatewayAccounts' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['payment_gateway_accounts'] = isset($data['payment_gateway_accounts']) ? $data['payment_gateway_accounts'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets payment_gateway_accounts + * @return \DocuSign\eSign\Model\PaymentGatewayAccount[] + */ + public function getPaymentGatewayAccounts() + { + return $this->container['payment_gateway_accounts']; + } + + /** + * Sets payment_gateway_accounts + * @param \DocuSign\eSign\Model\PaymentGatewayAccount[] $payment_gateway_accounts + * @return $this + */ + public function setPaymentGatewayAccounts($payment_gateway_accounts) + { + $this->container['payment_gateway_accounts'] = $payment_gateway_accounts; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/PaymentProcessorInformation.php b/src/Model/PaymentProcessorInformation.php new file mode 100644 index 00000000..ed7c95d2 --- /dev/null +++ b/src/Model/PaymentProcessorInformation.php @@ -0,0 +1,279 @@ + '\DocuSign\eSign\Model\AddressInformation', + 'billing_agreement_id' => 'string', + 'email' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'address' => 'address', + 'billing_agreement_id' => 'billingAgreementId', + 'email' => 'email' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'address' => 'setAddress', + 'billing_agreement_id' => 'setBillingAgreementId', + 'email' => 'setEmail' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'address' => 'getAddress', + 'billing_agreement_id' => 'getBillingAgreementId', + 'email' => 'getEmail' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['address'] = isset($data['address']) ? $data['address'] : null; + $this->container['billing_agreement_id'] = isset($data['billing_agreement_id']) ? $data['billing_agreement_id'] : null; + $this->container['email'] = isset($data['email']) ? $data['email'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets address + * @return \DocuSign\eSign\Model\AddressInformation + */ + public function getAddress() + { + return $this->container['address']; + } + + /** + * Sets address + * @param \DocuSign\eSign\Model\AddressInformation $address + * @return $this + */ + public function setAddress($address) + { + $this->container['address'] = $address; + + return $this; + } + + /** + * Gets billing_agreement_id + * @return string + */ + public function getBillingAgreementId() + { + return $this->container['billing_agreement_id']; + } + + /** + * Sets billing_agreement_id + * @param string $billing_agreement_id + * @return $this + */ + public function setBillingAgreementId($billing_agreement_id) + { + $this->container['billing_agreement_id'] = $billing_agreement_id; + + return $this; + } + + /** + * Gets email + * @return string + */ + public function getEmail() + { + return $this->container['email']; + } + + /** + * Sets email + * @param string $email + * @return $this + */ + public function setEmail($email) + { + $this->container['email'] = $email; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/PowerForm.php b/src/Model/PowerForm.php index f2ff39aa..b4d04d54 100644 --- a/src/Model/PowerForm.php +++ b/src/Model/PowerForm.php @@ -54,6 +54,7 @@ class PowerForm implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ + 'created_by' => 'string', 'created_date_time' => 'string', 'email_body' => 'string', 'email_subject' => 'string', @@ -90,6 +91,7 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ + 'created_by' => 'createdBy', 'created_date_time' => 'createdDateTime', 'email_body' => 'emailBody', 'email_subject' => 'emailSubject', @@ -122,6 +124,7 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ + 'created_by' => 'setCreatedBy', 'created_date_time' => 'setCreatedDateTime', 'email_body' => 'setEmailBody', 'email_subject' => 'setEmailSubject', @@ -154,6 +157,7 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ + 'created_by' => 'getCreatedBy', 'created_date_time' => 'getCreatedDateTime', 'email_body' => 'getEmailBody', 'email_subject' => 'getEmailSubject', @@ -211,6 +215,7 @@ public static function getters() */ public function __construct(array $data = null) { + $this->container['created_by'] = isset($data['created_by']) ? $data['created_by'] : null; $this->container['created_date_time'] = isset($data['created_date_time']) ? $data['created_date_time'] : null; $this->container['email_body'] = isset($data['email_body']) ? $data['email_body'] : null; $this->container['email_subject'] = isset($data['email_subject']) ? $data['email_subject'] : null; @@ -260,6 +265,27 @@ public function valid() } + /** + * Gets created_by + * @return string + */ + public function getCreatedBy() + { + return $this->container['created_by']; + } + + /** + * Sets created_by + * @param string $created_by + * @return $this + */ + public function setCreatedBy($created_by) + { + $this->container['created_by'] = $created_by; + + return $this; + } + /** * Gets created_date_time * @return string diff --git a/src/Model/PowerFormRecipient.php b/src/Model/PowerFormRecipient.php index a4376143..887f9af9 100644 --- a/src/Model/PowerFormRecipient.php +++ b/src/Model/PowerFormRecipient.php @@ -216,7 +216,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) diff --git a/src/Model/Radio.php b/src/Model/Radio.php index d0001bc9..ec5b0745 100644 --- a/src/Model/Radio.php +++ b/src/Model/Radio.php @@ -367,7 +367,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -388,7 +388,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) diff --git a/src/Model/RadioGroup.php b/src/Model/RadioGroup.php index e2a63234..6b6ab501 100644 --- a/src/Model/RadioGroup.php +++ b/src/Model/RadioGroup.php @@ -62,7 +62,10 @@ class RadioGroup implements ArrayAccess 'recipient_id' => 'string', 'require_all' => 'string', 'require_initial_on_shared_change' => 'string', - 'shared' => 'string' + 'shared' => 'string', + 'template_locked' => 'string', + 'template_required' => 'string', + 'tooltip' => 'string' ]; public static function swaggerTypes() @@ -83,7 +86,10 @@ public static function swaggerTypes() 'recipient_id' => 'recipientId', 'require_all' => 'requireAll', 'require_initial_on_shared_change' => 'requireInitialOnSharedChange', - 'shared' => 'shared' + 'shared' => 'shared', + 'template_locked' => 'templateLocked', + 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip' ]; @@ -100,7 +106,10 @@ public static function swaggerTypes() 'recipient_id' => 'setRecipientId', 'require_all' => 'setRequireAll', 'require_initial_on_shared_change' => 'setRequireInitialOnSharedChange', - 'shared' => 'setShared' + 'shared' => 'setShared', + 'template_locked' => 'setTemplateLocked', + 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip' ]; @@ -117,7 +126,10 @@ public static function swaggerTypes() 'recipient_id' => 'getRecipientId', 'require_all' => 'getRequireAll', 'require_initial_on_shared_change' => 'getRequireInitialOnSharedChange', - 'shared' => 'getShared' + 'shared' => 'getShared', + 'template_locked' => 'getTemplateLocked', + 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip' ]; public static function attributeMap() @@ -160,6 +172,9 @@ public function __construct(array $data = null) $this->container['require_all'] = isset($data['require_all']) ? $data['require_all'] : null; $this->container['require_initial_on_shared_change'] = isset($data['require_initial_on_shared_change']) ? $data['require_initial_on_shared_change'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; + $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; + $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; } /** @@ -373,6 +388,69 @@ public function setShared($shared) return $this; } + + /** + * Gets template_locked + * @return string + */ + public function getTemplateLocked() + { + return $this->container['template_locked']; + } + + /** + * Sets template_locked + * @param string $template_locked When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + * @return $this + */ + public function setTemplateLocked($template_locked) + { + $this->container['template_locked'] = $template_locked; + + return $this; + } + + /** + * Gets template_required + * @return string + */ + public function getTemplateRequired() + { + return $this->container['template_required']; + } + + /** + * Sets template_required + * @param string $template_required When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + * @return $this + */ + public function setTemplateRequired($template_required) + { + $this->container['template_required'] = $template_required; + + return $this; + } + + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/src/Model/RecipientSignatureProvider.php b/src/Model/RecipientSignatureProvider.php index 1c357e1e..e6ad032a 100644 --- a/src/Model/RecipientSignatureProvider.php +++ b/src/Model/RecipientSignatureProvider.php @@ -54,6 +54,8 @@ class RecipientSignatureProvider implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ + 'seal_documents_with_tabs_only' => 'string', + 'seal_name' => 'string', 'signature_provider_name' => 'string', 'signature_provider_options' => '\DocuSign\eSign\Model\RecipientSignatureProviderOptions' ]; @@ -68,6 +70,8 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ + 'seal_documents_with_tabs_only' => 'sealDocumentsWithTabsOnly', + 'seal_name' => 'sealName', 'signature_provider_name' => 'signatureProviderName', 'signature_provider_options' => 'signatureProviderOptions' ]; @@ -78,6 +82,8 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ + 'seal_documents_with_tabs_only' => 'setSealDocumentsWithTabsOnly', + 'seal_name' => 'setSealName', 'signature_provider_name' => 'setSignatureProviderName', 'signature_provider_options' => 'setSignatureProviderOptions' ]; @@ -88,6 +94,8 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ + 'seal_documents_with_tabs_only' => 'getSealDocumentsWithTabsOnly', + 'seal_name' => 'getSealName', 'signature_provider_name' => 'getSignatureProviderName', 'signature_provider_options' => 'getSignatureProviderOptions' ]; @@ -123,6 +131,8 @@ public static function getters() */ public function __construct(array $data = null) { + $this->container['seal_documents_with_tabs_only'] = isset($data['seal_documents_with_tabs_only']) ? $data['seal_documents_with_tabs_only'] : null; + $this->container['seal_name'] = isset($data['seal_name']) ? $data['seal_name'] : null; $this->container['signature_provider_name'] = isset($data['signature_provider_name']) ? $data['signature_provider_name'] : null; $this->container['signature_provider_options'] = isset($data['signature_provider_options']) ? $data['signature_provider_options'] : null; } @@ -150,6 +160,48 @@ public function valid() } + /** + * Gets seal_documents_with_tabs_only + * @return string + */ + public function getSealDocumentsWithTabsOnly() + { + return $this->container['seal_documents_with_tabs_only']; + } + + /** + * Sets seal_documents_with_tabs_only + * @param string $seal_documents_with_tabs_only + * @return $this + */ + public function setSealDocumentsWithTabsOnly($seal_documents_with_tabs_only) + { + $this->container['seal_documents_with_tabs_only'] = $seal_documents_with_tabs_only; + + return $this; + } + + /** + * Gets seal_name + * @return string + */ + public function getSealName() + { + return $this->container['seal_name']; + } + + /** + * Sets seal_name + * @param string $seal_name + * @return $this + */ + public function setSealName($seal_name) + { + $this->container['seal_name'] = $seal_name; + + return $this; + } + /** * Gets signature_provider_name * @return string diff --git a/src/Model/Recipients.php b/src/Model/Recipients.php index 23571df2..729d4193 100644 --- a/src/Model/Recipients.php +++ b/src/Model/Recipients.php @@ -64,7 +64,9 @@ class Recipients implements ArrayAccess 'in_person_signers' => '\DocuSign\eSign\Model\InPersonSigner[]', 'intermediaries' => '\DocuSign\eSign\Model\Intermediary[]', 'recipient_count' => 'string', - 'signers' => '\DocuSign\eSign\Model\Signer[]' + 'seals' => '\DocuSign\eSign\Model\SealSign[]', + 'signers' => '\DocuSign\eSign\Model\Signer[]', + 'witnesses' => '\DocuSign\eSign\Model\Witness[]' ]; public static function swaggerTypes() @@ -86,7 +88,9 @@ public static function swaggerTypes() 'in_person_signers' => 'inPersonSigners', 'intermediaries' => 'intermediaries', 'recipient_count' => 'recipientCount', - 'signers' => 'signers' + 'seals' => 'seals', + 'signers' => 'signers', + 'witnesses' => 'witnesses' ]; @@ -104,7 +108,9 @@ public static function swaggerTypes() 'in_person_signers' => 'setInPersonSigners', 'intermediaries' => 'setIntermediaries', 'recipient_count' => 'setRecipientCount', - 'signers' => 'setSigners' + 'seals' => 'setSeals', + 'signers' => 'setSigners', + 'witnesses' => 'setWitnesses' ]; @@ -122,7 +128,9 @@ public static function swaggerTypes() 'in_person_signers' => 'getInPersonSigners', 'intermediaries' => 'getIntermediaries', 'recipient_count' => 'getRecipientCount', - 'signers' => 'getSigners' + 'seals' => 'getSeals', + 'signers' => 'getSigners', + 'witnesses' => 'getWitnesses' ]; public static function attributeMap() @@ -165,7 +173,9 @@ public function __construct(array $data = null) $this->container['in_person_signers'] = isset($data['in_person_signers']) ? $data['in_person_signers'] : null; $this->container['intermediaries'] = isset($data['intermediaries']) ? $data['intermediaries'] : null; $this->container['recipient_count'] = isset($data['recipient_count']) ? $data['recipient_count'] : null; + $this->container['seals'] = isset($data['seals']) ? $data['seals'] : null; $this->container['signers'] = isset($data['signers']) ? $data['signers'] : null; + $this->container['witnesses'] = isset($data['witnesses']) ? $data['witnesses'] : null; } /** @@ -380,6 +390,27 @@ public function setRecipientCount($recipient_count) return $this; } + /** + * Gets seals + * @return \DocuSign\eSign\Model\SealSign[] + */ + public function getSeals() + { + return $this->container['seals']; + } + + /** + * Sets seals + * @param \DocuSign\eSign\Model\SealSign[] $seals + * @return $this + */ + public function setSeals($seals) + { + $this->container['seals'] = $seals; + + return $this; + } + /** * Gets signers * @return \DocuSign\eSign\Model\Signer[] @@ -400,6 +431,27 @@ public function setSigners($signers) return $this; } + + /** + * Gets witnesses + * @return \DocuSign\eSign\Model\Witness[] + */ + public function getWitnesses() + { + return $this->container['witnesses']; + } + + /** + * Sets witnesses + * @param \DocuSign\eSign\Model\Witness[] $witnesses + * @return $this + */ + public function setWitnesses($witnesses) + { + $this->container['witnesses'] = $witnesses; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/src/Model/Revision.php b/src/Model/Revision.php new file mode 100644 index 00000000..fd218530 --- /dev/null +++ b/src/Model/Revision.php @@ -0,0 +1,331 @@ + 'string', + 'field_name' => 'string', + 'max_signature_length' => 'string', + 'signature_type' => 'string', + 'start_data' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'end_data' => 'endData', + 'field_name' => 'fieldName', + 'max_signature_length' => 'maxSignatureLength', + 'signature_type' => 'signatureType', + 'start_data' => 'startData' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'end_data' => 'setEndData', + 'field_name' => 'setFieldName', + 'max_signature_length' => 'setMaxSignatureLength', + 'signature_type' => 'setSignatureType', + 'start_data' => 'setStartData' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'end_data' => 'getEndData', + 'field_name' => 'getFieldName', + 'max_signature_length' => 'getMaxSignatureLength', + 'signature_type' => 'getSignatureType', + 'start_data' => 'getStartData' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['end_data'] = isset($data['end_data']) ? $data['end_data'] : null; + $this->container['field_name'] = isset($data['field_name']) ? $data['field_name'] : null; + $this->container['max_signature_length'] = isset($data['max_signature_length']) ? $data['max_signature_length'] : null; + $this->container['signature_type'] = isset($data['signature_type']) ? $data['signature_type'] : null; + $this->container['start_data'] = isset($data['start_data']) ? $data['start_data'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets end_data + * @return string + */ + public function getEndData() + { + return $this->container['end_data']; + } + + /** + * Sets end_data + * @param string $end_data + * @return $this + */ + public function setEndData($end_data) + { + $this->container['end_data'] = $end_data; + + return $this; + } + + /** + * Gets field_name + * @return string + */ + public function getFieldName() + { + return $this->container['field_name']; + } + + /** + * Sets field_name + * @param string $field_name + * @return $this + */ + public function setFieldName($field_name) + { + $this->container['field_name'] = $field_name; + + return $this; + } + + /** + * Gets max_signature_length + * @return string + */ + public function getMaxSignatureLength() + { + return $this->container['max_signature_length']; + } + + /** + * Sets max_signature_length + * @param string $max_signature_length + * @return $this + */ + public function setMaxSignatureLength($max_signature_length) + { + $this->container['max_signature_length'] = $max_signature_length; + + return $this; + } + + /** + * Gets signature_type + * @return string + */ + public function getSignatureType() + { + return $this->container['signature_type']; + } + + /** + * Sets signature_type + * @param string $signature_type + * @return $this + */ + public function setSignatureType($signature_type) + { + $this->container['signature_type'] = $signature_type; + + return $this; + } + + /** + * Gets start_data + * @return string + */ + public function getStartData() + { + return $this->container['start_data']; + } + + /** + * Sets start_data + * @param string $start_data + * @return $this + */ + public function setStartData($start_data) + { + $this->container['start_data'] = $start_data; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Seal.php b/src/Model/Seal.php new file mode 100644 index 00000000..2d4bfb04 --- /dev/null +++ b/src/Model/Seal.php @@ -0,0 +1,253 @@ + 'map[string,string]', + 'seal_identifier' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'configuration' => 'configuration', + 'seal_identifier' => 'sealIdentifier' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'configuration' => 'setConfiguration', + 'seal_identifier' => 'setSealIdentifier' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'configuration' => 'getConfiguration', + 'seal_identifier' => 'getSealIdentifier' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['configuration'] = isset($data['configuration']) ? $data['configuration'] : null; + $this->container['seal_identifier'] = isset($data['seal_identifier']) ? $data['seal_identifier'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets configuration + * @return map[string,string] + */ + public function getConfiguration() + { + return $this->container['configuration']; + } + + /** + * Sets configuration + * @param map[string,string] $configuration + * @return $this + */ + public function setConfiguration($configuration) + { + $this->container['configuration'] = $configuration; + + return $this; + } + + /** + * Gets seal_identifier + * @return string + */ + public function getSealIdentifier() + { + return $this->container['seal_identifier']; + } + + /** + * Sets seal_identifier + * @param string $seal_identifier + * @return $this + */ + public function setSealIdentifier($seal_identifier) + { + $this->container['seal_identifier'] = $seal_identifier; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/SealIdentifier.php b/src/Model/SealIdentifier.php new file mode 100644 index 00000000..17935413 --- /dev/null +++ b/src/Model/SealIdentifier.php @@ -0,0 +1,253 @@ + 'string', + 'seal_name' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'seal_display_name' => 'sealDisplayName', + 'seal_name' => 'sealName' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'seal_display_name' => 'setSealDisplayName', + 'seal_name' => 'setSealName' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'seal_display_name' => 'getSealDisplayName', + 'seal_name' => 'getSealName' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['seal_display_name'] = isset($data['seal_display_name']) ? $data['seal_display_name'] : null; + $this->container['seal_name'] = isset($data['seal_name']) ? $data['seal_name'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets seal_display_name + * @return string + */ + public function getSealDisplayName() + { + return $this->container['seal_display_name']; + } + + /** + * Sets seal_display_name + * @param string $seal_display_name + * @return $this + */ + public function setSealDisplayName($seal_display_name) + { + $this->container['seal_display_name'] = $seal_display_name; + + return $this; + } + + /** + * Gets seal_name + * @return string + */ + public function getSealName() + { + return $this->container['seal_name']; + } + + /** + * Sets seal_name + * @param string $seal_name + * @return $this + */ + public function setSealName($seal_name) + { + $this->container['seal_name'] = $seal_name; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/SealSign.php b/src/Model/SealSign.php new file mode 100644 index 00000000..4b88eb7d --- /dev/null +++ b/src/Model/SealSign.php @@ -0,0 +1,1189 @@ + 'string', + 'add_access_code_to_email' => 'string', + 'client_user_id' => 'string', + 'custom_fields' => 'string[]', + 'declined_date_time' => 'string', + 'declined_reason' => 'string', + 'delivered_date_time' => 'string', + 'delivery_method' => 'string', + 'document_visibility' => '\DocuSign\eSign\Model\DocumentVisibility[]', + 'email_notification' => '\DocuSign\eSign\Model\RecipientEmailNotification', + 'embedded_recipient_start_url' => 'string', + 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', + 'fax_number' => 'string', + 'id_check_configuration_name' => 'string', + 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'inherit_email_notification_configuration' => 'string', + 'name' => 'string', + 'note' => 'string', + 'phone_authentication' => '\DocuSign\eSign\Model\RecipientPhoneAuthentication', + 'recipient_attachments' => '\DocuSign\eSign\Model\RecipientAttachment[]', + 'recipient_authentication_status' => '\DocuSign\eSign\Model\AuthenticationStatus', + 'recipient_id' => 'string', + 'recipient_id_guid' => 'string', + 'recipient_signature_providers' => '\DocuSign\eSign\Model\RecipientSignatureProvider[]', + 'require_id_lookup' => 'string', + 'role_name' => 'string', + 'routing_order' => 'string', + 'saml_authentication' => '\DocuSign\eSign\Model\RecipientSAMLAuthentication', + 'sent_date_time' => 'string', + 'signed_date_time' => 'string', + 'sms_authentication' => '\DocuSign\eSign\Model\RecipientSMSAuthentication', + 'social_authentications' => '\DocuSign\eSign\Model\SocialAuthentication[]', + 'status' => 'string', + 'tabs' => '\DocuSign\eSign\Model\Tabs', + 'template_locked' => 'string', + 'template_required' => 'string', + 'total_tab_count' => 'string', + 'user_id' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'access_code' => 'accessCode', + 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'client_user_id' => 'clientUserId', + 'custom_fields' => 'customFields', + 'declined_date_time' => 'declinedDateTime', + 'declined_reason' => 'declinedReason', + 'delivered_date_time' => 'deliveredDateTime', + 'delivery_method' => 'deliveryMethod', + 'document_visibility' => 'documentVisibility', + 'email_notification' => 'emailNotification', + 'embedded_recipient_start_url' => 'embeddedRecipientStartURL', + 'error_details' => 'errorDetails', + 'fax_number' => 'faxNumber', + 'id_check_configuration_name' => 'idCheckConfigurationName', + 'id_check_information_input' => 'idCheckInformationInput', + 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', + 'name' => 'name', + 'note' => 'note', + 'phone_authentication' => 'phoneAuthentication', + 'recipient_attachments' => 'recipientAttachments', + 'recipient_authentication_status' => 'recipientAuthenticationStatus', + 'recipient_id' => 'recipientId', + 'recipient_id_guid' => 'recipientIdGuid', + 'recipient_signature_providers' => 'recipientSignatureProviders', + 'require_id_lookup' => 'requireIdLookup', + 'role_name' => 'roleName', + 'routing_order' => 'routingOrder', + 'saml_authentication' => 'samlAuthentication', + 'sent_date_time' => 'sentDateTime', + 'signed_date_time' => 'signedDateTime', + 'sms_authentication' => 'smsAuthentication', + 'social_authentications' => 'socialAuthentications', + 'status' => 'status', + 'tabs' => 'tabs', + 'template_locked' => 'templateLocked', + 'template_required' => 'templateRequired', + 'total_tab_count' => 'totalTabCount', + 'user_id' => 'userId' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'access_code' => 'setAccessCode', + 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'client_user_id' => 'setClientUserId', + 'custom_fields' => 'setCustomFields', + 'declined_date_time' => 'setDeclinedDateTime', + 'declined_reason' => 'setDeclinedReason', + 'delivered_date_time' => 'setDeliveredDateTime', + 'delivery_method' => 'setDeliveryMethod', + 'document_visibility' => 'setDocumentVisibility', + 'email_notification' => 'setEmailNotification', + 'embedded_recipient_start_url' => 'setEmbeddedRecipientStartUrl', + 'error_details' => 'setErrorDetails', + 'fax_number' => 'setFaxNumber', + 'id_check_configuration_name' => 'setIdCheckConfigurationName', + 'id_check_information_input' => 'setIdCheckInformationInput', + 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', + 'name' => 'setName', + 'note' => 'setNote', + 'phone_authentication' => 'setPhoneAuthentication', + 'recipient_attachments' => 'setRecipientAttachments', + 'recipient_authentication_status' => 'setRecipientAuthenticationStatus', + 'recipient_id' => 'setRecipientId', + 'recipient_id_guid' => 'setRecipientIdGuid', + 'recipient_signature_providers' => 'setRecipientSignatureProviders', + 'require_id_lookup' => 'setRequireIdLookup', + 'role_name' => 'setRoleName', + 'routing_order' => 'setRoutingOrder', + 'saml_authentication' => 'setSamlAuthentication', + 'sent_date_time' => 'setSentDateTime', + 'signed_date_time' => 'setSignedDateTime', + 'sms_authentication' => 'setSmsAuthentication', + 'social_authentications' => 'setSocialAuthentications', + 'status' => 'setStatus', + 'tabs' => 'setTabs', + 'template_locked' => 'setTemplateLocked', + 'template_required' => 'setTemplateRequired', + 'total_tab_count' => 'setTotalTabCount', + 'user_id' => 'setUserId' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'access_code' => 'getAccessCode', + 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'client_user_id' => 'getClientUserId', + 'custom_fields' => 'getCustomFields', + 'declined_date_time' => 'getDeclinedDateTime', + 'declined_reason' => 'getDeclinedReason', + 'delivered_date_time' => 'getDeliveredDateTime', + 'delivery_method' => 'getDeliveryMethod', + 'document_visibility' => 'getDocumentVisibility', + 'email_notification' => 'getEmailNotification', + 'embedded_recipient_start_url' => 'getEmbeddedRecipientStartUrl', + 'error_details' => 'getErrorDetails', + 'fax_number' => 'getFaxNumber', + 'id_check_configuration_name' => 'getIdCheckConfigurationName', + 'id_check_information_input' => 'getIdCheckInformationInput', + 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', + 'name' => 'getName', + 'note' => 'getNote', + 'phone_authentication' => 'getPhoneAuthentication', + 'recipient_attachments' => 'getRecipientAttachments', + 'recipient_authentication_status' => 'getRecipientAuthenticationStatus', + 'recipient_id' => 'getRecipientId', + 'recipient_id_guid' => 'getRecipientIdGuid', + 'recipient_signature_providers' => 'getRecipientSignatureProviders', + 'require_id_lookup' => 'getRequireIdLookup', + 'role_name' => 'getRoleName', + 'routing_order' => 'getRoutingOrder', + 'saml_authentication' => 'getSamlAuthentication', + 'sent_date_time' => 'getSentDateTime', + 'signed_date_time' => 'getSignedDateTime', + 'sms_authentication' => 'getSmsAuthentication', + 'social_authentications' => 'getSocialAuthentications', + 'status' => 'getStatus', + 'tabs' => 'getTabs', + 'template_locked' => 'getTemplateLocked', + 'template_required' => 'getTemplateRequired', + 'total_tab_count' => 'getTotalTabCount', + 'user_id' => 'getUserId' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['access_code'] = isset($data['access_code']) ? $data['access_code'] : null; + $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['client_user_id'] = isset($data['client_user_id']) ? $data['client_user_id'] : null; + $this->container['custom_fields'] = isset($data['custom_fields']) ? $data['custom_fields'] : null; + $this->container['declined_date_time'] = isset($data['declined_date_time']) ? $data['declined_date_time'] : null; + $this->container['declined_reason'] = isset($data['declined_reason']) ? $data['declined_reason'] : null; + $this->container['delivered_date_time'] = isset($data['delivered_date_time']) ? $data['delivered_date_time'] : null; + $this->container['delivery_method'] = isset($data['delivery_method']) ? $data['delivery_method'] : null; + $this->container['document_visibility'] = isset($data['document_visibility']) ? $data['document_visibility'] : null; + $this->container['email_notification'] = isset($data['email_notification']) ? $data['email_notification'] : null; + $this->container['embedded_recipient_start_url'] = isset($data['embedded_recipient_start_url']) ? $data['embedded_recipient_start_url'] : null; + $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; + $this->container['fax_number'] = isset($data['fax_number']) ? $data['fax_number'] : null; + $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; + $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['note'] = isset($data['note']) ? $data['note'] : null; + $this->container['phone_authentication'] = isset($data['phone_authentication']) ? $data['phone_authentication'] : null; + $this->container['recipient_attachments'] = isset($data['recipient_attachments']) ? $data['recipient_attachments'] : null; + $this->container['recipient_authentication_status'] = isset($data['recipient_authentication_status']) ? $data['recipient_authentication_status'] : null; + $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; + $this->container['recipient_id_guid'] = isset($data['recipient_id_guid']) ? $data['recipient_id_guid'] : null; + $this->container['recipient_signature_providers'] = isset($data['recipient_signature_providers']) ? $data['recipient_signature_providers'] : null; + $this->container['require_id_lookup'] = isset($data['require_id_lookup']) ? $data['require_id_lookup'] : null; + $this->container['role_name'] = isset($data['role_name']) ? $data['role_name'] : null; + $this->container['routing_order'] = isset($data['routing_order']) ? $data['routing_order'] : null; + $this->container['saml_authentication'] = isset($data['saml_authentication']) ? $data['saml_authentication'] : null; + $this->container['sent_date_time'] = isset($data['sent_date_time']) ? $data['sent_date_time'] : null; + $this->container['signed_date_time'] = isset($data['signed_date_time']) ? $data['signed_date_time'] : null; + $this->container['sms_authentication'] = isset($data['sms_authentication']) ? $data['sms_authentication'] : null; + $this->container['social_authentications'] = isset($data['social_authentications']) ? $data['social_authentications'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tabs'] = isset($data['tabs']) ? $data['tabs'] : null; + $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; + $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['total_tab_count'] = isset($data['total_tab_count']) ? $data['total_tab_count'] : null; + $this->container['user_id'] = isset($data['user_id']) ? $data['user_id'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets access_code + * @return string + */ + public function getAccessCode() + { + return $this->container['access_code']; + } + + /** + * Sets access_code + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @return $this + */ + public function setAccessCode($access_code) + { + $this->container['access_code'] = $access_code; + + return $this; + } + + /** + * Gets add_access_code_to_email + * @return string + */ + public function getAddAccessCodeToEmail() + { + return $this->container['add_access_code_to_email']; + } + + /** + * Sets add_access_code_to_email + * @param string $add_access_code_to_email This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. + * @return $this + */ + public function setAddAccessCodeToEmail($add_access_code_to_email) + { + $this->container['add_access_code_to_email'] = $add_access_code_to_email; + + return $this; + } + + /** + * Gets client_user_id + * @return string + */ + public function getClientUserId() + { + return $this->container['client_user_id']; + } + + /** + * Sets client_user_id + * @param string $client_user_id Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. + * @return $this + */ + public function setClientUserId($client_user_id) + { + $this->container['client_user_id'] = $client_user_id; + + return $this; + } + + /** + * Gets custom_fields + * @return string[] + */ + public function getCustomFields() + { + return $this->container['custom_fields']; + } + + /** + * Sets custom_fields + * @param string[] $custom_fields An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. + * @return $this + */ + public function setCustomFields($custom_fields) + { + $this->container['custom_fields'] = $custom_fields; + + return $this; + } + + /** + * Gets declined_date_time + * @return string + */ + public function getDeclinedDateTime() + { + return $this->container['declined_date_time']; + } + + /** + * Sets declined_date_time + * @param string $declined_date_time The date and time the recipient declined the document. + * @return $this + */ + public function setDeclinedDateTime($declined_date_time) + { + $this->container['declined_date_time'] = $declined_date_time; + + return $this; + } + + /** + * Gets declined_reason + * @return string + */ + public function getDeclinedReason() + { + return $this->container['declined_reason']; + } + + /** + * Sets declined_reason + * @param string $declined_reason The reason the recipient declined the document. + * @return $this + */ + public function setDeclinedReason($declined_reason) + { + $this->container['declined_reason'] = $declined_reason; + + return $this; + } + + /** + * Gets delivered_date_time + * @return string + */ + public function getDeliveredDateTime() + { + return $this->container['delivered_date_time']; + } + + /** + * Sets delivered_date_time + * @param string $delivered_date_time Reserved: For DocuSign use only. + * @return $this + */ + public function setDeliveredDateTime($delivered_date_time) + { + $this->container['delivered_date_time'] = $delivered_date_time; + + return $this; + } + + /** + * Gets delivery_method + * @return string + */ + public function getDeliveryMethod() + { + return $this->container['delivery_method']; + } + + /** + * Sets delivery_method + * @param string $delivery_method Reserved: For DocuSign use only. + * @return $this + */ + public function setDeliveryMethod($delivery_method) + { + $this->container['delivery_method'] = $delivery_method; + + return $this; + } + + /** + * Gets document_visibility + * @return \DocuSign\eSign\Model\DocumentVisibility[] + */ + public function getDocumentVisibility() + { + return $this->container['document_visibility']; + } + + /** + * Sets document_visibility + * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * @return $this + */ + public function setDocumentVisibility($document_visibility) + { + $this->container['document_visibility'] = $document_visibility; + + return $this; + } + + /** + * Gets email_notification + * @return \DocuSign\eSign\Model\RecipientEmailNotification + */ + public function getEmailNotification() + { + return $this->container['email_notification']; + } + + /** + * Sets email_notification + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * @return $this + */ + public function setEmailNotification($email_notification) + { + $this->container['email_notification'] = $email_notification; + + return $this; + } + + /** + * Gets embedded_recipient_start_url + * @return string + */ + public function getEmbeddedRecipientStartUrl() + { + return $this->container['embedded_recipient_start_url']; + } + + /** + * Sets embedded_recipient_start_url + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @return $this + */ + public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) + { + $this->container['embedded_recipient_start_url'] = $embedded_recipient_start_url; + + return $this; + } + + /** + * Gets error_details + * @return \DocuSign\eSign\Model\ErrorDetails + */ + public function getErrorDetails() + { + return $this->container['error_details']; + } + + /** + * Sets error_details + * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * @return $this + */ + public function setErrorDetails($error_details) + { + $this->container['error_details'] = $error_details; + + return $this; + } + + /** + * Gets fax_number + * @return string + */ + public function getFaxNumber() + { + return $this->container['fax_number']; + } + + /** + * Sets fax_number + * @param string $fax_number Reserved: + * @return $this + */ + public function setFaxNumber($fax_number) + { + $this->container['fax_number'] = $fax_number; + + return $this; + } + + /** + * Gets id_check_configuration_name + * @return string + */ + public function getIdCheckConfigurationName() + { + return $this->container['id_check_configuration_name']; + } + + /** + * Sets id_check_configuration_name + * @param string $id_check_configuration_name Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. + * @return $this + */ + public function setIdCheckConfigurationName($id_check_configuration_name) + { + $this->container['id_check_configuration_name'] = $id_check_configuration_name; + + return $this; + } + + /** + * Gets id_check_information_input + * @return \DocuSign\eSign\Model\IdCheckInformationInput + */ + public function getIdCheckInformationInput() + { + return $this->container['id_check_information_input']; + } + + /** + * Sets id_check_information_input + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * @return $this + */ + public function setIdCheckInformationInput($id_check_information_input) + { + $this->container['id_check_information_input'] = $id_check_information_input; + + return $this; + } + + /** + * Gets inherit_email_notification_configuration + * @return string + */ + public function getInheritEmailNotificationConfiguration() + { + return $this->container['inherit_email_notification_configuration']; + } + + /** + * Sets inherit_email_notification_configuration + * @param string $inherit_email_notification_configuration When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. + * @return $this + */ + public function setInheritEmailNotificationConfiguration($inherit_email_notification_configuration) + { + $this->container['inherit_email_notification_configuration'] = $inherit_email_notification_configuration; + + return $this; + } + + /** + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + + /** + * Gets note + * @return string + */ + public function getNote() + { + return $this->container['note']; + } + + /** + * Sets note + * @param string $note Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. + * @return $this + */ + public function setNote($note) + { + $this->container['note'] = $note; + + return $this; + } + + /** + * Gets phone_authentication + * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication + */ + public function getPhoneAuthentication() + { + return $this->container['phone_authentication']; + } + + /** + * Sets phone_authentication + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * @return $this + */ + public function setPhoneAuthentication($phone_authentication) + { + $this->container['phone_authentication'] = $phone_authentication; + + return $this; + } + + /** + * Gets recipient_attachments + * @return \DocuSign\eSign\Model\RecipientAttachment[] + */ + public function getRecipientAttachments() + { + return $this->container['recipient_attachments']; + } + + /** + * Sets recipient_attachments + * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * @return $this + */ + public function setRecipientAttachments($recipient_attachments) + { + $this->container['recipient_attachments'] = $recipient_attachments; + + return $this; + } + + /** + * Gets recipient_authentication_status + * @return \DocuSign\eSign\Model\AuthenticationStatus + */ + public function getRecipientAuthenticationStatus() + { + return $this->container['recipient_authentication_status']; + } + + /** + * Sets recipient_authentication_status + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * @return $this + */ + public function setRecipientAuthenticationStatus($recipient_authentication_status) + { + $this->container['recipient_authentication_status'] = $recipient_authentication_status; + + return $this; + } + + /** + * Gets recipient_id + * @return string + */ + public function getRecipientId() + { + return $this->container['recipient_id']; + } + + /** + * Sets recipient_id + * @param string $recipient_id Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + * @return $this + */ + public function setRecipientId($recipient_id) + { + $this->container['recipient_id'] = $recipient_id; + + return $this; + } + + /** + * Gets recipient_id_guid + * @return string + */ + public function getRecipientIdGuid() + { + return $this->container['recipient_id_guid']; + } + + /** + * Sets recipient_id_guid + * @param string $recipient_id_guid + * @return $this + */ + public function setRecipientIdGuid($recipient_id_guid) + { + $this->container['recipient_id_guid'] = $recipient_id_guid; + + return $this; + } + + /** + * Gets recipient_signature_providers + * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] + */ + public function getRecipientSignatureProviders() + { + return $this->container['recipient_signature_providers']; + } + + /** + * Sets recipient_signature_providers + * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * @return $this + */ + public function setRecipientSignatureProviders($recipient_signature_providers) + { + $this->container['recipient_signature_providers'] = $recipient_signature_providers; + + return $this; + } + + /** + * Gets require_id_lookup + * @return string + */ + public function getRequireIdLookup() + { + return $this->container['require_id_lookup']; + } + + /** + * Sets require_id_lookup + * @param string $require_id_lookup When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. + * @return $this + */ + public function setRequireIdLookup($require_id_lookup) + { + $this->container['require_id_lookup'] = $require_id_lookup; + + return $this; + } + + /** + * Gets role_name + * @return string + */ + public function getRoleName() + { + return $this->container['role_name']; + } + + /** + * Sets role_name + * @param string $role_name Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + * @return $this + */ + public function setRoleName($role_name) + { + $this->container['role_name'] = $role_name; + + return $this; + } + + /** + * Gets routing_order + * @return string + */ + public function getRoutingOrder() + { + return $this->container['routing_order']; + } + + /** + * Sets routing_order + * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * @return $this + */ + public function setRoutingOrder($routing_order) + { + $this->container['routing_order'] = $routing_order; + + return $this; + } + + /** + * Gets saml_authentication + * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication + */ + public function getSamlAuthentication() + { + return $this->container['saml_authentication']; + } + + /** + * Sets saml_authentication + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * @return $this + */ + public function setSamlAuthentication($saml_authentication) + { + $this->container['saml_authentication'] = $saml_authentication; + + return $this; + } + + /** + * Gets sent_date_time + * @return string + */ + public function getSentDateTime() + { + return $this->container['sent_date_time']; + } + + /** + * Sets sent_date_time + * @param string $sent_date_time The date and time the envelope was sent. + * @return $this + */ + public function setSentDateTime($sent_date_time) + { + $this->container['sent_date_time'] = $sent_date_time; + + return $this; + } + + /** + * Gets signed_date_time + * @return string + */ + public function getSignedDateTime() + { + return $this->container['signed_date_time']; + } + + /** + * Sets signed_date_time + * @param string $signed_date_time Reserved: For DocuSign use only. + * @return $this + */ + public function setSignedDateTime($signed_date_time) + { + $this->container['signed_date_time'] = $signed_date_time; + + return $this; + } + + /** + * Gets sms_authentication + * @return \DocuSign\eSign\Model\RecipientSMSAuthentication + */ + public function getSmsAuthentication() + { + return $this->container['sms_authentication']; + } + + /** + * Sets sms_authentication + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * @return $this + */ + public function setSmsAuthentication($sms_authentication) + { + $this->container['sms_authentication'] = $sms_authentication; + + return $this; + } + + /** + * Gets social_authentications + * @return \DocuSign\eSign\Model\SocialAuthentication[] + */ + public function getSocialAuthentications() + { + return $this->container['social_authentications']; + } + + /** + * Sets social_authentications + * @param \DocuSign\eSign\Model\SocialAuthentication[] $social_authentications Lists the social ID type that can be used for recipient authentication. + * @return $this + */ + public function setSocialAuthentications($social_authentications) + { + $this->container['social_authentications'] = $social_authentications; + + return $this; + } + + /** + * Gets status + * @return string + */ + public function getStatus() + { + return $this->container['status']; + } + + /** + * Sets status + * @param string $status Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. + * @return $this + */ + public function setStatus($status) + { + $this->container['status'] = $status; + + return $this; + } + + /** + * Gets tabs + * @return \DocuSign\eSign\Model\Tabs + */ + public function getTabs() + { + return $this->container['tabs']; + } + + /** + * Sets tabs + * @param \DocuSign\eSign\Model\Tabs $tabs + * @return $this + */ + public function setTabs($tabs) + { + $this->container['tabs'] = $tabs; + + return $this; + } + + /** + * Gets template_locked + * @return string + */ + public function getTemplateLocked() + { + return $this->container['template_locked']; + } + + /** + * Sets template_locked + * @param string $template_locked When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + * @return $this + */ + public function setTemplateLocked($template_locked) + { + $this->container['template_locked'] = $template_locked; + + return $this; + } + + /** + * Gets template_required + * @return string + */ + public function getTemplateRequired() + { + return $this->container['template_required']; + } + + /** + * Sets template_required + * @param string $template_required When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + * @return $this + */ + public function setTemplateRequired($template_required) + { + $this->container['template_required'] = $template_required; + + return $this; + } + + /** + * Gets total_tab_count + * @return string + */ + public function getTotalTabCount() + { + return $this->container['total_tab_count']; + } + + /** + * Sets total_tab_count + * @param string $total_tab_count + * @return $this + */ + public function setTotalTabCount($total_tab_count) + { + $this->container['total_tab_count'] = $total_tab_count; + + return $this; + } + + /** + * Gets user_id + * @return string + */ + public function getUserId() + { + return $this->container['user_id']; + } + + /** + * Sets user_id + * @param string $user_id + * @return $this + */ + public function setUserId($user_id) + { + $this->container['user_id'] = $user_id; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Sender.php b/src/Model/Sender.php new file mode 100644 index 00000000..a1f4a87c --- /dev/null +++ b/src/Model/Sender.php @@ -0,0 +1,253 @@ + 'string', + 'company_name' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'account_id_guid' => 'accountIdGuid', + 'company_name' => 'companyName' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'account_id_guid' => 'setAccountIdGuid', + 'company_name' => 'setCompanyName' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'account_id_guid' => 'getAccountIdGuid', + 'company_name' => 'getCompanyName' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['account_id_guid'] = isset($data['account_id_guid']) ? $data['account_id_guid'] : null; + $this->container['company_name'] = isset($data['company_name']) ? $data['company_name'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets account_id_guid + * @return string + */ + public function getAccountIdGuid() + { + return $this->container['account_id_guid']; + } + + /** + * Sets account_id_guid + * @param string $account_id_guid The GUID associated with the account ID. + * @return $this + */ + public function setAccountIdGuid($account_id_guid) + { + $this->container['account_id_guid'] = $account_id_guid; + + return $this; + } + + /** + * Gets company_name + * @return string + */ + public function getCompanyName() + { + return $this->container['company_name']; + } + + /** + * Sets company_name + * @param string $company_name + * @return $this + */ + public function setCompanyName($company_name) + { + $this->container['company_name'] = $company_name; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/SenderEmailNotifications.php b/src/Model/SenderEmailNotifications.php index cfa8fffb..7976475d 100644 --- a/src/Model/SenderEmailNotifications.php +++ b/src/Model/SenderEmailNotifications.php @@ -55,6 +55,8 @@ class SenderEmailNotifications implements ArrayAccess */ protected static $swaggerTypes = [ 'changed_signer' => 'string', + 'comments_only_private_and_mention' => 'string', + 'comments_receive_all' => 'string', 'delivery_failed' => 'string', 'envelope_complete' => 'string', 'offline_signing_failed' => 'string', @@ -74,6 +76,8 @@ public static function swaggerTypes() */ protected static $attributeMap = [ 'changed_signer' => 'changedSigner', + 'comments_only_private_and_mention' => 'commentsOnlyPrivateAndMention', + 'comments_receive_all' => 'commentsReceiveAll', 'delivery_failed' => 'deliveryFailed', 'envelope_complete' => 'envelopeComplete', 'offline_signing_failed' => 'offlineSigningFailed', @@ -89,6 +93,8 @@ public static function swaggerTypes() */ protected static $setters = [ 'changed_signer' => 'setChangedSigner', + 'comments_only_private_and_mention' => 'setCommentsOnlyPrivateAndMention', + 'comments_receive_all' => 'setCommentsReceiveAll', 'delivery_failed' => 'setDeliveryFailed', 'envelope_complete' => 'setEnvelopeComplete', 'offline_signing_failed' => 'setOfflineSigningFailed', @@ -104,6 +110,8 @@ public static function swaggerTypes() */ protected static $getters = [ 'changed_signer' => 'getChangedSigner', + 'comments_only_private_and_mention' => 'getCommentsOnlyPrivateAndMention', + 'comments_receive_all' => 'getCommentsReceiveAll', 'delivery_failed' => 'getDeliveryFailed', 'envelope_complete' => 'getEnvelopeComplete', 'offline_signing_failed' => 'getOfflineSigningFailed', @@ -144,6 +152,8 @@ public static function getters() public function __construct(array $data = null) { $this->container['changed_signer'] = isset($data['changed_signer']) ? $data['changed_signer'] : null; + $this->container['comments_only_private_and_mention'] = isset($data['comments_only_private_and_mention']) ? $data['comments_only_private_and_mention'] : null; + $this->container['comments_receive_all'] = isset($data['comments_receive_all']) ? $data['comments_receive_all'] : null; $this->container['delivery_failed'] = isset($data['delivery_failed']) ? $data['delivery_failed'] : null; $this->container['envelope_complete'] = isset($data['envelope_complete']) ? $data['envelope_complete'] : null; $this->container['offline_signing_failed'] = isset($data['offline_signing_failed']) ? $data['offline_signing_failed'] : null; @@ -196,6 +206,48 @@ public function setChangedSigner($changed_signer) return $this; } + /** + * Gets comments_only_private_and_mention + * @return string + */ + public function getCommentsOnlyPrivateAndMention() + { + return $this->container['comments_only_private_and_mention']; + } + + /** + * Sets comments_only_private_and_mention + * @param string $comments_only_private_and_mention + * @return $this + */ + public function setCommentsOnlyPrivateAndMention($comments_only_private_and_mention) + { + $this->container['comments_only_private_and_mention'] = $comments_only_private_and_mention; + + return $this; + } + + /** + * Gets comments_receive_all + * @return string + */ + public function getCommentsReceiveAll() + { + return $this->container['comments_receive_all']; + } + + /** + * Sets comments_receive_all + * @param string $comments_receive_all + * @return $this + */ + public function setCommentsReceiveAll($comments_receive_all) + { + $this->container['comments_receive_all'] = $comments_receive_all; + + return $this; + } + /** * Gets delivery_failed * @return string diff --git a/src/Model/SignHashDocument.php b/src/Model/SignHashDocument.php new file mode 100644 index 00000000..b70a5afe --- /dev/null +++ b/src/Model/SignHashDocument.php @@ -0,0 +1,383 @@ + 'string', + 'document_id' => 'string', + 'format' => 'string', + 'name' => 'string', + 'remaining_signatures' => 'string', + 'revisions' => '\DocuSign\eSign\Model\Revision[]', + 'signature_type' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'data' => 'data', + 'document_id' => 'documentId', + 'format' => 'format', + 'name' => 'name', + 'remaining_signatures' => 'remainingSignatures', + 'revisions' => 'revisions', + 'signature_type' => 'signatureType' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'data' => 'setData', + 'document_id' => 'setDocumentId', + 'format' => 'setFormat', + 'name' => 'setName', + 'remaining_signatures' => 'setRemainingSignatures', + 'revisions' => 'setRevisions', + 'signature_type' => 'setSignatureType' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'data' => 'getData', + 'document_id' => 'getDocumentId', + 'format' => 'getFormat', + 'name' => 'getName', + 'remaining_signatures' => 'getRemainingSignatures', + 'revisions' => 'getRevisions', + 'signature_type' => 'getSignatureType' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['data'] = isset($data['data']) ? $data['data'] : null; + $this->container['document_id'] = isset($data['document_id']) ? $data['document_id'] : null; + $this->container['format'] = isset($data['format']) ? $data['format'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['remaining_signatures'] = isset($data['remaining_signatures']) ? $data['remaining_signatures'] : null; + $this->container['revisions'] = isset($data['revisions']) ? $data['revisions'] : null; + $this->container['signature_type'] = isset($data['signature_type']) ? $data['signature_type'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets data + * @return string + */ + public function getData() + { + return $this->container['data']; + } + + /** + * Sets data + * @param string $data + * @return $this + */ + public function setData($data) + { + $this->container['data'] = $data; + + return $this; + } + + /** + * Gets document_id + * @return string + */ + public function getDocumentId() + { + return $this->container['document_id']; + } + + /** + * Sets document_id + * @param string $document_id Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + * @return $this + */ + public function setDocumentId($document_id) + { + $this->container['document_id'] = $document_id; + + return $this; + } + + /** + * Gets format + * @return string + */ + public function getFormat() + { + return $this->container['format']; + } + + /** + * Sets format + * @param string $format + * @return $this + */ + public function setFormat($format) + { + $this->container['format'] = $format; + + return $this; + } + + /** + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + + /** + * Gets remaining_signatures + * @return string + */ + public function getRemainingSignatures() + { + return $this->container['remaining_signatures']; + } + + /** + * Sets remaining_signatures + * @param string $remaining_signatures + * @return $this + */ + public function setRemainingSignatures($remaining_signatures) + { + $this->container['remaining_signatures'] = $remaining_signatures; + + return $this; + } + + /** + * Gets revisions + * @return \DocuSign\eSign\Model\Revision[] + */ + public function getRevisions() + { + return $this->container['revisions']; + } + + /** + * Sets revisions + * @param \DocuSign\eSign\Model\Revision[] $revisions + * @return $this + */ + public function setRevisions($revisions) + { + $this->container['revisions'] = $revisions; + + return $this; + } + + /** + * Gets signature_type + * @return string + */ + public function getSignatureType() + { + return $this->container['signature_type']; + } + + /** + * Sets signature_type + * @param string $signature_type + * @return $this + */ + public function setSignatureType($signature_type) + { + $this->container['signature_type'] = $signature_type; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/SignHashSessionInfoResponse.php b/src/Model/SignHashSessionInfoResponse.php new file mode 100644 index 00000000..45e84f40 --- /dev/null +++ b/src/Model/SignHashSessionInfoResponse.php @@ -0,0 +1,383 @@ + '\DocuSign\eSign\Model\SignHashDocument[]', + 'envelope_id' => 'string', + 'language' => 'string', + 'redirection_url' => 'string', + 'remaining_signature_requests' => 'string', + 'seal' => '\DocuSign\eSign\Model\Seal', + 'user' => '\DocuSign\eSign\Model\User' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'documents' => 'documents', + 'envelope_id' => 'envelopeId', + 'language' => 'language', + 'redirection_url' => 'redirectionUrl', + 'remaining_signature_requests' => 'remainingSignatureRequests', + 'seal' => 'seal', + 'user' => 'user' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'documents' => 'setDocuments', + 'envelope_id' => 'setEnvelopeId', + 'language' => 'setLanguage', + 'redirection_url' => 'setRedirectionUrl', + 'remaining_signature_requests' => 'setRemainingSignatureRequests', + 'seal' => 'setSeal', + 'user' => 'setUser' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'documents' => 'getDocuments', + 'envelope_id' => 'getEnvelopeId', + 'language' => 'getLanguage', + 'redirection_url' => 'getRedirectionUrl', + 'remaining_signature_requests' => 'getRemainingSignatureRequests', + 'seal' => 'getSeal', + 'user' => 'getUser' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['documents'] = isset($data['documents']) ? $data['documents'] : null; + $this->container['envelope_id'] = isset($data['envelope_id']) ? $data['envelope_id'] : null; + $this->container['language'] = isset($data['language']) ? $data['language'] : null; + $this->container['redirection_url'] = isset($data['redirection_url']) ? $data['redirection_url'] : null; + $this->container['remaining_signature_requests'] = isset($data['remaining_signature_requests']) ? $data['remaining_signature_requests'] : null; + $this->container['seal'] = isset($data['seal']) ? $data['seal'] : null; + $this->container['user'] = isset($data['user']) ? $data['user'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets documents + * @return \DocuSign\eSign\Model\SignHashDocument[] + */ + public function getDocuments() + { + return $this->container['documents']; + } + + /** + * Sets documents + * @param \DocuSign\eSign\Model\SignHashDocument[] $documents Complex element contains the details on the documents in the envelope. + * @return $this + */ + public function setDocuments($documents) + { + $this->container['documents'] = $documents; + + return $this; + } + + /** + * Gets envelope_id + * @return string + */ + public function getEnvelopeId() + { + return $this->container['envelope_id']; + } + + /** + * Sets envelope_id + * @param string $envelope_id The envelope ID of the envelope status that failed to post. + * @return $this + */ + public function setEnvelopeId($envelope_id) + { + $this->container['envelope_id'] = $envelope_id; + + return $this; + } + + /** + * Gets language + * @return string + */ + public function getLanguage() + { + return $this->container['language']; + } + + /** + * Sets language + * @param string $language + * @return $this + */ + public function setLanguage($language) + { + $this->container['language'] = $language; + + return $this; + } + + /** + * Gets redirection_url + * @return string + */ + public function getRedirectionUrl() + { + return $this->container['redirection_url']; + } + + /** + * Sets redirection_url + * @param string $redirection_url + * @return $this + */ + public function setRedirectionUrl($redirection_url) + { + $this->container['redirection_url'] = $redirection_url; + + return $this; + } + + /** + * Gets remaining_signature_requests + * @return string + */ + public function getRemainingSignatureRequests() + { + return $this->container['remaining_signature_requests']; + } + + /** + * Sets remaining_signature_requests + * @param string $remaining_signature_requests + * @return $this + */ + public function setRemainingSignatureRequests($remaining_signature_requests) + { + $this->container['remaining_signature_requests'] = $remaining_signature_requests; + + return $this; + } + + /** + * Gets seal + * @return \DocuSign\eSign\Model\Seal + */ + public function getSeal() + { + return $this->container['seal']; + } + + /** + * Sets seal + * @param \DocuSign\eSign\Model\Seal $seal + * @return $this + */ + public function setSeal($seal) + { + $this->container['seal'] = $seal; + + return $this; + } + + /** + * Gets user + * @return \DocuSign\eSign\Model\User + */ + public function getUser() + { + return $this->container['user']; + } + + /** + * Sets user + * @param \DocuSign\eSign\Model\User $user + * @return $this + */ + public function setUser($user) + { + $this->container['user'] = $user; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/SignHere.php b/src/Model/SignHere.php index 8ac776f4..04e17b9c 100644 --- a/src/Model/SignHere.php +++ b/src/Model/SignHere.php @@ -72,13 +72,17 @@ class SignHere implements ArrayAccess 'optional' => 'string', 'page_number' => 'string', 'recipient_id' => 'string', - 'scale_value' => 'Number', + 'scale_value' => 'float', + 'stamp_type' => 'string', + 'stamp_type_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'x_position' => 'string', 'y_position' => 'string' ]; @@ -112,12 +116,16 @@ public static function swaggerTypes() 'page_number' => 'pageNumber', 'recipient_id' => 'recipientId', 'scale_value' => 'scaleValue', + 'stamp_type' => 'stampType', + 'stamp_type_metadata' => 'stampTypeMetadata', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'x_position' => 'xPosition', 'y_position' => 'yPosition' ]; @@ -147,12 +155,16 @@ public static function swaggerTypes() 'page_number' => 'setPageNumber', 'recipient_id' => 'setRecipientId', 'scale_value' => 'setScaleValue', + 'stamp_type' => 'setStampType', + 'stamp_type_metadata' => 'setStampTypeMetadata', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'x_position' => 'setXPosition', 'y_position' => 'setYPosition' ]; @@ -182,12 +194,16 @@ public static function swaggerTypes() 'page_number' => 'getPageNumber', 'recipient_id' => 'getRecipientId', 'scale_value' => 'getScaleValue', + 'stamp_type' => 'getStampType', + 'stamp_type_metadata' => 'getStampTypeMetadata', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'x_position' => 'getXPosition', 'y_position' => 'getYPosition' ]; @@ -242,12 +258,16 @@ public function __construct(array $data = null) $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['scale_value'] = isset($data['scale_value']) ? $data['scale_value'] : null; + $this->container['stamp_type'] = isset($data['stamp_type']) ? $data['stamp_type'] : null; + $this->container['stamp_type_metadata'] = isset($data['stamp_type_metadata']) ? $data['stamp_type_metadata'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; } @@ -412,7 +432,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -433,7 +453,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -655,7 +675,7 @@ public function setRecipientId($recipient_id) /** * Gets scale_value - * @return Number + * @return float */ public function getScaleValue() { @@ -664,7 +684,7 @@ public function getScaleValue() /** * Sets scale_value - * @param Number $scale_value + * @param float $scale_value * @return $this */ public function setScaleValue($scale_value) @@ -674,6 +694,48 @@ public function setScaleValue($scale_value) return $this; } + /** + * Gets stamp_type + * @return string + */ + public function getStampType() + { + return $this->container['stamp_type']; + } + + /** + * Sets stamp_type + * @param string $stamp_type + * @return $this + */ + public function setStampType($stamp_type) + { + $this->container['stamp_type'] = $stamp_type; + + return $this; + } + + /** + * Gets stamp_type_metadata + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getStampTypeMetadata() + { + return $this->container['stamp_type_metadata']; + } + + /** + * Sets stamp_type_metadata + * @param \DocuSign\eSign\Model\PropertyMetadata $stamp_type_metadata + * @return $this + */ + public function setStampTypeMetadata($stamp_type_metadata) + { + $this->container['stamp_type_metadata'] = $stamp_type_metadata; + + return $this; + } + /** * Gets status * @return string @@ -695,6 +757,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -800,6 +883,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets x_position * @return string diff --git a/src/Model/SignSessionInfoRequest.php b/src/Model/SignSessionInfoRequest.php new file mode 100644 index 00000000..1cb2946f --- /dev/null +++ b/src/Model/SignSessionInfoRequest.php @@ -0,0 +1,279 @@ + 'string', + 'return_format' => 'string', + 'signing_location' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'certificate' => 'certificate', + 'return_format' => 'returnFormat', + 'signing_location' => 'signingLocation' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'certificate' => 'setCertificate', + 'return_format' => 'setReturnFormat', + 'signing_location' => 'setSigningLocation' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'certificate' => 'getCertificate', + 'return_format' => 'getReturnFormat', + 'signing_location' => 'getSigningLocation' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['certificate'] = isset($data['certificate']) ? $data['certificate'] : null; + $this->container['return_format'] = isset($data['return_format']) ? $data['return_format'] : null; + $this->container['signing_location'] = isset($data['signing_location']) ? $data['signing_location'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets certificate + * @return string + */ + public function getCertificate() + { + return $this->container['certificate']; + } + + /** + * Sets certificate + * @param string $certificate + * @return $this + */ + public function setCertificate($certificate) + { + $this->container['certificate'] = $certificate; + + return $this; + } + + /** + * Gets return_format + * @return string + */ + public function getReturnFormat() + { + return $this->container['return_format']; + } + + /** + * Sets return_format + * @param string $return_format + * @return $this + */ + public function setReturnFormat($return_format) + { + $this->container['return_format'] = $return_format; + + return $this; + } + + /** + * Gets signing_location + * @return string + */ + public function getSigningLocation() + { + return $this->container['signing_location']; + } + + /** + * Sets signing_location + * @param string $signing_location Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. + * @return $this + */ + public function setSigningLocation($signing_location) + { + $this->container['signing_location'] = $signing_location; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/SignatureDataInfo.php b/src/Model/SignatureDataInfo.php new file mode 100644 index 00000000..ddbeb176 --- /dev/null +++ b/src/Model/SignatureDataInfo.php @@ -0,0 +1,279 @@ + '\DocuSign\eSign\Model\DocumentSecurityStore', + 'signature_data' => 'string', + 'signature_field_name' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'document_security_store' => 'documentSecurityStore', + 'signature_data' => 'signatureData', + 'signature_field_name' => 'signatureFieldName' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'document_security_store' => 'setDocumentSecurityStore', + 'signature_data' => 'setSignatureData', + 'signature_field_name' => 'setSignatureFieldName' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'document_security_store' => 'getDocumentSecurityStore', + 'signature_data' => 'getSignatureData', + 'signature_field_name' => 'getSignatureFieldName' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['document_security_store'] = isset($data['document_security_store']) ? $data['document_security_store'] : null; + $this->container['signature_data'] = isset($data['signature_data']) ? $data['signature_data'] : null; + $this->container['signature_field_name'] = isset($data['signature_field_name']) ? $data['signature_field_name'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets document_security_store + * @return \DocuSign\eSign\Model\DocumentSecurityStore + */ + public function getDocumentSecurityStore() + { + return $this->container['document_security_store']; + } + + /** + * Sets document_security_store + * @param \DocuSign\eSign\Model\DocumentSecurityStore $document_security_store + * @return $this + */ + public function setDocumentSecurityStore($document_security_store) + { + $this->container['document_security_store'] = $document_security_store; + + return $this; + } + + /** + * Gets signature_data + * @return string + */ + public function getSignatureData() + { + return $this->container['signature_data']; + } + + /** + * Sets signature_data + * @param string $signature_data + * @return $this + */ + public function setSignatureData($signature_data) + { + $this->container['signature_data'] = $signature_data; + + return $this; + } + + /** + * Gets signature_field_name + * @return string + */ + public function getSignatureFieldName() + { + return $this->container['signature_field_name']; + } + + /** + * Sets signature_field_name + * @param string $signature_field_name + * @return $this + */ + public function setSignatureFieldName($signature_field_name) + { + $this->container['signature_field_name'] = $signature_field_name; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Signer.php b/src/Model/Signer.php index b7bbbdfc..d7d35fda 100644 --- a/src/Model/Signer.php +++ b/src/Model/Signer.php @@ -56,6 +56,8 @@ class Signer implements ArrayAccess protected static $swaggerTypes = [ 'access_code' => 'string', 'add_access_code_to_email' => 'string', + 'agent_can_edit_email' => 'string', + 'agent_can_edit_name' => 'string', 'auto_navigation' => 'string', 'bulk_recipients_uri' => 'string', 'can_sign_offline' => 'string', @@ -75,10 +77,13 @@ class Signer implements ArrayAccess 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', 'excluded_documents' => 'string[]', 'fax_number' => 'string', + 'first_name' => 'string', + 'full_name' => 'string', 'id_check_configuration_name' => 'string', 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', 'inherit_email_notification_configuration' => 'string', 'is_bulk_recipient' => 'string', + 'last_name' => 'string', 'name' => 'string', 'note' => 'string', 'offline_attributes' => '\DocuSign\eSign\Model\OfflineAttributes', @@ -124,6 +129,8 @@ public static function swaggerTypes() protected static $attributeMap = [ 'access_code' => 'accessCode', 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'agent_can_edit_email' => 'agentCanEditEmail', + 'agent_can_edit_name' => 'agentCanEditName', 'auto_navigation' => 'autoNavigation', 'bulk_recipients_uri' => 'bulkRecipientsUri', 'can_sign_offline' => 'canSignOffline', @@ -143,10 +150,13 @@ public static function swaggerTypes() 'error_details' => 'errorDetails', 'excluded_documents' => 'excludedDocuments', 'fax_number' => 'faxNumber', + 'first_name' => 'firstName', + 'full_name' => 'fullName', 'id_check_configuration_name' => 'idCheckConfigurationName', 'id_check_information_input' => 'idCheckInformationInput', 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', 'is_bulk_recipient' => 'isBulkRecipient', + 'last_name' => 'lastName', 'name' => 'name', 'note' => 'note', 'offline_attributes' => 'offlineAttributes', @@ -188,6 +198,8 @@ public static function swaggerTypes() protected static $setters = [ 'access_code' => 'setAccessCode', 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'agent_can_edit_email' => 'setAgentCanEditEmail', + 'agent_can_edit_name' => 'setAgentCanEditName', 'auto_navigation' => 'setAutoNavigation', 'bulk_recipients_uri' => 'setBulkRecipientsUri', 'can_sign_offline' => 'setCanSignOffline', @@ -207,10 +219,13 @@ public static function swaggerTypes() 'error_details' => 'setErrorDetails', 'excluded_documents' => 'setExcludedDocuments', 'fax_number' => 'setFaxNumber', + 'first_name' => 'setFirstName', + 'full_name' => 'setFullName', 'id_check_configuration_name' => 'setIdCheckConfigurationName', 'id_check_information_input' => 'setIdCheckInformationInput', 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', 'is_bulk_recipient' => 'setIsBulkRecipient', + 'last_name' => 'setLastName', 'name' => 'setName', 'note' => 'setNote', 'offline_attributes' => 'setOfflineAttributes', @@ -252,6 +267,8 @@ public static function swaggerTypes() protected static $getters = [ 'access_code' => 'getAccessCode', 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'agent_can_edit_email' => 'getAgentCanEditEmail', + 'agent_can_edit_name' => 'getAgentCanEditName', 'auto_navigation' => 'getAutoNavigation', 'bulk_recipients_uri' => 'getBulkRecipientsUri', 'can_sign_offline' => 'getCanSignOffline', @@ -271,10 +288,13 @@ public static function swaggerTypes() 'error_details' => 'getErrorDetails', 'excluded_documents' => 'getExcludedDocuments', 'fax_number' => 'getFaxNumber', + 'first_name' => 'getFirstName', + 'full_name' => 'getFullName', 'id_check_configuration_name' => 'getIdCheckConfigurationName', 'id_check_information_input' => 'getIdCheckInformationInput', 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', 'is_bulk_recipient' => 'getIsBulkRecipient', + 'last_name' => 'getLastName', 'name' => 'getName', 'note' => 'getNote', 'offline_attributes' => 'getOfflineAttributes', @@ -341,6 +361,8 @@ public function __construct(array $data = null) { $this->container['access_code'] = isset($data['access_code']) ? $data['access_code'] : null; $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['agent_can_edit_email'] = isset($data['agent_can_edit_email']) ? $data['agent_can_edit_email'] : null; + $this->container['agent_can_edit_name'] = isset($data['agent_can_edit_name']) ? $data['agent_can_edit_name'] : null; $this->container['auto_navigation'] = isset($data['auto_navigation']) ? $data['auto_navigation'] : null; $this->container['bulk_recipients_uri'] = isset($data['bulk_recipients_uri']) ? $data['bulk_recipients_uri'] : null; $this->container['can_sign_offline'] = isset($data['can_sign_offline']) ? $data['can_sign_offline'] : null; @@ -360,10 +382,13 @@ public function __construct(array $data = null) $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; $this->container['excluded_documents'] = isset($data['excluded_documents']) ? $data['excluded_documents'] : null; $this->container['fax_number'] = isset($data['fax_number']) ? $data['fax_number'] : null; + $this->container['first_name'] = isset($data['first_name']) ? $data['first_name'] : null; + $this->container['full_name'] = isset($data['full_name']) ? $data['full_name'] : null; $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; $this->container['is_bulk_recipient'] = isset($data['is_bulk_recipient']) ? $data['is_bulk_recipient'] : null; + $this->container['last_name'] = isset($data['last_name']) ? $data['last_name'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['note'] = isset($data['note']) ? $data['note'] : null; $this->container['offline_attributes'] = isset($data['offline_attributes']) ? $data['offline_attributes'] : null; @@ -431,7 +456,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) @@ -462,6 +487,48 @@ public function setAddAccessCodeToEmail($add_access_code_to_email) return $this; } + /** + * Gets agent_can_edit_email + * @return string + */ + public function getAgentCanEditEmail() + { + return $this->container['agent_can_edit_email']; + } + + /** + * Sets agent_can_edit_email + * @param string $agent_can_edit_email + * @return $this + */ + public function setAgentCanEditEmail($agent_can_edit_email) + { + $this->container['agent_can_edit_email'] = $agent_can_edit_email; + + return $this; + } + + /** + * Gets agent_can_edit_name + * @return string + */ + public function getAgentCanEditName() + { + return $this->container['agent_can_edit_name']; + } + + /** + * Sets agent_can_edit_name + * @param string $agent_can_edit_name + * @return $this + */ + public function setAgentCanEditName($agent_can_edit_name) + { + $this->container['agent_can_edit_name'] = $agent_can_edit_name; + + return $this; + } + /** * Gets auto_navigation * @return string @@ -788,7 +855,7 @@ public function getEmbeddedRecipientStartUrl() /** * Sets embedded_recipient_start_url - * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -861,6 +928,48 @@ public function setFaxNumber($fax_number) return $this; } + /** + * Gets first_name + * @return string + */ + public function getFirstName() + { + return $this->container['first_name']; + } + + /** + * Sets first_name + * @param string $first_name The user's first name. Maximum Length: 50 characters. + * @return $this + */ + public function setFirstName($first_name) + { + $this->container['first_name'] = $first_name; + + return $this; + } + + /** + * Gets full_name + * @return string + */ + public function getFullName() + { + return $this->container['full_name']; + } + + /** + * Sets full_name + * @param string $full_name + * @return $this + */ + public function setFullName($full_name) + { + $this->container['full_name'] = $full_name; + + return $this; + } + /** * Gets id_check_configuration_name * @return string @@ -945,6 +1054,27 @@ public function setIsBulkRecipient($is_bulk_recipient) return $this; } + /** + * Gets last_name + * @return string + */ + public function getLastName() + { + return $this->container['last_name']; + } + + /** + * Sets last_name + * @param string $last_name + * @return $this + */ + public function setLastName($last_name) + { + $this->container['last_name'] = $last_name; + + return $this; + } + /** * Gets name * @return string @@ -1187,7 +1317,7 @@ public function getRequireSignerCertificate() /** * Sets require_signer_certificate - * @param string $require_signer_certificate Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: * docusign_express – Requires a DocuSign Express certificate. * safe – Requires a SAFE-BioPharma certificate. * open_trust – Requires an OpenTrust certificate. **Important**: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. + * @param string $require_signer_certificate Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: * docusign_express - Requires a DocuSign Express certificate. * safe - Requires a SAFE-BioPharma certificate. * open_trust - Requires an OpenTrust certificate. **Important**: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. * @return $this */ public function setRequireSignerCertificate($require_signer_certificate) diff --git a/src/Model/SignerAttachment.php b/src/Model/SignerAttachment.php index 2561edae..bade473c 100644 --- a/src/Model/SignerAttachment.php +++ b/src/Model/SignerAttachment.php @@ -72,13 +72,15 @@ class SignerAttachment implements ArrayAccess 'optional' => 'string', 'page_number' => 'string', 'recipient_id' => 'string', - 'scale_value' => 'Number', + 'scale_value' => 'float', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'x_position' => 'string', 'y_position' => 'string' ]; @@ -113,11 +115,13 @@ public static function swaggerTypes() 'recipient_id' => 'recipientId', 'scale_value' => 'scaleValue', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'x_position' => 'xPosition', 'y_position' => 'yPosition' ]; @@ -148,11 +152,13 @@ public static function swaggerTypes() 'recipient_id' => 'setRecipientId', 'scale_value' => 'setScaleValue', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'x_position' => 'setXPosition', 'y_position' => 'setYPosition' ]; @@ -183,11 +189,13 @@ public static function swaggerTypes() 'recipient_id' => 'getRecipientId', 'scale_value' => 'getScaleValue', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'x_position' => 'getXPosition', 'y_position' => 'getYPosition' ]; @@ -243,11 +251,13 @@ public function __construct(array $data = null) $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['scale_value'] = isset($data['scale_value']) ? $data['scale_value'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; } @@ -412,7 +422,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -433,7 +443,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -655,7 +665,7 @@ public function setRecipientId($recipient_id) /** * Gets scale_value - * @return Number + * @return float */ public function getScaleValue() { @@ -664,7 +674,7 @@ public function getScaleValue() /** * Sets scale_value - * @param Number $scale_value + * @param float $scale_value * @return $this */ public function setScaleValue($scale_value) @@ -695,6 +705,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -800,6 +831,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets x_position * @return string diff --git a/src/Model/SignerEmailNotifications.php b/src/Model/SignerEmailNotifications.php index 3f192c47..60966bb5 100644 --- a/src/Model/SignerEmailNotifications.php +++ b/src/Model/SignerEmailNotifications.php @@ -58,6 +58,8 @@ class SignerEmailNotifications implements ArrayAccess 'agent_notification' => 'string', 'carbon_copy_notification' => 'string', 'certified_delivery_notification' => 'string', + 'comments_only_private_and_mention' => 'string', + 'comments_receive_all' => 'string', 'document_markup_activation' => 'string', 'envelope_activation' => 'string', 'envelope_complete' => 'string', @@ -84,6 +86,8 @@ public static function swaggerTypes() 'agent_notification' => 'agentNotification', 'carbon_copy_notification' => 'carbonCopyNotification', 'certified_delivery_notification' => 'certifiedDeliveryNotification', + 'comments_only_private_and_mention' => 'commentsOnlyPrivateAndMention', + 'comments_receive_all' => 'commentsReceiveAll', 'document_markup_activation' => 'documentMarkupActivation', 'envelope_activation' => 'envelopeActivation', 'envelope_complete' => 'envelopeComplete', @@ -106,6 +110,8 @@ public static function swaggerTypes() 'agent_notification' => 'setAgentNotification', 'carbon_copy_notification' => 'setCarbonCopyNotification', 'certified_delivery_notification' => 'setCertifiedDeliveryNotification', + 'comments_only_private_and_mention' => 'setCommentsOnlyPrivateAndMention', + 'comments_receive_all' => 'setCommentsReceiveAll', 'document_markup_activation' => 'setDocumentMarkupActivation', 'envelope_activation' => 'setEnvelopeActivation', 'envelope_complete' => 'setEnvelopeComplete', @@ -128,6 +134,8 @@ public static function swaggerTypes() 'agent_notification' => 'getAgentNotification', 'carbon_copy_notification' => 'getCarbonCopyNotification', 'certified_delivery_notification' => 'getCertifiedDeliveryNotification', + 'comments_only_private_and_mention' => 'getCommentsOnlyPrivateAndMention', + 'comments_receive_all' => 'getCommentsReceiveAll', 'document_markup_activation' => 'getDocumentMarkupActivation', 'envelope_activation' => 'getEnvelopeActivation', 'envelope_complete' => 'getEnvelopeComplete', @@ -175,6 +183,8 @@ public function __construct(array $data = null) $this->container['agent_notification'] = isset($data['agent_notification']) ? $data['agent_notification'] : null; $this->container['carbon_copy_notification'] = isset($data['carbon_copy_notification']) ? $data['carbon_copy_notification'] : null; $this->container['certified_delivery_notification'] = isset($data['certified_delivery_notification']) ? $data['certified_delivery_notification'] : null; + $this->container['comments_only_private_and_mention'] = isset($data['comments_only_private_and_mention']) ? $data['comments_only_private_and_mention'] : null; + $this->container['comments_receive_all'] = isset($data['comments_receive_all']) ? $data['comments_receive_all'] : null; $this->container['document_markup_activation'] = isset($data['document_markup_activation']) ? $data['document_markup_activation'] : null; $this->container['envelope_activation'] = isset($data['envelope_activation']) ? $data['envelope_activation'] : null; $this->container['envelope_complete'] = isset($data['envelope_complete']) ? $data['envelope_complete'] : null; @@ -274,6 +284,48 @@ public function setCertifiedDeliveryNotification($certified_delivery_notificatio return $this; } + /** + * Gets comments_only_private_and_mention + * @return string + */ + public function getCommentsOnlyPrivateAndMention() + { + return $this->container['comments_only_private_and_mention']; + } + + /** + * Sets comments_only_private_and_mention + * @param string $comments_only_private_and_mention + * @return $this + */ + public function setCommentsOnlyPrivateAndMention($comments_only_private_and_mention) + { + $this->container['comments_only_private_and_mention'] = $comments_only_private_and_mention; + + return $this; + } + + /** + * Gets comments_receive_all + * @return string + */ + public function getCommentsReceiveAll() + { + return $this->container['comments_receive_all']; + } + + /** + * Sets comments_receive_all + * @param string $comments_receive_all + * @return $this + */ + public function setCommentsReceiveAll($comments_receive_all) + { + $this->container['comments_receive_all'] = $comments_receive_all; + + return $this; + } + /** * Gets document_markup_activation * @return string diff --git a/src/Model/SmartSection.php b/src/Model/SmartSection.php new file mode 100644 index 00000000..009ee298 --- /dev/null +++ b/src/Model/SmartSection.php @@ -0,0 +1,1059 @@ + 'string', + 'anchor_horizontal_alignment' => 'string', + 'anchor_ignore_if_not_present' => 'string', + 'anchor_match_whole_word' => 'string', + 'anchor_string' => 'string', + 'anchor_units' => 'string', + 'anchor_x_offset' => 'string', + 'anchor_y_offset' => 'string', + 'case_sensitive' => 'bool', + 'conditional_parent_label' => 'string', + 'conditional_parent_value' => 'string', + 'custom_tab_id' => 'string', + 'display_settings' => '\DocuSign\eSign\Model\SmartSectionDisplaySettings', + 'document_id' => 'string', + 'end_anchor' => 'string', + 'end_position' => '\DocuSign\eSign\Model\SmartSectionAnchorPosition', + 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', + 'merge_field' => '\DocuSign\eSign\Model\MergeField', + 'page_number' => 'string', + 'recipient_id' => 'string', + 'remove_end_anchor' => 'bool', + 'remove_start_anchor' => 'bool', + 'start_anchor' => 'string', + 'start_position' => '\DocuSign\eSign\Model\SmartSectionAnchorPosition', + 'status' => 'string', + 'tab_group_labels' => 'string[]', + 'tab_id' => 'string', + 'tab_order' => 'string', + 'template_locked' => 'string', + 'template_required' => 'string', + 'tooltip' => 'string', + 'x_position' => 'string', + 'y_position' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'anchor_case_sensitive' => 'anchorCaseSensitive', + 'anchor_horizontal_alignment' => 'anchorHorizontalAlignment', + 'anchor_ignore_if_not_present' => 'anchorIgnoreIfNotPresent', + 'anchor_match_whole_word' => 'anchorMatchWholeWord', + 'anchor_string' => 'anchorString', + 'anchor_units' => 'anchorUnits', + 'anchor_x_offset' => 'anchorXOffset', + 'anchor_y_offset' => 'anchorYOffset', + 'case_sensitive' => 'caseSensitive', + 'conditional_parent_label' => 'conditionalParentLabel', + 'conditional_parent_value' => 'conditionalParentValue', + 'custom_tab_id' => 'customTabId', + 'display_settings' => 'displaySettings', + 'document_id' => 'documentId', + 'end_anchor' => 'endAnchor', + 'end_position' => 'endPosition', + 'error_details' => 'errorDetails', + 'merge_field' => 'mergeField', + 'page_number' => 'pageNumber', + 'recipient_id' => 'recipientId', + 'remove_end_anchor' => 'removeEndAnchor', + 'remove_start_anchor' => 'removeStartAnchor', + 'start_anchor' => 'startAnchor', + 'start_position' => 'startPosition', + 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', + 'tab_id' => 'tabId', + 'tab_order' => 'tabOrder', + 'template_locked' => 'templateLocked', + 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', + 'x_position' => 'xPosition', + 'y_position' => 'yPosition' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'anchor_case_sensitive' => 'setAnchorCaseSensitive', + 'anchor_horizontal_alignment' => 'setAnchorHorizontalAlignment', + 'anchor_ignore_if_not_present' => 'setAnchorIgnoreIfNotPresent', + 'anchor_match_whole_word' => 'setAnchorMatchWholeWord', + 'anchor_string' => 'setAnchorString', + 'anchor_units' => 'setAnchorUnits', + 'anchor_x_offset' => 'setAnchorXOffset', + 'anchor_y_offset' => 'setAnchorYOffset', + 'case_sensitive' => 'setCaseSensitive', + 'conditional_parent_label' => 'setConditionalParentLabel', + 'conditional_parent_value' => 'setConditionalParentValue', + 'custom_tab_id' => 'setCustomTabId', + 'display_settings' => 'setDisplaySettings', + 'document_id' => 'setDocumentId', + 'end_anchor' => 'setEndAnchor', + 'end_position' => 'setEndPosition', + 'error_details' => 'setErrorDetails', + 'merge_field' => 'setMergeField', + 'page_number' => 'setPageNumber', + 'recipient_id' => 'setRecipientId', + 'remove_end_anchor' => 'setRemoveEndAnchor', + 'remove_start_anchor' => 'setRemoveStartAnchor', + 'start_anchor' => 'setStartAnchor', + 'start_position' => 'setStartPosition', + 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', + 'tab_id' => 'setTabId', + 'tab_order' => 'setTabOrder', + 'template_locked' => 'setTemplateLocked', + 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', + 'x_position' => 'setXPosition', + 'y_position' => 'setYPosition' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'anchor_case_sensitive' => 'getAnchorCaseSensitive', + 'anchor_horizontal_alignment' => 'getAnchorHorizontalAlignment', + 'anchor_ignore_if_not_present' => 'getAnchorIgnoreIfNotPresent', + 'anchor_match_whole_word' => 'getAnchorMatchWholeWord', + 'anchor_string' => 'getAnchorString', + 'anchor_units' => 'getAnchorUnits', + 'anchor_x_offset' => 'getAnchorXOffset', + 'anchor_y_offset' => 'getAnchorYOffset', + 'case_sensitive' => 'getCaseSensitive', + 'conditional_parent_label' => 'getConditionalParentLabel', + 'conditional_parent_value' => 'getConditionalParentValue', + 'custom_tab_id' => 'getCustomTabId', + 'display_settings' => 'getDisplaySettings', + 'document_id' => 'getDocumentId', + 'end_anchor' => 'getEndAnchor', + 'end_position' => 'getEndPosition', + 'error_details' => 'getErrorDetails', + 'merge_field' => 'getMergeField', + 'page_number' => 'getPageNumber', + 'recipient_id' => 'getRecipientId', + 'remove_end_anchor' => 'getRemoveEndAnchor', + 'remove_start_anchor' => 'getRemoveStartAnchor', + 'start_anchor' => 'getStartAnchor', + 'start_position' => 'getStartPosition', + 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', + 'tab_id' => 'getTabId', + 'tab_order' => 'getTabOrder', + 'template_locked' => 'getTemplateLocked', + 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', + 'x_position' => 'getXPosition', + 'y_position' => 'getYPosition' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['anchor_case_sensitive'] = isset($data['anchor_case_sensitive']) ? $data['anchor_case_sensitive'] : null; + $this->container['anchor_horizontal_alignment'] = isset($data['anchor_horizontal_alignment']) ? $data['anchor_horizontal_alignment'] : null; + $this->container['anchor_ignore_if_not_present'] = isset($data['anchor_ignore_if_not_present']) ? $data['anchor_ignore_if_not_present'] : null; + $this->container['anchor_match_whole_word'] = isset($data['anchor_match_whole_word']) ? $data['anchor_match_whole_word'] : null; + $this->container['anchor_string'] = isset($data['anchor_string']) ? $data['anchor_string'] : null; + $this->container['anchor_units'] = isset($data['anchor_units']) ? $data['anchor_units'] : null; + $this->container['anchor_x_offset'] = isset($data['anchor_x_offset']) ? $data['anchor_x_offset'] : null; + $this->container['anchor_y_offset'] = isset($data['anchor_y_offset']) ? $data['anchor_y_offset'] : null; + $this->container['case_sensitive'] = isset($data['case_sensitive']) ? $data['case_sensitive'] : null; + $this->container['conditional_parent_label'] = isset($data['conditional_parent_label']) ? $data['conditional_parent_label'] : null; + $this->container['conditional_parent_value'] = isset($data['conditional_parent_value']) ? $data['conditional_parent_value'] : null; + $this->container['custom_tab_id'] = isset($data['custom_tab_id']) ? $data['custom_tab_id'] : null; + $this->container['display_settings'] = isset($data['display_settings']) ? $data['display_settings'] : null; + $this->container['document_id'] = isset($data['document_id']) ? $data['document_id'] : null; + $this->container['end_anchor'] = isset($data['end_anchor']) ? $data['end_anchor'] : null; + $this->container['end_position'] = isset($data['end_position']) ? $data['end_position'] : null; + $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; + $this->container['merge_field'] = isset($data['merge_field']) ? $data['merge_field'] : null; + $this->container['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; + $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; + $this->container['remove_end_anchor'] = isset($data['remove_end_anchor']) ? $data['remove_end_anchor'] : null; + $this->container['remove_start_anchor'] = isset($data['remove_start_anchor']) ? $data['remove_start_anchor'] : null; + $this->container['start_anchor'] = isset($data['start_anchor']) ? $data['start_anchor'] : null; + $this->container['start_position'] = isset($data['start_position']) ? $data['start_position'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; + $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; + $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; + $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; + $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; + $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; + $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets anchor_case_sensitive + * @return string + */ + public function getAnchorCaseSensitive() + { + return $this->container['anchor_case_sensitive']; + } + + /** + * Sets anchor_case_sensitive + * @param string $anchor_case_sensitive When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. + * @return $this + */ + public function setAnchorCaseSensitive($anchor_case_sensitive) + { + $this->container['anchor_case_sensitive'] = $anchor_case_sensitive; + + return $this; + } + + /** + * Gets anchor_horizontal_alignment + * @return string + */ + public function getAnchorHorizontalAlignment() + { + return $this->container['anchor_horizontal_alignment']; + } + + /** + * Sets anchor_horizontal_alignment + * @param string $anchor_horizontal_alignment Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. + * @return $this + */ + public function setAnchorHorizontalAlignment($anchor_horizontal_alignment) + { + $this->container['anchor_horizontal_alignment'] = $anchor_horizontal_alignment; + + return $this; + } + + /** + * Gets anchor_ignore_if_not_present + * @return string + */ + public function getAnchorIgnoreIfNotPresent() + { + return $this->container['anchor_ignore_if_not_present']; + } + + /** + * Sets anchor_ignore_if_not_present + * @param string $anchor_ignore_if_not_present When set to **true**, this tab is ignored if anchorString is not found in the document. + * @return $this + */ + public function setAnchorIgnoreIfNotPresent($anchor_ignore_if_not_present) + { + $this->container['anchor_ignore_if_not_present'] = $anchor_ignore_if_not_present; + + return $this; + } + + /** + * Gets anchor_match_whole_word + * @return string + */ + public function getAnchorMatchWholeWord() + { + return $this->container['anchor_match_whole_word']; + } + + /** + * Sets anchor_match_whole_word + * @param string $anchor_match_whole_word When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. + * @return $this + */ + public function setAnchorMatchWholeWord($anchor_match_whole_word) + { + $this->container['anchor_match_whole_word'] = $anchor_match_whole_word; + + return $this; + } + + /** + * Gets anchor_string + * @return string + */ + public function getAnchorString() + { + return $this->container['anchor_string']; + } + + /** + * Sets anchor_string + * @param string $anchor_string Anchor text information for a radio button. + * @return $this + */ + public function setAnchorString($anchor_string) + { + $this->container['anchor_string'] = $anchor_string; + + return $this; + } + + /** + * Gets anchor_units + * @return string + */ + public function getAnchorUnits() + { + return $this->container['anchor_units']; + } + + /** + * Sets anchor_units + * @param string $anchor_units Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. + * @return $this + */ + public function setAnchorUnits($anchor_units) + { + $this->container['anchor_units'] = $anchor_units; + + return $this; + } + + /** + * Gets anchor_x_offset + * @return string + */ + public function getAnchorXOffset() + { + return $this->container['anchor_x_offset']; + } + + /** + * Sets anchor_x_offset + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. + * @return $this + */ + public function setAnchorXOffset($anchor_x_offset) + { + $this->container['anchor_x_offset'] = $anchor_x_offset; + + return $this; + } + + /** + * Gets anchor_y_offset + * @return string + */ + public function getAnchorYOffset() + { + return $this->container['anchor_y_offset']; + } + + /** + * Sets anchor_y_offset + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. + * @return $this + */ + public function setAnchorYOffset($anchor_y_offset) + { + $this->container['anchor_y_offset'] = $anchor_y_offset; + + return $this; + } + + /** + * Gets case_sensitive + * @return bool + */ + public function getCaseSensitive() + { + return $this->container['case_sensitive']; + } + + /** + * Sets case_sensitive + * @param bool $case_sensitive + * @return $this + */ + public function setCaseSensitive($case_sensitive) + { + $this->container['case_sensitive'] = $case_sensitive; + + return $this; + } + + /** + * Gets conditional_parent_label + * @return string + */ + public function getConditionalParentLabel() + { + return $this->container['conditional_parent_label']; + } + + /** + * Sets conditional_parent_label + * @param string $conditional_parent_label For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. + * @return $this + */ + public function setConditionalParentLabel($conditional_parent_label) + { + $this->container['conditional_parent_label'] = $conditional_parent_label; + + return $this; + } + + /** + * Gets conditional_parent_value + * @return string + */ + public function getConditionalParentValue() + { + return $this->container['conditional_parent_value']; + } + + /** + * Sets conditional_parent_value + * @param string $conditional_parent_value For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. + * @return $this + */ + public function setConditionalParentValue($conditional_parent_value) + { + $this->container['conditional_parent_value'] = $conditional_parent_value; + + return $this; + } + + /** + * Gets custom_tab_id + * @return string + */ + public function getCustomTabId() + { + return $this->container['custom_tab_id']; + } + + /** + * Sets custom_tab_id + * @param string $custom_tab_id The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. + * @return $this + */ + public function setCustomTabId($custom_tab_id) + { + $this->container['custom_tab_id'] = $custom_tab_id; + + return $this; + } + + /** + * Gets display_settings + * @return \DocuSign\eSign\Model\SmartSectionDisplaySettings + */ + public function getDisplaySettings() + { + return $this->container['display_settings']; + } + + /** + * Sets display_settings + * @param \DocuSign\eSign\Model\SmartSectionDisplaySettings $display_settings + * @return $this + */ + public function setDisplaySettings($display_settings) + { + $this->container['display_settings'] = $display_settings; + + return $this; + } + + /** + * Gets document_id + * @return string + */ + public function getDocumentId() + { + return $this->container['document_id']; + } + + /** + * Sets document_id + * @param string $document_id Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. + * @return $this + */ + public function setDocumentId($document_id) + { + $this->container['document_id'] = $document_id; + + return $this; + } + + /** + * Gets end_anchor + * @return string + */ + public function getEndAnchor() + { + return $this->container['end_anchor']; + } + + /** + * Sets end_anchor + * @param string $end_anchor + * @return $this + */ + public function setEndAnchor($end_anchor) + { + $this->container['end_anchor'] = $end_anchor; + + return $this; + } + + /** + * Gets end_position + * @return \DocuSign\eSign\Model\SmartSectionAnchorPosition + */ + public function getEndPosition() + { + return $this->container['end_position']; + } + + /** + * Sets end_position + * @param \DocuSign\eSign\Model\SmartSectionAnchorPosition $end_position + * @return $this + */ + public function setEndPosition($end_position) + { + $this->container['end_position'] = $end_position; + + return $this; + } + + /** + * Gets error_details + * @return \DocuSign\eSign\Model\ErrorDetails + */ + public function getErrorDetails() + { + return $this->container['error_details']; + } + + /** + * Sets error_details + * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * @return $this + */ + public function setErrorDetails($error_details) + { + $this->container['error_details'] = $error_details; + + return $this; + } + + /** + * Gets merge_field + * @return \DocuSign\eSign\Model\MergeField + */ + public function getMergeField() + { + return $this->container['merge_field']; + } + + /** + * Sets merge_field + * @param \DocuSign\eSign\Model\MergeField $merge_field + * @return $this + */ + public function setMergeField($merge_field) + { + $this->container['merge_field'] = $merge_field; + + return $this; + } + + /** + * Gets page_number + * @return string + */ + public function getPageNumber() + { + return $this->container['page_number']; + } + + /** + * Sets page_number + * @param string $page_number Specifies the page number on which the tab is located. + * @return $this + */ + public function setPageNumber($page_number) + { + $this->container['page_number'] = $page_number; + + return $this; + } + + /** + * Gets recipient_id + * @return string + */ + public function getRecipientId() + { + return $this->container['recipient_id']; + } + + /** + * Sets recipient_id + * @param string $recipient_id Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + * @return $this + */ + public function setRecipientId($recipient_id) + { + $this->container['recipient_id'] = $recipient_id; + + return $this; + } + + /** + * Gets remove_end_anchor + * @return bool + */ + public function getRemoveEndAnchor() + { + return $this->container['remove_end_anchor']; + } + + /** + * Sets remove_end_anchor + * @param bool $remove_end_anchor + * @return $this + */ + public function setRemoveEndAnchor($remove_end_anchor) + { + $this->container['remove_end_anchor'] = $remove_end_anchor; + + return $this; + } + + /** + * Gets remove_start_anchor + * @return bool + */ + public function getRemoveStartAnchor() + { + return $this->container['remove_start_anchor']; + } + + /** + * Sets remove_start_anchor + * @param bool $remove_start_anchor + * @return $this + */ + public function setRemoveStartAnchor($remove_start_anchor) + { + $this->container['remove_start_anchor'] = $remove_start_anchor; + + return $this; + } + + /** + * Gets start_anchor + * @return string + */ + public function getStartAnchor() + { + return $this->container['start_anchor']; + } + + /** + * Sets start_anchor + * @param string $start_anchor + * @return $this + */ + public function setStartAnchor($start_anchor) + { + $this->container['start_anchor'] = $start_anchor; + + return $this; + } + + /** + * Gets start_position + * @return \DocuSign\eSign\Model\SmartSectionAnchorPosition + */ + public function getStartPosition() + { + return $this->container['start_position']; + } + + /** + * Sets start_position + * @param \DocuSign\eSign\Model\SmartSectionAnchorPosition $start_position + * @return $this + */ + public function setStartPosition($start_position) + { + $this->container['start_position'] = $start_position; + + return $this; + } + + /** + * Gets status + * @return string + */ + public function getStatus() + { + return $this->container['status']; + } + + /** + * Sets status + * @param string $status Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. + * @return $this + */ + public function setStatus($status) + { + $this->container['status'] = $status; + + return $this; + } + + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + + /** + * Gets tab_id + * @return string + */ + public function getTabId() + { + return $this->container['tab_id']; + } + + /** + * Sets tab_id + * @param string $tab_id The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. + * @return $this + */ + public function setTabId($tab_id) + { + $this->container['tab_id'] = $tab_id; + + return $this; + } + + /** + * Gets tab_order + * @return string + */ + public function getTabOrder() + { + return $this->container['tab_order']; + } + + /** + * Sets tab_order + * @param string $tab_order + * @return $this + */ + public function setTabOrder($tab_order) + { + $this->container['tab_order'] = $tab_order; + + return $this; + } + + /** + * Gets template_locked + * @return string + */ + public function getTemplateLocked() + { + return $this->container['template_locked']; + } + + /** + * Sets template_locked + * @param string $template_locked When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + * @return $this + */ + public function setTemplateLocked($template_locked) + { + $this->container['template_locked'] = $template_locked; + + return $this; + } + + /** + * Gets template_required + * @return string + */ + public function getTemplateRequired() + { + return $this->container['template_required']; + } + + /** + * Sets template_required + * @param string $template_required When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + * @return $this + */ + public function setTemplateRequired($template_required) + { + $this->container['template_required'] = $template_required; + + return $this; + } + + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + + /** + * Gets x_position + * @return string + */ + public function getXPosition() + { + return $this->container['x_position']; + } + + /** + * Sets x_position + * @param string $x_position This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. + * @return $this + */ + public function setXPosition($x_position) + { + $this->container['x_position'] = $x_position; + + return $this; + } + + /** + * Gets y_position + * @return string + */ + public function getYPosition() + { + return $this->container['y_position']; + } + + /** + * Sets y_position + * @param string $y_position This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. + * @return $this + */ + public function setYPosition($y_position) + { + $this->container['y_position'] = $y_position; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/SmartSectionAnchorPosition.php b/src/Model/SmartSectionAnchorPosition.php new file mode 100644 index 00000000..136ea322 --- /dev/null +++ b/src/Model/SmartSectionAnchorPosition.php @@ -0,0 +1,279 @@ + 'int', + 'x_position' => 'double', + 'y_position' => 'double' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'page_number' => 'pageNumber', + 'x_position' => 'xPosition', + 'y_position' => 'yPosition' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'page_number' => 'setPageNumber', + 'x_position' => 'setXPosition', + 'y_position' => 'setYPosition' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'page_number' => 'getPageNumber', + 'x_position' => 'getXPosition', + 'y_position' => 'getYPosition' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['page_number'] = isset($data['page_number']) ? $data['page_number'] : null; + $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; + $this->container['y_position'] = isset($data['y_position']) ? $data['y_position'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets page_number + * @return int + */ + public function getPageNumber() + { + return $this->container['page_number']; + } + + /** + * Sets page_number + * @param int $page_number Specifies the page number on which the tab is located. + * @return $this + */ + public function setPageNumber($page_number) + { + $this->container['page_number'] = $page_number; + + return $this; + } + + /** + * Gets x_position + * @return double + */ + public function getXPosition() + { + return $this->container['x_position']; + } + + /** + * Sets x_position + * @param double $x_position This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. + * @return $this + */ + public function setXPosition($x_position) + { + $this->container['x_position'] = $x_position; + + return $this; + } + + /** + * Gets y_position + * @return double + */ + public function getYPosition() + { + return $this->container['y_position']; + } + + /** + * Sets y_position + * @param double $y_position This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. + * @return $this + */ + public function setYPosition($y_position) + { + $this->container['y_position'] = $y_position; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/SmartSectionCollapsibleDisplaySettings.php b/src/Model/SmartSectionCollapsibleDisplaySettings.php new file mode 100644 index 00000000..0313080f --- /dev/null +++ b/src/Model/SmartSectionCollapsibleDisplaySettings.php @@ -0,0 +1,461 @@ + 'string', + 'arrow_color' => 'string', + 'arrow_location' => 'string', + 'arrow_open' => 'string', + 'arrow_size' => 'string', + 'arrow_style' => 'string', + 'container_style' => 'string', + 'label_style' => 'string', + 'only_arrow_is_clickable' => 'bool', + 'outer_label_and_arrow_style' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'arrow_closed' => 'arrowClosed', + 'arrow_color' => 'arrowColor', + 'arrow_location' => 'arrowLocation', + 'arrow_open' => 'arrowOpen', + 'arrow_size' => 'arrowSize', + 'arrow_style' => 'arrowStyle', + 'container_style' => 'containerStyle', + 'label_style' => 'labelStyle', + 'only_arrow_is_clickable' => 'onlyArrowIsClickable', + 'outer_label_and_arrow_style' => 'outerLabelAndArrowStyle' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'arrow_closed' => 'setArrowClosed', + 'arrow_color' => 'setArrowColor', + 'arrow_location' => 'setArrowLocation', + 'arrow_open' => 'setArrowOpen', + 'arrow_size' => 'setArrowSize', + 'arrow_style' => 'setArrowStyle', + 'container_style' => 'setContainerStyle', + 'label_style' => 'setLabelStyle', + 'only_arrow_is_clickable' => 'setOnlyArrowIsClickable', + 'outer_label_and_arrow_style' => 'setOuterLabelAndArrowStyle' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'arrow_closed' => 'getArrowClosed', + 'arrow_color' => 'getArrowColor', + 'arrow_location' => 'getArrowLocation', + 'arrow_open' => 'getArrowOpen', + 'arrow_size' => 'getArrowSize', + 'arrow_style' => 'getArrowStyle', + 'container_style' => 'getContainerStyle', + 'label_style' => 'getLabelStyle', + 'only_arrow_is_clickable' => 'getOnlyArrowIsClickable', + 'outer_label_and_arrow_style' => 'getOuterLabelAndArrowStyle' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['arrow_closed'] = isset($data['arrow_closed']) ? $data['arrow_closed'] : null; + $this->container['arrow_color'] = isset($data['arrow_color']) ? $data['arrow_color'] : null; + $this->container['arrow_location'] = isset($data['arrow_location']) ? $data['arrow_location'] : null; + $this->container['arrow_open'] = isset($data['arrow_open']) ? $data['arrow_open'] : null; + $this->container['arrow_size'] = isset($data['arrow_size']) ? $data['arrow_size'] : null; + $this->container['arrow_style'] = isset($data['arrow_style']) ? $data['arrow_style'] : null; + $this->container['container_style'] = isset($data['container_style']) ? $data['container_style'] : null; + $this->container['label_style'] = isset($data['label_style']) ? $data['label_style'] : null; + $this->container['only_arrow_is_clickable'] = isset($data['only_arrow_is_clickable']) ? $data['only_arrow_is_clickable'] : null; + $this->container['outer_label_and_arrow_style'] = isset($data['outer_label_and_arrow_style']) ? $data['outer_label_and_arrow_style'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets arrow_closed + * @return string + */ + public function getArrowClosed() + { + return $this->container['arrow_closed']; + } + + /** + * Sets arrow_closed + * @param string $arrow_closed + * @return $this + */ + public function setArrowClosed($arrow_closed) + { + $this->container['arrow_closed'] = $arrow_closed; + + return $this; + } + + /** + * Gets arrow_color + * @return string + */ + public function getArrowColor() + { + return $this->container['arrow_color']; + } + + /** + * Sets arrow_color + * @param string $arrow_color + * @return $this + */ + public function setArrowColor($arrow_color) + { + $this->container['arrow_color'] = $arrow_color; + + return $this; + } + + /** + * Gets arrow_location + * @return string + */ + public function getArrowLocation() + { + return $this->container['arrow_location']; + } + + /** + * Sets arrow_location + * @param string $arrow_location + * @return $this + */ + public function setArrowLocation($arrow_location) + { + $this->container['arrow_location'] = $arrow_location; + + return $this; + } + + /** + * Gets arrow_open + * @return string + */ + public function getArrowOpen() + { + return $this->container['arrow_open']; + } + + /** + * Sets arrow_open + * @param string $arrow_open + * @return $this + */ + public function setArrowOpen($arrow_open) + { + $this->container['arrow_open'] = $arrow_open; + + return $this; + } + + /** + * Gets arrow_size + * @return string + */ + public function getArrowSize() + { + return $this->container['arrow_size']; + } + + /** + * Sets arrow_size + * @param string $arrow_size + * @return $this + */ + public function setArrowSize($arrow_size) + { + $this->container['arrow_size'] = $arrow_size; + + return $this; + } + + /** + * Gets arrow_style + * @return string + */ + public function getArrowStyle() + { + return $this->container['arrow_style']; + } + + /** + * Sets arrow_style + * @param string $arrow_style + * @return $this + */ + public function setArrowStyle($arrow_style) + { + $this->container['arrow_style'] = $arrow_style; + + return $this; + } + + /** + * Gets container_style + * @return string + */ + public function getContainerStyle() + { + return $this->container['container_style']; + } + + /** + * Sets container_style + * @param string $container_style + * @return $this + */ + public function setContainerStyle($container_style) + { + $this->container['container_style'] = $container_style; + + return $this; + } + + /** + * Gets label_style + * @return string + */ + public function getLabelStyle() + { + return $this->container['label_style']; + } + + /** + * Sets label_style + * @param string $label_style + * @return $this + */ + public function setLabelStyle($label_style) + { + $this->container['label_style'] = $label_style; + + return $this; + } + + /** + * Gets only_arrow_is_clickable + * @return bool + */ + public function getOnlyArrowIsClickable() + { + return $this->container['only_arrow_is_clickable']; + } + + /** + * Sets only_arrow_is_clickable + * @param bool $only_arrow_is_clickable + * @return $this + */ + public function setOnlyArrowIsClickable($only_arrow_is_clickable) + { + $this->container['only_arrow_is_clickable'] = $only_arrow_is_clickable; + + return $this; + } + + /** + * Gets outer_label_and_arrow_style + * @return string + */ + public function getOuterLabelAndArrowStyle() + { + return $this->container['outer_label_and_arrow_style']; + } + + /** + * Sets outer_label_and_arrow_style + * @param string $outer_label_and_arrow_style + * @return $this + */ + public function setOuterLabelAndArrowStyle($outer_label_and_arrow_style) + { + $this->container['outer_label_and_arrow_style'] = $outer_label_and_arrow_style; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/SmartSectionDisplaySettings.php b/src/Model/SmartSectionDisplaySettings.php new file mode 100644 index 00000000..2bf6fb4b --- /dev/null +++ b/src/Model/SmartSectionDisplaySettings.php @@ -0,0 +1,487 @@ + 'string', + 'collapsible_settings' => '\DocuSign\eSign\Model\SmartSectionCollapsibleDisplaySettings', + 'display' => 'string', + 'display_label' => 'string', + 'display_order' => 'int', + 'display_page_number' => 'int', + 'hide_label_when_opened' => 'bool', + 'inline_outer_style' => 'string', + 'label_when_opened' => 'string', + 'scroll_to_top_when_opened' => 'bool', + 'table_style' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'cell_style' => 'cellStyle', + 'collapsible_settings' => 'collapsibleSettings', + 'display' => 'display', + 'display_label' => 'displayLabel', + 'display_order' => 'displayOrder', + 'display_page_number' => 'displayPageNumber', + 'hide_label_when_opened' => 'hideLabelWhenOpened', + 'inline_outer_style' => 'inlineOuterStyle', + 'label_when_opened' => 'labelWhenOpened', + 'scroll_to_top_when_opened' => 'scrollToTopWhenOpened', + 'table_style' => 'tableStyle' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'cell_style' => 'setCellStyle', + 'collapsible_settings' => 'setCollapsibleSettings', + 'display' => 'setDisplay', + 'display_label' => 'setDisplayLabel', + 'display_order' => 'setDisplayOrder', + 'display_page_number' => 'setDisplayPageNumber', + 'hide_label_when_opened' => 'setHideLabelWhenOpened', + 'inline_outer_style' => 'setInlineOuterStyle', + 'label_when_opened' => 'setLabelWhenOpened', + 'scroll_to_top_when_opened' => 'setScrollToTopWhenOpened', + 'table_style' => 'setTableStyle' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'cell_style' => 'getCellStyle', + 'collapsible_settings' => 'getCollapsibleSettings', + 'display' => 'getDisplay', + 'display_label' => 'getDisplayLabel', + 'display_order' => 'getDisplayOrder', + 'display_page_number' => 'getDisplayPageNumber', + 'hide_label_when_opened' => 'getHideLabelWhenOpened', + 'inline_outer_style' => 'getInlineOuterStyle', + 'label_when_opened' => 'getLabelWhenOpened', + 'scroll_to_top_when_opened' => 'getScrollToTopWhenOpened', + 'table_style' => 'getTableStyle' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['cell_style'] = isset($data['cell_style']) ? $data['cell_style'] : null; + $this->container['collapsible_settings'] = isset($data['collapsible_settings']) ? $data['collapsible_settings'] : null; + $this->container['display'] = isset($data['display']) ? $data['display'] : null; + $this->container['display_label'] = isset($data['display_label']) ? $data['display_label'] : null; + $this->container['display_order'] = isset($data['display_order']) ? $data['display_order'] : null; + $this->container['display_page_number'] = isset($data['display_page_number']) ? $data['display_page_number'] : null; + $this->container['hide_label_when_opened'] = isset($data['hide_label_when_opened']) ? $data['hide_label_when_opened'] : null; + $this->container['inline_outer_style'] = isset($data['inline_outer_style']) ? $data['inline_outer_style'] : null; + $this->container['label_when_opened'] = isset($data['label_when_opened']) ? $data['label_when_opened'] : null; + $this->container['scroll_to_top_when_opened'] = isset($data['scroll_to_top_when_opened']) ? $data['scroll_to_top_when_opened'] : null; + $this->container['table_style'] = isset($data['table_style']) ? $data['table_style'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets cell_style + * @return string + */ + public function getCellStyle() + { + return $this->container['cell_style']; + } + + /** + * Sets cell_style + * @param string $cell_style + * @return $this + */ + public function setCellStyle($cell_style) + { + $this->container['cell_style'] = $cell_style; + + return $this; + } + + /** + * Gets collapsible_settings + * @return \DocuSign\eSign\Model\SmartSectionCollapsibleDisplaySettings + */ + public function getCollapsibleSettings() + { + return $this->container['collapsible_settings']; + } + + /** + * Sets collapsible_settings + * @param \DocuSign\eSign\Model\SmartSectionCollapsibleDisplaySettings $collapsible_settings + * @return $this + */ + public function setCollapsibleSettings($collapsible_settings) + { + $this->container['collapsible_settings'] = $collapsible_settings; + + return $this; + } + + /** + * Gets display + * @return string + */ + public function getDisplay() + { + return $this->container['display']; + } + + /** + * Sets display + * @param string $display + * @return $this + */ + public function setDisplay($display) + { + $this->container['display'] = $display; + + return $this; + } + + /** + * Gets display_label + * @return string + */ + public function getDisplayLabel() + { + return $this->container['display_label']; + } + + /** + * Sets display_label + * @param string $display_label + * @return $this + */ + public function setDisplayLabel($display_label) + { + $this->container['display_label'] = $display_label; + + return $this; + } + + /** + * Gets display_order + * @return int + */ + public function getDisplayOrder() + { + return $this->container['display_order']; + } + + /** + * Sets display_order + * @param int $display_order + * @return $this + */ + public function setDisplayOrder($display_order) + { + $this->container['display_order'] = $display_order; + + return $this; + } + + /** + * Gets display_page_number + * @return int + */ + public function getDisplayPageNumber() + { + return $this->container['display_page_number']; + } + + /** + * Sets display_page_number + * @param int $display_page_number + * @return $this + */ + public function setDisplayPageNumber($display_page_number) + { + $this->container['display_page_number'] = $display_page_number; + + return $this; + } + + /** + * Gets hide_label_when_opened + * @return bool + */ + public function getHideLabelWhenOpened() + { + return $this->container['hide_label_when_opened']; + } + + /** + * Sets hide_label_when_opened + * @param bool $hide_label_when_opened + * @return $this + */ + public function setHideLabelWhenOpened($hide_label_when_opened) + { + $this->container['hide_label_when_opened'] = $hide_label_when_opened; + + return $this; + } + + /** + * Gets inline_outer_style + * @return string + */ + public function getInlineOuterStyle() + { + return $this->container['inline_outer_style']; + } + + /** + * Sets inline_outer_style + * @param string $inline_outer_style + * @return $this + */ + public function setInlineOuterStyle($inline_outer_style) + { + $this->container['inline_outer_style'] = $inline_outer_style; + + return $this; + } + + /** + * Gets label_when_opened + * @return string + */ + public function getLabelWhenOpened() + { + return $this->container['label_when_opened']; + } + + /** + * Sets label_when_opened + * @param string $label_when_opened + * @return $this + */ + public function setLabelWhenOpened($label_when_opened) + { + $this->container['label_when_opened'] = $label_when_opened; + + return $this; + } + + /** + * Gets scroll_to_top_when_opened + * @return bool + */ + public function getScrollToTopWhenOpened() + { + return $this->container['scroll_to_top_when_opened']; + } + + /** + * Sets scroll_to_top_when_opened + * @param bool $scroll_to_top_when_opened + * @return $this + */ + public function setScrollToTopWhenOpened($scroll_to_top_when_opened) + { + $this->container['scroll_to_top_when_opened'] = $scroll_to_top_when_opened; + + return $this; + } + + /** + * Gets table_style + * @return string + */ + public function getTableStyle() + { + return $this->container['table_style']; + } + + /** + * Sets table_style + * @param string $table_style + * @return $this + */ + public function setTableStyle($table_style) + { + $this->container['table_style'] = $table_style; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Ssn.php b/src/Model/Ssn.php index 8f89a1dd..5c433d88 100644 --- a/src/Model/Ssn.php +++ b/src/Model/Ssn.php @@ -87,11 +87,13 @@ class Ssn implements ArrayAccess 'sender_required' => 'string', 'shared' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'validation_message' => 'string', 'validation_pattern' => 'string', @@ -144,11 +146,13 @@ public static function swaggerTypes() 'sender_required' => 'senderRequired', 'shared' => 'shared', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'validation_message' => 'validationMessage', 'validation_pattern' => 'validationPattern', @@ -197,11 +201,13 @@ public static function swaggerTypes() 'sender_required' => 'setSenderRequired', 'shared' => 'setShared', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'validation_message' => 'setValidationMessage', 'validation_pattern' => 'setValidationPattern', @@ -250,11 +256,13 @@ public static function swaggerTypes() 'sender_required' => 'getSenderRequired', 'shared' => 'getShared', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'validation_message' => 'getValidationMessage', 'validation_pattern' => 'getValidationPattern', @@ -328,11 +336,13 @@ public function __construct(array $data = null) $this->container['sender_required'] = isset($data['sender_required']) ? $data['sender_required'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['validation_message'] = isset($data['validation_message']) ? $data['validation_message'] : null; $this->container['validation_pattern'] = isset($data['validation_pattern']) ? $data['validation_pattern'] : null; @@ -502,7 +512,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -523,7 +533,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -1058,6 +1068,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -1163,6 +1194,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -1216,7 +1268,7 @@ public function getValidationPattern() /** * Sets validation_pattern - * @param string $validation_pattern A regular expressionn used to validate input for the tab. + * @param string $validation_pattern A regular expression used to validate input for the tab. * @return $this */ public function setValidationPattern($validation_pattern) diff --git a/src/Model/SupportedLanguages.php b/src/Model/SupportedLanguages.php new file mode 100644 index 00000000..3fdfd419 --- /dev/null +++ b/src/Model/SupportedLanguages.php @@ -0,0 +1,227 @@ + '\DocuSign\eSign\Model\NameValue[]' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'languages' => 'languages' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'languages' => 'setLanguages' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'languages' => 'getLanguages' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['languages'] = isset($data['languages']) ? $data['languages'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets languages + * @return \DocuSign\eSign\Model\NameValue[] + */ + public function getLanguages() + { + return $this->container['languages']; + } + + /** + * Sets languages + * @param \DocuSign\eSign\Model\NameValue[] $languages + * @return $this + */ + public function setLanguages($languages) + { + $this->container['languages'] = $languages; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/TabMetadata.php b/src/Model/TabMetadata.php index ff5538e1..7983b040 100644 --- a/src/Model/TabMetadata.php +++ b/src/Model/TabMetadata.php @@ -84,9 +84,15 @@ class TabMetadata implements ArrayAccess 'maximum_length' => 'string', 'merge_field' => '\DocuSign\eSign\Model\MergeField', 'name' => 'string', + 'payment_item_code' => 'string', + 'payment_item_description' => 'string', + 'payment_item_name' => 'string', 'required' => 'string', 'scale_value' => 'string', + 'selected' => 'string', 'shared' => 'string', + 'stamp_type' => 'string', + 'stamp_type_metadata' => '\DocuSign\eSign\Model\PropertyMetadata', 'tab_label' => 'string', 'type' => 'string', 'underline' => 'string', @@ -135,9 +141,15 @@ public static function swaggerTypes() 'maximum_length' => 'maximumLength', 'merge_field' => 'mergeField', 'name' => 'name', + 'payment_item_code' => 'paymentItemCode', + 'payment_item_description' => 'paymentItemDescription', + 'payment_item_name' => 'paymentItemName', 'required' => 'required', 'scale_value' => 'scaleValue', + 'selected' => 'selected', 'shared' => 'shared', + 'stamp_type' => 'stampType', + 'stamp_type_metadata' => 'stampTypeMetadata', 'tab_label' => 'tabLabel', 'type' => 'type', 'underline' => 'underline', @@ -182,9 +194,15 @@ public static function swaggerTypes() 'maximum_length' => 'setMaximumLength', 'merge_field' => 'setMergeField', 'name' => 'setName', + 'payment_item_code' => 'setPaymentItemCode', + 'payment_item_description' => 'setPaymentItemDescription', + 'payment_item_name' => 'setPaymentItemName', 'required' => 'setRequired', 'scale_value' => 'setScaleValue', + 'selected' => 'setSelected', 'shared' => 'setShared', + 'stamp_type' => 'setStampType', + 'stamp_type_metadata' => 'setStampTypeMetadata', 'tab_label' => 'setTabLabel', 'type' => 'setType', 'underline' => 'setUnderline', @@ -229,9 +247,15 @@ public static function swaggerTypes() 'maximum_length' => 'getMaximumLength', 'merge_field' => 'getMergeField', 'name' => 'getName', + 'payment_item_code' => 'getPaymentItemCode', + 'payment_item_description' => 'getPaymentItemDescription', + 'payment_item_name' => 'getPaymentItemName', 'required' => 'getRequired', 'scale_value' => 'getScaleValue', + 'selected' => 'getSelected', 'shared' => 'getShared', + 'stamp_type' => 'getStampType', + 'stamp_type_metadata' => 'getStampTypeMetadata', 'tab_label' => 'getTabLabel', 'type' => 'getType', 'underline' => 'getUnderline', @@ -301,9 +325,15 @@ public function __construct(array $data = null) $this->container['maximum_length'] = isset($data['maximum_length']) ? $data['maximum_length'] : null; $this->container['merge_field'] = isset($data['merge_field']) ? $data['merge_field'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['payment_item_code'] = isset($data['payment_item_code']) ? $data['payment_item_code'] : null; + $this->container['payment_item_description'] = isset($data['payment_item_description']) ? $data['payment_item_description'] : null; + $this->container['payment_item_name'] = isset($data['payment_item_name']) ? $data['payment_item_name'] : null; $this->container['required'] = isset($data['required']) ? $data['required'] : null; $this->container['scale_value'] = isset($data['scale_value']) ? $data['scale_value'] : null; + $this->container['selected'] = isset($data['selected']) ? $data['selected'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; + $this->container['stamp_type'] = isset($data['stamp_type']) ? $data['stamp_type'] : null; + $this->container['stamp_type_metadata'] = isset($data['stamp_type_metadata']) ? $data['stamp_type_metadata'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; @@ -472,7 +502,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -493,7 +523,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -965,6 +995,69 @@ public function setName($name) return $this; } + /** + * Gets payment_item_code + * @return string + */ + public function getPaymentItemCode() + { + return $this->container['payment_item_code']; + } + + /** + * Sets payment_item_code + * @param string $payment_item_code + * @return $this + */ + public function setPaymentItemCode($payment_item_code) + { + $this->container['payment_item_code'] = $payment_item_code; + + return $this; + } + + /** + * Gets payment_item_description + * @return string + */ + public function getPaymentItemDescription() + { + return $this->container['payment_item_description']; + } + + /** + * Sets payment_item_description + * @param string $payment_item_description + * @return $this + */ + public function setPaymentItemDescription($payment_item_description) + { + $this->container['payment_item_description'] = $payment_item_description; + + return $this; + } + + /** + * Gets payment_item_name + * @return string + */ + public function getPaymentItemName() + { + return $this->container['payment_item_name']; + } + + /** + * Sets payment_item_name + * @param string $payment_item_name + * @return $this + */ + public function setPaymentItemName($payment_item_name) + { + $this->container['payment_item_name'] = $payment_item_name; + + return $this; + } + /** * Gets required * @return string @@ -1007,6 +1100,27 @@ public function setScaleValue($scale_value) return $this; } + /** + * Gets selected + * @return string + */ + public function getSelected() + { + return $this->container['selected']; + } + + /** + * Sets selected + * @param string $selected + * @return $this + */ + public function setSelected($selected) + { + $this->container['selected'] = $selected; + + return $this; + } + /** * Gets shared * @return string @@ -1028,6 +1142,48 @@ public function setShared($shared) return $this; } + /** + * Gets stamp_type + * @return string + */ + public function getStampType() + { + return $this->container['stamp_type']; + } + + /** + * Sets stamp_type + * @param string $stamp_type + * @return $this + */ + public function setStampType($stamp_type) + { + $this->container['stamp_type'] = $stamp_type; + + return $this; + } + + /** + * Gets stamp_type_metadata + * @return \DocuSign\eSign\Model\PropertyMetadata + */ + public function getStampTypeMetadata() + { + return $this->container['stamp_type_metadata']; + } + + /** + * Sets stamp_type_metadata + * @param \DocuSign\eSign\Model\PropertyMetadata $stamp_type_metadata + * @return $this + */ + public function setStampTypeMetadata($stamp_type_metadata) + { + $this->container['stamp_type_metadata'] = $stamp_type_metadata; + + return $this; + } + /** * Gets tab_label * @return string @@ -1123,7 +1279,7 @@ public function getValidationPattern() /** * Sets validation_pattern - * @param string $validation_pattern A regular expressionn used to validate input for the tab. + * @param string $validation_pattern A regular expression used to validate input for the tab. * @return $this */ public function setValidationPattern($validation_pattern) diff --git a/src/Model/Tabs.php b/src/Model/Tabs.php index dde769ce..ebd5fe76 100644 --- a/src/Model/Tabs.php +++ b/src/Model/Tabs.php @@ -58,7 +58,7 @@ class Tabs implements ArrayAccess 'checkbox_tabs' => '\DocuSign\eSign\Model\Checkbox[]', 'company_tabs' => '\DocuSign\eSign\Model\Company[]', 'date_signed_tabs' => '\DocuSign\eSign\Model\DateSigned[]', - 'date_tabs' => '\DocuSign\eSign\Model\\Date[]', + 'date_tabs' => '\DocuSign\eSign\Model\\DateTime[]', 'decline_tabs' => '\DocuSign\eSign\Model\Decline[]', 'email_address_tabs' => '\DocuSign\eSign\Model\EmailAddress[]', 'email_tabs' => '\DocuSign\eSign\Model\Email[]', @@ -69,11 +69,13 @@ class Tabs implements ArrayAccess 'initial_here_tabs' => '\DocuSign\eSign\Model\InitialHere[]', 'last_name_tabs' => '\DocuSign\eSign\Model\LastName[]', 'list_tabs' => '\DocuSign\eSign\Model\array[]', + 'notarize_tabs' => '\DocuSign\eSign\Model\Notarize[]', 'note_tabs' => '\DocuSign\eSign\Model\Note[]', 'number_tabs' => '\DocuSign\eSign\Model\Number[]', 'radio_group_tabs' => '\DocuSign\eSign\Model\RadioGroup[]', 'signer_attachment_tabs' => '\DocuSign\eSign\Model\SignerAttachment[]', 'sign_here_tabs' => '\DocuSign\eSign\Model\SignHere[]', + 'smart_section_tabs' => '\DocuSign\eSign\Model\SmartSection[]', 'ssn_tabs' => '\DocuSign\eSign\Model\Ssn[]', 'text_tabs' => '\DocuSign\eSign\Model\Text[]', 'title_tabs' => '\DocuSign\eSign\Model\Title[]', @@ -106,11 +108,13 @@ public static function swaggerTypes() 'initial_here_tabs' => 'initialHereTabs', 'last_name_tabs' => 'lastNameTabs', 'list_tabs' => 'listTabs', + 'notarize_tabs' => 'notarizeTabs', 'note_tabs' => 'noteTabs', 'number_tabs' => 'numberTabs', 'radio_group_tabs' => 'radioGroupTabs', 'signer_attachment_tabs' => 'signerAttachmentTabs', 'sign_here_tabs' => 'signHereTabs', + 'smart_section_tabs' => 'smartSectionTabs', 'ssn_tabs' => 'ssnTabs', 'text_tabs' => 'textTabs', 'title_tabs' => 'titleTabs', @@ -139,11 +143,13 @@ public static function swaggerTypes() 'initial_here_tabs' => 'setInitialHereTabs', 'last_name_tabs' => 'setLastNameTabs', 'list_tabs' => 'setListTabs', + 'notarize_tabs' => 'setNotarizeTabs', 'note_tabs' => 'setNoteTabs', 'number_tabs' => 'setNumberTabs', 'radio_group_tabs' => 'setRadioGroupTabs', 'signer_attachment_tabs' => 'setSignerAttachmentTabs', 'sign_here_tabs' => 'setSignHereTabs', + 'smart_section_tabs' => 'setSmartSectionTabs', 'ssn_tabs' => 'setSsnTabs', 'text_tabs' => 'setTextTabs', 'title_tabs' => 'setTitleTabs', @@ -172,11 +178,13 @@ public static function swaggerTypes() 'initial_here_tabs' => 'getInitialHereTabs', 'last_name_tabs' => 'getLastNameTabs', 'list_tabs' => 'getListTabs', + 'notarize_tabs' => 'getNotarizeTabs', 'note_tabs' => 'getNoteTabs', 'number_tabs' => 'getNumberTabs', 'radio_group_tabs' => 'getRadioGroupTabs', 'signer_attachment_tabs' => 'getSignerAttachmentTabs', 'sign_here_tabs' => 'getSignHereTabs', + 'smart_section_tabs' => 'getSmartSectionTabs', 'ssn_tabs' => 'getSsnTabs', 'text_tabs' => 'getTextTabs', 'title_tabs' => 'getTitleTabs', @@ -230,11 +238,13 @@ public function __construct(array $data = null) $this->container['initial_here_tabs'] = isset($data['initial_here_tabs']) ? $data['initial_here_tabs'] : null; $this->container['last_name_tabs'] = isset($data['last_name_tabs']) ? $data['last_name_tabs'] : null; $this->container['list_tabs'] = isset($data['list_tabs']) ? $data['list_tabs'] : null; + $this->container['notarize_tabs'] = isset($data['notarize_tabs']) ? $data['notarize_tabs'] : null; $this->container['note_tabs'] = isset($data['note_tabs']) ? $data['note_tabs'] : null; $this->container['number_tabs'] = isset($data['number_tabs']) ? $data['number_tabs'] : null; $this->container['radio_group_tabs'] = isset($data['radio_group_tabs']) ? $data['radio_group_tabs'] : null; $this->container['signer_attachment_tabs'] = isset($data['signer_attachment_tabs']) ? $data['signer_attachment_tabs'] : null; $this->container['sign_here_tabs'] = isset($data['sign_here_tabs']) ? $data['sign_here_tabs'] : null; + $this->container['smart_section_tabs'] = isset($data['smart_section_tabs']) ? $data['smart_section_tabs'] : null; $this->container['ssn_tabs'] = isset($data['ssn_tabs']) ? $data['ssn_tabs'] : null; $this->container['text_tabs'] = isset($data['text_tabs']) ? $data['text_tabs'] : null; $this->container['title_tabs'] = isset($data['title_tabs']) ? $data['title_tabs'] : null; @@ -402,7 +412,7 @@ public function getEmailAddressTabs() /** * Sets email_address_tabs - * @param \DocuSign\eSign\Model\EmailAddress[] $email_address_tabs Specifies a location on the document where you want where you want the recipient’s email, as entered in the recipient information, to display. + * @param \DocuSign\eSign\Model\EmailAddress[] $email_address_tabs Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display. * @return $this */ public function setEmailAddressTabs($email_address_tabs) @@ -549,7 +559,7 @@ public function getLastNameTabs() /** * Sets last_name_tabs - * @param \DocuSign\eSign\Model\LastName[] $last_name_tabs Specifies a tag on a document where you want the recipient’s last name to appear. This tag takes the recipient’s name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. + * @param \DocuSign\eSign\Model\LastName[] $last_name_tabs Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. * @return $this */ public function setLastNameTabs($last_name_tabs) @@ -580,6 +590,27 @@ public function setListTabs($list_tabs) return $this; } + /** + * Gets notarize_tabs + * @return \DocuSign\eSign\Model\Notarize[] + */ + public function getNotarizeTabs() + { + return $this->container['notarize_tabs']; + } + + /** + * Sets notarize_tabs + * @param \DocuSign\eSign\Model\Notarize[] $notarize_tabs + * @return $this + */ + public function setNotarizeTabs($notarize_tabs) + { + $this->container['notarize_tabs'] = $notarize_tabs; + + return $this; + } + /** * Gets note_tabs * @return \DocuSign\eSign\Model\Note[] @@ -685,6 +716,27 @@ public function setSignHereTabs($sign_here_tabs) return $this; } + /** + * Gets smart_section_tabs + * @return \DocuSign\eSign\Model\SmartSection[] + */ + public function getSmartSectionTabs() + { + return $this->container['smart_section_tabs']; + } + + /** + * Sets smart_section_tabs + * @param \DocuSign\eSign\Model\SmartSection[] $smart_section_tabs + * @return $this + */ + public function setSmartSectionTabs($smart_section_tabs) + { + $this->container['smart_section_tabs'] = $smart_section_tabs; + + return $this; + } + /** * Gets ssn_tabs * @return \DocuSign\eSign\Model\Ssn[] diff --git a/src/Model/TemplateRecipients.php b/src/Model/TemplateRecipients.php index c546ea24..f782d68f 100644 --- a/src/Model/TemplateRecipients.php +++ b/src/Model/TemplateRecipients.php @@ -63,7 +63,9 @@ class TemplateRecipients implements ArrayAccess 'in_person_signers' => '\DocuSign\eSign\Model\InPersonSigner[]', 'intermediaries' => '\DocuSign\eSign\Model\Intermediary[]', 'recipient_count' => 'string', - 'signers' => '\DocuSign\eSign\Model\Signer[]' + 'seals' => '\DocuSign\eSign\Model\SealSign[]', + 'signers' => '\DocuSign\eSign\Model\Signer[]', + 'witnesses' => '\DocuSign\eSign\Model\Witness[]' ]; public static function swaggerTypes() @@ -85,7 +87,9 @@ public static function swaggerTypes() 'in_person_signers' => 'inPersonSigners', 'intermediaries' => 'intermediaries', 'recipient_count' => 'recipientCount', - 'signers' => 'signers' + 'seals' => 'seals', + 'signers' => 'signers', + 'witnesses' => 'witnesses' ]; @@ -103,7 +107,9 @@ public static function swaggerTypes() 'in_person_signers' => 'setInPersonSigners', 'intermediaries' => 'setIntermediaries', 'recipient_count' => 'setRecipientCount', - 'signers' => 'setSigners' + 'seals' => 'setSeals', + 'signers' => 'setSigners', + 'witnesses' => 'setWitnesses' ]; @@ -121,7 +127,9 @@ public static function swaggerTypes() 'in_person_signers' => 'getInPersonSigners', 'intermediaries' => 'getIntermediaries', 'recipient_count' => 'getRecipientCount', - 'signers' => 'getSigners' + 'seals' => 'getSeals', + 'signers' => 'getSigners', + 'witnesses' => 'getWitnesses' ]; public static function attributeMap() @@ -164,7 +172,9 @@ public function __construct(array $data = null) $this->container['in_person_signers'] = isset($data['in_person_signers']) ? $data['in_person_signers'] : null; $this->container['intermediaries'] = isset($data['intermediaries']) ? $data['intermediaries'] : null; $this->container['recipient_count'] = isset($data['recipient_count']) ? $data['recipient_count'] : null; + $this->container['seals'] = isset($data['seals']) ? $data['seals'] : null; $this->container['signers'] = isset($data['signers']) ? $data['signers'] : null; + $this->container['witnesses'] = isset($data['witnesses']) ? $data['witnesses'] : null; } /** @@ -379,6 +389,27 @@ public function setRecipientCount($recipient_count) return $this; } + /** + * Gets seals + * @return \DocuSign\eSign\Model\SealSign[] + */ + public function getSeals() + { + return $this->container['seals']; + } + + /** + * Sets seals + * @param \DocuSign\eSign\Model\SealSign[] $seals + * @return $this + */ + public function setSeals($seals) + { + $this->container['seals'] = $seals; + + return $this; + } + /** * Gets signers * @return \DocuSign\eSign\Model\Signer[] @@ -399,6 +430,27 @@ public function setSigners($signers) return $this; } + + /** + * Gets witnesses + * @return \DocuSign\eSign\Model\Witness[] + */ + public function getWitnesses() + { + return $this->container['witnesses']; + } + + /** + * Sets witnesses + * @param \DocuSign\eSign\Model\Witness[] $witnesses + * @return $this + */ + public function setWitnesses($witnesses) + { + $this->container['witnesses'] = $witnesses; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/src/Model/TemplateRole.php b/src/Model/TemplateRole.php index 15d371d1..32b9954b 100644 --- a/src/Model/TemplateRole.php +++ b/src/Model/TemplateRole.php @@ -62,6 +62,7 @@ class TemplateRole implements ArrayAccess 'embedded_recipient_start_url' => 'string', 'in_person_signer_name' => 'string', 'name' => 'string', + 'recipient_signature_providers' => '\DocuSign\eSign\Model\RecipientSignatureProvider[]', 'role_name' => 'string', 'routing_order' => 'string', 'signing_group_id' => 'string', @@ -86,6 +87,7 @@ public static function swaggerTypes() 'embedded_recipient_start_url' => 'embeddedRecipientStartURL', 'in_person_signer_name' => 'inPersonSignerName', 'name' => 'name', + 'recipient_signature_providers' => 'recipientSignatureProviders', 'role_name' => 'roleName', 'routing_order' => 'routingOrder', 'signing_group_id' => 'signingGroupId', @@ -106,6 +108,7 @@ public static function swaggerTypes() 'embedded_recipient_start_url' => 'setEmbeddedRecipientStartUrl', 'in_person_signer_name' => 'setInPersonSignerName', 'name' => 'setName', + 'recipient_signature_providers' => 'setRecipientSignatureProviders', 'role_name' => 'setRoleName', 'routing_order' => 'setRoutingOrder', 'signing_group_id' => 'setSigningGroupId', @@ -126,6 +129,7 @@ public static function swaggerTypes() 'embedded_recipient_start_url' => 'getEmbeddedRecipientStartUrl', 'in_person_signer_name' => 'getInPersonSignerName', 'name' => 'getName', + 'recipient_signature_providers' => 'getRecipientSignatureProviders', 'role_name' => 'getRoleName', 'routing_order' => 'getRoutingOrder', 'signing_group_id' => 'getSigningGroupId', @@ -171,6 +175,7 @@ public function __construct(array $data = null) $this->container['embedded_recipient_start_url'] = isset($data['embedded_recipient_start_url']) ? $data['embedded_recipient_start_url'] : null; $this->container['in_person_signer_name'] = isset($data['in_person_signer_name']) ? $data['in_person_signer_name'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['recipient_signature_providers'] = isset($data['recipient_signature_providers']) ? $data['recipient_signature_providers'] : null; $this->container['role_name'] = isset($data['role_name']) ? $data['role_name'] : null; $this->container['routing_order'] = isset($data['routing_order']) ? $data['routing_order'] : null; $this->container['signing_group_id'] = isset($data['signing_group_id']) ? $data['signing_group_id'] : null; @@ -211,7 +216,7 @@ public function getAccessCode() /** * Sets access_code - * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. * @return $this */ public function setAccessCode($access_code) @@ -316,7 +321,7 @@ public function getEmbeddedRecipientStartUrl() /** * Sets embedded_recipient_start_url - * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` * @return $this */ public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) @@ -368,6 +373,27 @@ public function setName($name) return $this; } + /** + * Gets recipient_signature_providers + * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] + */ + public function getRecipientSignatureProviders() + { + return $this->container['recipient_signature_providers']; + } + + /** + * Sets recipient_signature_providers + * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * @return $this + */ + public function setRecipientSignatureProviders($recipient_signature_providers) + { + $this->container['recipient_signature_providers'] = $recipient_signature_providers; + + return $this; + } + /** * Gets role_name * @return string diff --git a/src/Model/TemplateTabs.php b/src/Model/TemplateTabs.php index 06f0f332..1b9c8a84 100644 --- a/src/Model/TemplateTabs.php +++ b/src/Model/TemplateTabs.php @@ -69,11 +69,13 @@ class TemplateTabs implements ArrayAccess 'initial_here_tabs' => '\DocuSign\eSign\Model\InitialHere[]', 'last_name_tabs' => '\DocuSign\eSign\Model\LastName[]', 'list_tabs' => '\DocuSign\eSign\Model\array[]', + 'notarize_tabs' => '\DocuSign\eSign\Model\Notarize[]', 'note_tabs' => '\DocuSign\eSign\Model\Note[]', 'number_tabs' => '\DocuSign\eSign\Model\Number[]', 'radio_group_tabs' => '\DocuSign\eSign\Model\RadioGroup[]', 'signer_attachment_tabs' => '\DocuSign\eSign\Model\SignerAttachment[]', 'sign_here_tabs' => '\DocuSign\eSign\Model\SignHere[]', + 'smart_section_tabs' => '\DocuSign\eSign\Model\SmartSection[]', 'ssn_tabs' => '\DocuSign\eSign\Model\Ssn[]', 'text_tabs' => '\DocuSign\eSign\Model\Text[]', 'title_tabs' => '\DocuSign\eSign\Model\Title[]', @@ -106,11 +108,13 @@ public static function swaggerTypes() 'initial_here_tabs' => 'initialHereTabs', 'last_name_tabs' => 'lastNameTabs', 'list_tabs' => 'listTabs', + 'notarize_tabs' => 'notarizeTabs', 'note_tabs' => 'noteTabs', 'number_tabs' => 'numberTabs', 'radio_group_tabs' => 'radioGroupTabs', 'signer_attachment_tabs' => 'signerAttachmentTabs', 'sign_here_tabs' => 'signHereTabs', + 'smart_section_tabs' => 'smartSectionTabs', 'ssn_tabs' => 'ssnTabs', 'text_tabs' => 'textTabs', 'title_tabs' => 'titleTabs', @@ -139,11 +143,13 @@ public static function swaggerTypes() 'initial_here_tabs' => 'setInitialHereTabs', 'last_name_tabs' => 'setLastNameTabs', 'list_tabs' => 'setListTabs', + 'notarize_tabs' => 'setNotarizeTabs', 'note_tabs' => 'setNoteTabs', 'number_tabs' => 'setNumberTabs', 'radio_group_tabs' => 'setRadioGroupTabs', 'signer_attachment_tabs' => 'setSignerAttachmentTabs', 'sign_here_tabs' => 'setSignHereTabs', + 'smart_section_tabs' => 'setSmartSectionTabs', 'ssn_tabs' => 'setSsnTabs', 'text_tabs' => 'setTextTabs', 'title_tabs' => 'setTitleTabs', @@ -172,11 +178,13 @@ public static function swaggerTypes() 'initial_here_tabs' => 'getInitialHereTabs', 'last_name_tabs' => 'getLastNameTabs', 'list_tabs' => 'getListTabs', + 'notarize_tabs' => 'getNotarizeTabs', 'note_tabs' => 'getNoteTabs', 'number_tabs' => 'getNumberTabs', 'radio_group_tabs' => 'getRadioGroupTabs', 'signer_attachment_tabs' => 'getSignerAttachmentTabs', 'sign_here_tabs' => 'getSignHereTabs', + 'smart_section_tabs' => 'getSmartSectionTabs', 'ssn_tabs' => 'getSsnTabs', 'text_tabs' => 'getTextTabs', 'title_tabs' => 'getTitleTabs', @@ -230,11 +238,13 @@ public function __construct(array $data = null) $this->container['initial_here_tabs'] = isset($data['initial_here_tabs']) ? $data['initial_here_tabs'] : null; $this->container['last_name_tabs'] = isset($data['last_name_tabs']) ? $data['last_name_tabs'] : null; $this->container['list_tabs'] = isset($data['list_tabs']) ? $data['list_tabs'] : null; + $this->container['notarize_tabs'] = isset($data['notarize_tabs']) ? $data['notarize_tabs'] : null; $this->container['note_tabs'] = isset($data['note_tabs']) ? $data['note_tabs'] : null; $this->container['number_tabs'] = isset($data['number_tabs']) ? $data['number_tabs'] : null; $this->container['radio_group_tabs'] = isset($data['radio_group_tabs']) ? $data['radio_group_tabs'] : null; $this->container['signer_attachment_tabs'] = isset($data['signer_attachment_tabs']) ? $data['signer_attachment_tabs'] : null; $this->container['sign_here_tabs'] = isset($data['sign_here_tabs']) ? $data['sign_here_tabs'] : null; + $this->container['smart_section_tabs'] = isset($data['smart_section_tabs']) ? $data['smart_section_tabs'] : null; $this->container['ssn_tabs'] = isset($data['ssn_tabs']) ? $data['ssn_tabs'] : null; $this->container['text_tabs'] = isset($data['text_tabs']) ? $data['text_tabs'] : null; $this->container['title_tabs'] = isset($data['title_tabs']) ? $data['title_tabs'] : null; @@ -402,7 +412,7 @@ public function getEmailAddressTabs() /** * Sets email_address_tabs - * @param \DocuSign\eSign\Model\EmailAddress[] $email_address_tabs Specifies a location on the document where you want where you want the recipient’s email, as entered in the recipient information, to display. + * @param \DocuSign\eSign\Model\EmailAddress[] $email_address_tabs Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display. * @return $this */ public function setEmailAddressTabs($email_address_tabs) @@ -549,7 +559,7 @@ public function getLastNameTabs() /** * Sets last_name_tabs - * @param \DocuSign\eSign\Model\LastName[] $last_name_tabs Specifies a tag on a document where you want the recipient’s last name to appear. This tag takes the recipient’s name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. + * @param \DocuSign\eSign\Model\LastName[] $last_name_tabs Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. * @return $this */ public function setLastNameTabs($last_name_tabs) @@ -580,6 +590,27 @@ public function setListTabs($list_tabs) return $this; } + /** + * Gets notarize_tabs + * @return \DocuSign\eSign\Model\Notarize[] + */ + public function getNotarizeTabs() + { + return $this->container['notarize_tabs']; + } + + /** + * Sets notarize_tabs + * @param \DocuSign\eSign\Model\Notarize[] $notarize_tabs + * @return $this + */ + public function setNotarizeTabs($notarize_tabs) + { + $this->container['notarize_tabs'] = $notarize_tabs; + + return $this; + } + /** * Gets note_tabs * @return \DocuSign\eSign\Model\Note[] @@ -685,6 +716,27 @@ public function setSignHereTabs($sign_here_tabs) return $this; } + /** + * Gets smart_section_tabs + * @return \DocuSign\eSign\Model\SmartSection[] + */ + public function getSmartSectionTabs() + { + return $this->container['smart_section_tabs']; + } + + /** + * Sets smart_section_tabs + * @param \DocuSign\eSign\Model\SmartSection[] $smart_section_tabs + * @return $this + */ + public function setSmartSectionTabs($smart_section_tabs) + { + $this->container['smart_section_tabs'] = $smart_section_tabs; + + return $this; + } + /** * Gets ssn_tabs * @return \DocuSign\eSign\Model\Ssn[] diff --git a/src/Model/Text.php b/src/Model/Text.php index 84722edd..01930922 100644 --- a/src/Model/Text.php +++ b/src/Model/Text.php @@ -90,11 +90,13 @@ class Text implements ArrayAccess 'sender_required' => 'string', 'shared' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'validation_message' => 'string', 'validation_pattern' => 'string', @@ -150,11 +152,13 @@ public static function swaggerTypes() 'sender_required' => 'senderRequired', 'shared' => 'shared', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'validation_message' => 'validationMessage', 'validation_pattern' => 'validationPattern', @@ -206,11 +210,13 @@ public static function swaggerTypes() 'sender_required' => 'setSenderRequired', 'shared' => 'setShared', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'validation_message' => 'setValidationMessage', 'validation_pattern' => 'setValidationPattern', @@ -262,11 +268,13 @@ public static function swaggerTypes() 'sender_required' => 'getSenderRequired', 'shared' => 'getShared', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'validation_message' => 'getValidationMessage', 'validation_pattern' => 'getValidationPattern', @@ -343,11 +351,13 @@ public function __construct(array $data = null) $this->container['sender_required'] = isset($data['sender_required']) ? $data['sender_required'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['validation_message'] = isset($data['validation_message']) ? $data['validation_message'] : null; $this->container['validation_pattern'] = isset($data['validation_pattern']) ? $data['validation_pattern'] : null; @@ -517,7 +527,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -538,7 +548,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -1136,6 +1146,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -1241,6 +1272,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -1294,7 +1346,7 @@ public function getValidationPattern() /** * Sets validation_pattern - * @param string $validation_pattern A regular expressionn used to validate input for the tab. + * @param string $validation_pattern A regular expression used to validate input for the tab. * @return $this */ public function setValidationPattern($validation_pattern) diff --git a/src/Model/TimeStampField.php b/src/Model/TimeStampField.php new file mode 100644 index 00000000..4c3d6e7f --- /dev/null +++ b/src/Model/TimeStampField.php @@ -0,0 +1,279 @@ + '\DocuSign\eSign\Model\DocumentSecurityStore', + 'max_time_stamp_signature_length' => 'string', + 'time_stamp_field_name' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'document_security_store' => 'documentSecurityStore', + 'max_time_stamp_signature_length' => 'maxTimeStampSignatureLength', + 'time_stamp_field_name' => 'timeStampFieldName' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'document_security_store' => 'setDocumentSecurityStore', + 'max_time_stamp_signature_length' => 'setMaxTimeStampSignatureLength', + 'time_stamp_field_name' => 'setTimeStampFieldName' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'document_security_store' => 'getDocumentSecurityStore', + 'max_time_stamp_signature_length' => 'getMaxTimeStampSignatureLength', + 'time_stamp_field_name' => 'getTimeStampFieldName' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['document_security_store'] = isset($data['document_security_store']) ? $data['document_security_store'] : null; + $this->container['max_time_stamp_signature_length'] = isset($data['max_time_stamp_signature_length']) ? $data['max_time_stamp_signature_length'] : null; + $this->container['time_stamp_field_name'] = isset($data['time_stamp_field_name']) ? $data['time_stamp_field_name'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets document_security_store + * @return \DocuSign\eSign\Model\DocumentSecurityStore + */ + public function getDocumentSecurityStore() + { + return $this->container['document_security_store']; + } + + /** + * Sets document_security_store + * @param \DocuSign\eSign\Model\DocumentSecurityStore $document_security_store + * @return $this + */ + public function setDocumentSecurityStore($document_security_store) + { + $this->container['document_security_store'] = $document_security_store; + + return $this; + } + + /** + * Gets max_time_stamp_signature_length + * @return string + */ + public function getMaxTimeStampSignatureLength() + { + return $this->container['max_time_stamp_signature_length']; + } + + /** + * Sets max_time_stamp_signature_length + * @param string $max_time_stamp_signature_length + * @return $this + */ + public function setMaxTimeStampSignatureLength($max_time_stamp_signature_length) + { + $this->container['max_time_stamp_signature_length'] = $max_time_stamp_signature_length; + + return $this; + } + + /** + * Gets time_stamp_field_name + * @return string + */ + public function getTimeStampFieldName() + { + return $this->container['time_stamp_field_name']; + } + + /** + * Sets time_stamp_field_name + * @param string $time_stamp_field_name + * @return $this + */ + public function setTimeStampFieldName($time_stamp_field_name) + { + $this->container['time_stamp_field_name'] = $time_stamp_field_name; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Title.php b/src/Model/Title.php index 06d51edd..5f4801f2 100644 --- a/src/Model/Title.php +++ b/src/Model/Title.php @@ -83,11 +83,13 @@ class Title implements ArrayAccess 'recipient_id' => 'string', 'required' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'value' => 'string', 'width' => 'int', @@ -134,11 +136,13 @@ public static function swaggerTypes() 'recipient_id' => 'recipientId', 'required' => 'required', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'value' => 'value', 'width' => 'width', @@ -181,11 +185,13 @@ public static function swaggerTypes() 'recipient_id' => 'setRecipientId', 'required' => 'setRequired', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'value' => 'setValue', 'width' => 'setWidth', @@ -228,11 +234,13 @@ public static function swaggerTypes() 'recipient_id' => 'getRecipientId', 'required' => 'getRequired', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'value' => 'getValue', 'width' => 'getWidth', @@ -300,11 +308,13 @@ public function __construct(array $data = null) $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; $this->container['required'] = isset($data['required']) ? $data['required'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['width'] = isset($data['width']) ? $data['width'] : null; @@ -472,7 +482,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -493,7 +503,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -944,6 +954,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -1049,6 +1080,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string diff --git a/src/Model/TspHealthCheckRequest.php b/src/Model/TspHealthCheckRequest.php new file mode 100644 index 00000000..f911d5c0 --- /dev/null +++ b/src/Model/TspHealthCheckRequest.php @@ -0,0 +1,331 @@ + 'string', + 'description' => 'string', + 'error' => 'string', + 'status' => 'string', + 'status_description' => '\DocuSign\eSign\Model\TspHealthCheckStatusDescription[]' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'app_version' => 'appVersion', + 'description' => 'description', + 'error' => 'error', + 'status' => 'status', + 'status_description' => 'statusDescription' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'app_version' => 'setAppVersion', + 'description' => 'setDescription', + 'error' => 'setError', + 'status' => 'setStatus', + 'status_description' => 'setStatusDescription' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'app_version' => 'getAppVersion', + 'description' => 'getDescription', + 'error' => 'getError', + 'status' => 'getStatus', + 'status_description' => 'getStatusDescription' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['app_version'] = isset($data['app_version']) ? $data['app_version'] : null; + $this->container['description'] = isset($data['description']) ? $data['description'] : null; + $this->container['error'] = isset($data['error']) ? $data['error'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['status_description'] = isset($data['status_description']) ? $data['status_description'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets app_version + * @return string + */ + public function getAppVersion() + { + return $this->container['app_version']; + } + + /** + * Sets app_version + * @param string $app_version + * @return $this + */ + public function setAppVersion($app_version) + { + $this->container['app_version'] = $app_version; + + return $this; + } + + /** + * Gets description + * @return string + */ + public function getDescription() + { + return $this->container['description']; + } + + /** + * Sets description + * @param string $description + * @return $this + */ + public function setDescription($description) + { + $this->container['description'] = $description; + + return $this; + } + + /** + * Gets error + * @return string + */ + public function getError() + { + return $this->container['error']; + } + + /** + * Sets error + * @param string $error + * @return $this + */ + public function setError($error) + { + $this->container['error'] = $error; + + return $this; + } + + /** + * Gets status + * @return string + */ + public function getStatus() + { + return $this->container['status']; + } + + /** + * Sets status + * @param string $status Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. + * @return $this + */ + public function setStatus($status) + { + $this->container['status'] = $status; + + return $this; + } + + /** + * Gets status_description + * @return \DocuSign\eSign\Model\TspHealthCheckStatusDescription[] + */ + public function getStatusDescription() + { + return $this->container['status_description']; + } + + /** + * Sets status_description + * @param \DocuSign\eSign\Model\TspHealthCheckStatusDescription[] $status_description + * @return $this + */ + public function setStatusDescription($status_description) + { + $this->container['status_description'] = $status_description; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/OfflineAttributes.php b/src/Model/TspHealthCheckStatusDescription.php similarity index 54% rename from src/Model/OfflineAttributes.php rename to src/Model/TspHealthCheckStatusDescription.php index 084f8f36..165ea02b 100644 --- a/src/Model/OfflineAttributes.php +++ b/src/Model/TspHealthCheckStatusDescription.php @@ -1,6 +1,6 @@ 'string', - 'device_model' => 'string', - 'device_name' => 'string', - 'gps_latitude' => 'string', - 'gps_longitude' => 'string', - 'offline_signing_hash' => 'string' + 'description' => 'string', + 'error' => 'string', + 'hostname' => 'string', + 'response_seconds' => 'string', + 'status' => 'string', + 'type' => 'string' ]; public static function swaggerTypes() @@ -73,12 +72,12 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ - 'account_esign_id' => 'accountEsignId', - 'device_model' => 'deviceModel', - 'device_name' => 'deviceName', - 'gps_latitude' => 'gpsLatitude', - 'gps_longitude' => 'gpsLongitude', - 'offline_signing_hash' => 'offlineSigningHash' + 'description' => 'description', + 'error' => 'error', + 'hostname' => 'hostname', + 'response_seconds' => 'responseSeconds', + 'status' => 'status', + 'type' => 'type' ]; @@ -87,12 +86,12 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ - 'account_esign_id' => 'setAccountEsignId', - 'device_model' => 'setDeviceModel', - 'device_name' => 'setDeviceName', - 'gps_latitude' => 'setGpsLatitude', - 'gps_longitude' => 'setGpsLongitude', - 'offline_signing_hash' => 'setOfflineSigningHash' + 'description' => 'setDescription', + 'error' => 'setError', + 'hostname' => 'setHostname', + 'response_seconds' => 'setResponseSeconds', + 'status' => 'setStatus', + 'type' => 'setType' ]; @@ -101,12 +100,12 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ - 'account_esign_id' => 'getAccountEsignId', - 'device_model' => 'getDeviceModel', - 'device_name' => 'getDeviceName', - 'gps_latitude' => 'getGpsLatitude', - 'gps_longitude' => 'getGpsLongitude', - 'offline_signing_hash' => 'getOfflineSigningHash' + 'description' => 'getDescription', + 'error' => 'getError', + 'hostname' => 'getHostname', + 'response_seconds' => 'getResponseSeconds', + 'status' => 'getStatus', + 'type' => 'getType' ]; public static function attributeMap() @@ -140,12 +139,12 @@ public static function getters() */ public function __construct(array $data = null) { - $this->container['account_esign_id'] = isset($data['account_esign_id']) ? $data['account_esign_id'] : null; - $this->container['device_model'] = isset($data['device_model']) ? $data['device_model'] : null; - $this->container['device_name'] = isset($data['device_name']) ? $data['device_name'] : null; - $this->container['gps_latitude'] = isset($data['gps_latitude']) ? $data['gps_latitude'] : null; - $this->container['gps_longitude'] = isset($data['gps_longitude']) ? $data['gps_longitude'] : null; - $this->container['offline_signing_hash'] = isset($data['offline_signing_hash']) ? $data['offline_signing_hash'] : null; + $this->container['description'] = isset($data['description']) ? $data['description'] : null; + $this->container['error'] = isset($data['error']) ? $data['error'] : null; + $this->container['hostname'] = isset($data['hostname']) ? $data['hostname'] : null; + $this->container['response_seconds'] = isset($data['response_seconds']) ? $data['response_seconds'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['type'] = isset($data['type']) ? $data['type'] : null; } /** @@ -172,127 +171,127 @@ public function valid() /** - * Gets account_esign_id + * Gets description * @return string */ - public function getAccountEsignId() + public function getDescription() { - return $this->container['account_esign_id']; + return $this->container['description']; } /** - * Sets account_esign_id - * @param string $account_esign_id A GUID identifying the account associated with the consumer disclosure + * Sets description + * @param string $description * @return $this */ - public function setAccountEsignId($account_esign_id) + public function setDescription($description) { - $this->container['account_esign_id'] = $account_esign_id; + $this->container['description'] = $description; return $this; } /** - * Gets device_model + * Gets error * @return string */ - public function getDeviceModel() + public function getError() { - return $this->container['device_model']; + return $this->container['error']; } /** - * Sets device_model - * @param string $device_model A string containing information about the model of the device used for offline signing. + * Sets error + * @param string $error * @return $this */ - public function setDeviceModel($device_model) + public function setError($error) { - $this->container['device_model'] = $device_model; + $this->container['error'] = $error; return $this; } /** - * Gets device_name + * Gets hostname * @return string */ - public function getDeviceName() + public function getHostname() { - return $this->container['device_name']; + return $this->container['hostname']; } /** - * Sets device_name - * @param string $device_name A string containing information about the type of device used for offline signing. + * Sets hostname + * @param string $hostname * @return $this */ - public function setDeviceName($device_name) + public function setHostname($hostname) { - $this->container['device_name'] = $device_name; + $this->container['hostname'] = $hostname; return $this; } /** - * Gets gps_latitude + * Gets response_seconds * @return string */ - public function getGpsLatitude() + public function getResponseSeconds() { - return $this->container['gps_latitude']; + return $this->container['response_seconds']; } /** - * Sets gps_latitude - * @param string $gps_latitude A string containing the latitude of the device location at the time of signing. + * Sets response_seconds + * @param string $response_seconds * @return $this */ - public function setGpsLatitude($gps_latitude) + public function setResponseSeconds($response_seconds) { - $this->container['gps_latitude'] = $gps_latitude; + $this->container['response_seconds'] = $response_seconds; return $this; } /** - * Gets gps_longitude + * Gets status * @return string */ - public function getGpsLongitude() + public function getStatus() { - return $this->container['gps_longitude']; + return $this->container['status']; } /** - * Sets gps_longitude - * @param string $gps_longitude A string containing the longitude of the device location at the time of signing. + * Sets status + * @param string $status Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. * @return $this */ - public function setGpsLongitude($gps_longitude) + public function setStatus($status) { - $this->container['gps_longitude'] = $gps_longitude; + $this->container['status'] = $status; return $this; } /** - * Gets offline_signing_hash + * Gets type * @return string */ - public function getOfflineSigningHash() + public function getType() { - return $this->container['offline_signing_hash']; + return $this->container['type']; } /** - * Sets offline_signing_hash - * @param string $offline_signing_hash + * Sets type + * @param string $type * @return $this */ - public function setOfflineSigningHash($offline_signing_hash) + public function setType($type) { - $this->container['offline_signing_hash'] = $offline_signing_hash; + $this->container['type'] = $type; return $this; } diff --git a/src/Model/UpdateTransactionRequest.php b/src/Model/UpdateTransactionRequest.php new file mode 100644 index 00000000..7c70bfe8 --- /dev/null +++ b/src/Model/UpdateTransactionRequest.php @@ -0,0 +1,279 @@ + 'string', + 'message' => 'string', + 'state' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'code' => 'code', + 'message' => 'message', + 'state' => 'state' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'code' => 'setCode', + 'message' => 'setMessage', + 'state' => 'setState' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'code' => 'getCode', + 'message' => 'getMessage', + 'state' => 'getState' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['code'] = isset($data['code']) ? $data['code'] : null; + $this->container['message'] = isset($data['message']) ? $data['message'] : null; + $this->container['state'] = isset($data['state']) ? $data['state'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets code + * @return string + */ + public function getCode() + { + return $this->container['code']; + } + + /** + * Sets code + * @param string $code + * @return $this + */ + public function setCode($code) + { + $this->container['code'] = $code; + + return $this; + } + + /** + * Gets message + * @return string + */ + public function getMessage() + { + return $this->container['message']; + } + + /** + * Sets message + * @param string $message + * @return $this + */ + public function setMessage($message) + { + $this->container['message'] = $message; + + return $this; + } + + /** + * Gets state + * @return string + */ + public function getState() + { + return $this->container['state']; + } + + /** + * Sets state + * @param string $state The state or province associated with the address. + * @return $this + */ + public function setState($state) + { + $this->container['state'] = $state; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/UpdateTransactionResponse.php b/src/Model/UpdateTransactionResponse.php new file mode 100644 index 00000000..b7433f3d --- /dev/null +++ b/src/Model/UpdateTransactionResponse.php @@ -0,0 +1,227 @@ + 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'redirection_url' => 'redirectionUrl' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'redirection_url' => 'setRedirectionUrl' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'redirection_url' => 'getRedirectionUrl' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['redirection_url'] = isset($data['redirection_url']) ? $data['redirection_url'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets redirection_url + * @return string + */ + public function getRedirectionUrl() + { + return $this->container['redirection_url']; + } + + /** + * Sets redirection_url + * @param string $redirection_url + * @return $this + */ + public function setRedirectionUrl($redirection_url) + { + $this->container['redirection_url'] = $redirection_url; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/UsageHistory.php b/src/Model/UsageHistory.php index 13a7b894..4da0bd66 100644 --- a/src/Model/UsageHistory.php +++ b/src/Model/UsageHistory.php @@ -35,7 +35,7 @@ * UsageHistory Class Doc Comment * * @category Class - * @description A complex element consisting of: * lastSentDateTime – the date and time the user last sent an envelope. * lastSignedDateTime – the date and time the user last signed an envelope. * sentCount – the number of envelopes the user has sent. * signedCount – the number of envelopes the user has signed. + * @description A complex element consisting of: * lastSentDateTime - the date and time the user last sent an envelope. * lastSignedDateTime - the date and time the user last signed an envelope. * sentCount - the number of envelopes the user has sent. * signedCount - the number of envelopes the user has signed. * @package DocuSign\eSign * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen diff --git a/src/Model/User.php b/src/Model/User.php new file mode 100644 index 00000000..939f0d2e --- /dev/null +++ b/src/Model/User.php @@ -0,0 +1,305 @@ + 'string', + 'credentials' => '\DocuSign\eSign\Model\Credential[]', + 'display_name' => 'string', + 'email' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'country_code' => 'countryCode', + 'credentials' => 'credentials', + 'display_name' => 'displayName', + 'email' => 'email' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'country_code' => 'setCountryCode', + 'credentials' => 'setCredentials', + 'display_name' => 'setDisplayName', + 'email' => 'setEmail' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'country_code' => 'getCountryCode', + 'credentials' => 'getCredentials', + 'display_name' => 'getDisplayName', + 'email' => 'getEmail' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['country_code'] = isset($data['country_code']) ? $data['country_code'] : null; + $this->container['credentials'] = isset($data['credentials']) ? $data['credentials'] : null; + $this->container['display_name'] = isset($data['display_name']) ? $data['display_name'] : null; + $this->container['email'] = isset($data['email']) ? $data['email'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets country_code + * @return string + */ + public function getCountryCode() + { + return $this->container['country_code']; + } + + /** + * Sets country_code + * @param string $country_code + * @return $this + */ + public function setCountryCode($country_code) + { + $this->container['country_code'] = $country_code; + + return $this; + } + + /** + * Gets credentials + * @return \DocuSign\eSign\Model\Credential[] + */ + public function getCredentials() + { + return $this->container['credentials']; + } + + /** + * Sets credentials + * @param \DocuSign\eSign\Model\Credential[] $credentials + * @return $this + */ + public function setCredentials($credentials) + { + $this->container['credentials'] = $credentials; + + return $this; + } + + /** + * Gets display_name + * @return string + */ + public function getDisplayName() + { + return $this->container['display_name']; + } + + /** + * Sets display_name + * @param string $display_name + * @return $this + */ + public function setDisplayName($display_name) + { + $this->container['display_name'] = $display_name; + + return $this; + } + + /** + * Gets email + * @return string + */ + public function getEmail() + { + return $this->container['email']; + } + + /** + * Sets email + * @param string $email + * @return $this + */ + public function setEmail($email) + { + $this->container['email'] = $email; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/UserAccountManagementGranularInformation.php b/src/Model/UserAccountManagementGranularInformation.php index 82f3daf9..b914dc20 100644 --- a/src/Model/UserAccountManagementGranularInformation.php +++ b/src/Model/UserAccountManagementGranularInformation.php @@ -54,12 +54,20 @@ class UserAccountManagementGranularInformation implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ + 'can_manage_account_security_settings' => 'string', + 'can_manage_account_security_settings_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', + 'can_manage_account_settings' => 'string', + 'can_manage_account_settings_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', 'can_manage_admins' => 'string', 'can_manage_admins_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', 'can_manage_groups' => 'string', 'can_manage_groups_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', + 'can_manage_reporting' => 'string', + 'can_manage_reporting_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', 'can_manage_sharing' => 'string', 'can_manage_sharing_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', + 'can_manage_signing_groups' => 'string', + 'can_manage_signing_groups_metadata' => '\DocuSign\eSign\Model\SettingsMetadata', 'can_manage_users' => 'string', 'can_manage_users_metadata' => '\DocuSign\eSign\Model\SettingsMetadata' ]; @@ -74,12 +82,20 @@ public static function swaggerTypes() * @var string[] */ protected static $attributeMap = [ + 'can_manage_account_security_settings' => 'canManageAccountSecuritySettings', + 'can_manage_account_security_settings_metadata' => 'canManageAccountSecuritySettingsMetadata', + 'can_manage_account_settings' => 'canManageAccountSettings', + 'can_manage_account_settings_metadata' => 'canManageAccountSettingsMetadata', 'can_manage_admins' => 'canManageAdmins', 'can_manage_admins_metadata' => 'canManageAdminsMetadata', 'can_manage_groups' => 'canManageGroups', 'can_manage_groups_metadata' => 'canManageGroupsMetadata', + 'can_manage_reporting' => 'canManageReporting', + 'can_manage_reporting_metadata' => 'canManageReportingMetadata', 'can_manage_sharing' => 'canManageSharing', 'can_manage_sharing_metadata' => 'canManageSharingMetadata', + 'can_manage_signing_groups' => 'canManageSigningGroups', + 'can_manage_signing_groups_metadata' => 'canManageSigningGroupsMetadata', 'can_manage_users' => 'canManageUsers', 'can_manage_users_metadata' => 'canManageUsersMetadata' ]; @@ -90,12 +106,20 @@ public static function swaggerTypes() * @var string[] */ protected static $setters = [ + 'can_manage_account_security_settings' => 'setCanManageAccountSecuritySettings', + 'can_manage_account_security_settings_metadata' => 'setCanManageAccountSecuritySettingsMetadata', + 'can_manage_account_settings' => 'setCanManageAccountSettings', + 'can_manage_account_settings_metadata' => 'setCanManageAccountSettingsMetadata', 'can_manage_admins' => 'setCanManageAdmins', 'can_manage_admins_metadata' => 'setCanManageAdminsMetadata', 'can_manage_groups' => 'setCanManageGroups', 'can_manage_groups_metadata' => 'setCanManageGroupsMetadata', + 'can_manage_reporting' => 'setCanManageReporting', + 'can_manage_reporting_metadata' => 'setCanManageReportingMetadata', 'can_manage_sharing' => 'setCanManageSharing', 'can_manage_sharing_metadata' => 'setCanManageSharingMetadata', + 'can_manage_signing_groups' => 'setCanManageSigningGroups', + 'can_manage_signing_groups_metadata' => 'setCanManageSigningGroupsMetadata', 'can_manage_users' => 'setCanManageUsers', 'can_manage_users_metadata' => 'setCanManageUsersMetadata' ]; @@ -106,12 +130,20 @@ public static function swaggerTypes() * @var string[] */ protected static $getters = [ + 'can_manage_account_security_settings' => 'getCanManageAccountSecuritySettings', + 'can_manage_account_security_settings_metadata' => 'getCanManageAccountSecuritySettingsMetadata', + 'can_manage_account_settings' => 'getCanManageAccountSettings', + 'can_manage_account_settings_metadata' => 'getCanManageAccountSettingsMetadata', 'can_manage_admins' => 'getCanManageAdmins', 'can_manage_admins_metadata' => 'getCanManageAdminsMetadata', 'can_manage_groups' => 'getCanManageGroups', 'can_manage_groups_metadata' => 'getCanManageGroupsMetadata', + 'can_manage_reporting' => 'getCanManageReporting', + 'can_manage_reporting_metadata' => 'getCanManageReportingMetadata', 'can_manage_sharing' => 'getCanManageSharing', 'can_manage_sharing_metadata' => 'getCanManageSharingMetadata', + 'can_manage_signing_groups' => 'getCanManageSigningGroups', + 'can_manage_signing_groups_metadata' => 'getCanManageSigningGroupsMetadata', 'can_manage_users' => 'getCanManageUsers', 'can_manage_users_metadata' => 'getCanManageUsersMetadata' ]; @@ -147,12 +179,20 @@ public static function getters() */ public function __construct(array $data = null) { + $this->container['can_manage_account_security_settings'] = isset($data['can_manage_account_security_settings']) ? $data['can_manage_account_security_settings'] : null; + $this->container['can_manage_account_security_settings_metadata'] = isset($data['can_manage_account_security_settings_metadata']) ? $data['can_manage_account_security_settings_metadata'] : null; + $this->container['can_manage_account_settings'] = isset($data['can_manage_account_settings']) ? $data['can_manage_account_settings'] : null; + $this->container['can_manage_account_settings_metadata'] = isset($data['can_manage_account_settings_metadata']) ? $data['can_manage_account_settings_metadata'] : null; $this->container['can_manage_admins'] = isset($data['can_manage_admins']) ? $data['can_manage_admins'] : null; $this->container['can_manage_admins_metadata'] = isset($data['can_manage_admins_metadata']) ? $data['can_manage_admins_metadata'] : null; $this->container['can_manage_groups'] = isset($data['can_manage_groups']) ? $data['can_manage_groups'] : null; $this->container['can_manage_groups_metadata'] = isset($data['can_manage_groups_metadata']) ? $data['can_manage_groups_metadata'] : null; + $this->container['can_manage_reporting'] = isset($data['can_manage_reporting']) ? $data['can_manage_reporting'] : null; + $this->container['can_manage_reporting_metadata'] = isset($data['can_manage_reporting_metadata']) ? $data['can_manage_reporting_metadata'] : null; $this->container['can_manage_sharing'] = isset($data['can_manage_sharing']) ? $data['can_manage_sharing'] : null; $this->container['can_manage_sharing_metadata'] = isset($data['can_manage_sharing_metadata']) ? $data['can_manage_sharing_metadata'] : null; + $this->container['can_manage_signing_groups'] = isset($data['can_manage_signing_groups']) ? $data['can_manage_signing_groups'] : null; + $this->container['can_manage_signing_groups_metadata'] = isset($data['can_manage_signing_groups_metadata']) ? $data['can_manage_signing_groups_metadata'] : null; $this->container['can_manage_users'] = isset($data['can_manage_users']) ? $data['can_manage_users'] : null; $this->container['can_manage_users_metadata'] = isset($data['can_manage_users_metadata']) ? $data['can_manage_users_metadata'] : null; } @@ -180,6 +220,90 @@ public function valid() } + /** + * Gets can_manage_account_security_settings + * @return string + */ + public function getCanManageAccountSecuritySettings() + { + return $this->container['can_manage_account_security_settings']; + } + + /** + * Sets can_manage_account_security_settings + * @param string $can_manage_account_security_settings + * @return $this + */ + public function setCanManageAccountSecuritySettings($can_manage_account_security_settings) + { + $this->container['can_manage_account_security_settings'] = $can_manage_account_security_settings; + + return $this; + } + + /** + * Gets can_manage_account_security_settings_metadata + * @return \DocuSign\eSign\Model\SettingsMetadata + */ + public function getCanManageAccountSecuritySettingsMetadata() + { + return $this->container['can_manage_account_security_settings_metadata']; + } + + /** + * Sets can_manage_account_security_settings_metadata + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_account_security_settings_metadata + * @return $this + */ + public function setCanManageAccountSecuritySettingsMetadata($can_manage_account_security_settings_metadata) + { + $this->container['can_manage_account_security_settings_metadata'] = $can_manage_account_security_settings_metadata; + + return $this; + } + + /** + * Gets can_manage_account_settings + * @return string + */ + public function getCanManageAccountSettings() + { + return $this->container['can_manage_account_settings']; + } + + /** + * Sets can_manage_account_settings + * @param string $can_manage_account_settings + * @return $this + */ + public function setCanManageAccountSettings($can_manage_account_settings) + { + $this->container['can_manage_account_settings'] = $can_manage_account_settings; + + return $this; + } + + /** + * Gets can_manage_account_settings_metadata + * @return \DocuSign\eSign\Model\SettingsMetadata + */ + public function getCanManageAccountSettingsMetadata() + { + return $this->container['can_manage_account_settings_metadata']; + } + + /** + * Sets can_manage_account_settings_metadata + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_account_settings_metadata + * @return $this + */ + public function setCanManageAccountSettingsMetadata($can_manage_account_settings_metadata) + { + $this->container['can_manage_account_settings_metadata'] = $can_manage_account_settings_metadata; + + return $this; + } + /** * Gets can_manage_admins * @return string @@ -264,6 +388,48 @@ public function setCanManageGroupsMetadata($can_manage_groups_metadata) return $this; } + /** + * Gets can_manage_reporting + * @return string + */ + public function getCanManageReporting() + { + return $this->container['can_manage_reporting']; + } + + /** + * Sets can_manage_reporting + * @param string $can_manage_reporting + * @return $this + */ + public function setCanManageReporting($can_manage_reporting) + { + $this->container['can_manage_reporting'] = $can_manage_reporting; + + return $this; + } + + /** + * Gets can_manage_reporting_metadata + * @return \DocuSign\eSign\Model\SettingsMetadata + */ + public function getCanManageReportingMetadata() + { + return $this->container['can_manage_reporting_metadata']; + } + + /** + * Sets can_manage_reporting_metadata + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_reporting_metadata + * @return $this + */ + public function setCanManageReportingMetadata($can_manage_reporting_metadata) + { + $this->container['can_manage_reporting_metadata'] = $can_manage_reporting_metadata; + + return $this; + } + /** * Gets can_manage_sharing * @return string @@ -306,6 +472,48 @@ public function setCanManageSharingMetadata($can_manage_sharing_metadata) return $this; } + /** + * Gets can_manage_signing_groups + * @return string + */ + public function getCanManageSigningGroups() + { + return $this->container['can_manage_signing_groups']; + } + + /** + * Sets can_manage_signing_groups + * @param string $can_manage_signing_groups + * @return $this + */ + public function setCanManageSigningGroups($can_manage_signing_groups) + { + $this->container['can_manage_signing_groups'] = $can_manage_signing_groups; + + return $this; + } + + /** + * Gets can_manage_signing_groups_metadata + * @return \DocuSign\eSign\Model\SettingsMetadata + */ + public function getCanManageSigningGroupsMetadata() + { + return $this->container['can_manage_signing_groups_metadata']; + } + + /** + * Sets can_manage_signing_groups_metadata + * @param \DocuSign\eSign\Model\SettingsMetadata $can_manage_signing_groups_metadata + * @return $this + */ + public function setCanManageSigningGroupsMetadata($can_manage_signing_groups_metadata) + { + $this->container['can_manage_signing_groups_metadata'] = $can_manage_signing_groups_metadata; + + return $this; + } + /** * Gets can_manage_users * @return string diff --git a/src/Model/UserInfoResponse.php b/src/Model/UserInfoResponse.php new file mode 100644 index 00000000..6a482fd5 --- /dev/null +++ b/src/Model/UserInfoResponse.php @@ -0,0 +1,331 @@ + 'string', + 'language' => 'string', + 'seal' => '\DocuSign\eSign\Model\Seal', + 'sender' => '\DocuSign\eSign\Model\Sender', + 'user' => '\DocuSign\eSign\Model\User' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'envelope_id' => 'envelopeId', + 'language' => 'language', + 'seal' => 'seal', + 'sender' => 'sender', + 'user' => 'user' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'envelope_id' => 'setEnvelopeId', + 'language' => 'setLanguage', + 'seal' => 'setSeal', + 'sender' => 'setSender', + 'user' => 'setUser' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'envelope_id' => 'getEnvelopeId', + 'language' => 'getLanguage', + 'seal' => 'getSeal', + 'sender' => 'getSender', + 'user' => 'getUser' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['envelope_id'] = isset($data['envelope_id']) ? $data['envelope_id'] : null; + $this->container['language'] = isset($data['language']) ? $data['language'] : null; + $this->container['seal'] = isset($data['seal']) ? $data['seal'] : null; + $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; + $this->container['user'] = isset($data['user']) ? $data['user'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets envelope_id + * @return string + */ + public function getEnvelopeId() + { + return $this->container['envelope_id']; + } + + /** + * Sets envelope_id + * @param string $envelope_id The envelope ID of the envelope status that failed to post. + * @return $this + */ + public function setEnvelopeId($envelope_id) + { + $this->container['envelope_id'] = $envelope_id; + + return $this; + } + + /** + * Gets language + * @return string + */ + public function getLanguage() + { + return $this->container['language']; + } + + /** + * Sets language + * @param string $language + * @return $this + */ + public function setLanguage($language) + { + $this->container['language'] = $language; + + return $this; + } + + /** + * Gets seal + * @return \DocuSign\eSign\Model\Seal + */ + public function getSeal() + { + return $this->container['seal']; + } + + /** + * Sets seal + * @param \DocuSign\eSign\Model\Seal $seal + * @return $this + */ + public function setSeal($seal) + { + $this->container['seal'] = $seal; + + return $this; + } + + /** + * Gets sender + * @return \DocuSign\eSign\Model\Sender + */ + public function getSender() + { + return $this->container['sender']; + } + + /** + * Sets sender + * @param \DocuSign\eSign\Model\Sender $sender + * @return $this + */ + public function setSender($sender) + { + $this->container['sender'] = $sender; + + return $this; + } + + /** + * Gets user + * @return \DocuSign\eSign\Model\User + */ + public function getUser() + { + return $this->container['user']; + } + + /** + * Sets user + * @param \DocuSign\eSign\Model\User $user + * @return $this + */ + public function setUser($user) + { + $this->container['user'] = $user; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/UserInformation.php b/src/Model/UserInformation.php index 916edb9f..407ff9bc 100644 --- a/src/Model/UserInformation.php +++ b/src/Model/UserInformation.php @@ -56,6 +56,7 @@ class UserInformation implements ArrayAccess protected static $swaggerTypes = [ 'account_management_granular' => '\DocuSign\eSign\Model\UserAccountManagementGranularInformation', 'activation_access_code' => 'string', + 'country_code' => 'string', 'created_date_time' => 'string', 'custom_settings' => '\DocuSign\eSign\Model\NameValue[]', 'email' => 'string', @@ -67,6 +68,7 @@ class UserInformation implements ArrayAccess 'home_address' => '\DocuSign\eSign\Model\AddressInformationV2', 'initials_image_uri' => 'string', 'is_admin' => 'string', + 'job_title' => 'string', 'last_login' => 'string', 'last_name' => 'string', 'login_status' => 'string', @@ -76,8 +78,10 @@ class UserInformation implements ArrayAccess 'permission_profile_id' => 'string', 'permission_profile_name' => 'string', 'profile_image_uri' => 'string', + 'send_activation_email' => 'string', 'send_activation_on_invalid_login' => 'string', 'signature_image_uri' => 'string', + 'subscribe' => 'string', 'suffix_name' => 'string', 'title' => 'string', 'uri' => 'string', @@ -102,6 +106,7 @@ public static function swaggerTypes() protected static $attributeMap = [ 'account_management_granular' => 'accountManagementGranular', 'activation_access_code' => 'activationAccessCode', + 'country_code' => 'countryCode', 'created_date_time' => 'createdDateTime', 'custom_settings' => 'customSettings', 'email' => 'email', @@ -113,6 +118,7 @@ public static function swaggerTypes() 'home_address' => 'homeAddress', 'initials_image_uri' => 'initialsImageUri', 'is_admin' => 'isAdmin', + 'job_title' => 'jobTitle', 'last_login' => 'lastLogin', 'last_name' => 'lastName', 'login_status' => 'loginStatus', @@ -122,8 +128,10 @@ public static function swaggerTypes() 'permission_profile_id' => 'permissionProfileId', 'permission_profile_name' => 'permissionProfileName', 'profile_image_uri' => 'profileImageUri', + 'send_activation_email' => 'sendActivationEmail', 'send_activation_on_invalid_login' => 'sendActivationOnInvalidLogin', 'signature_image_uri' => 'signatureImageUri', + 'subscribe' => 'subscribe', 'suffix_name' => 'suffixName', 'title' => 'title', 'uri' => 'uri', @@ -144,6 +152,7 @@ public static function swaggerTypes() protected static $setters = [ 'account_management_granular' => 'setAccountManagementGranular', 'activation_access_code' => 'setActivationAccessCode', + 'country_code' => 'setCountryCode', 'created_date_time' => 'setCreatedDateTime', 'custom_settings' => 'setCustomSettings', 'email' => 'setEmail', @@ -155,6 +164,7 @@ public static function swaggerTypes() 'home_address' => 'setHomeAddress', 'initials_image_uri' => 'setInitialsImageUri', 'is_admin' => 'setIsAdmin', + 'job_title' => 'setJobTitle', 'last_login' => 'setLastLogin', 'last_name' => 'setLastName', 'login_status' => 'setLoginStatus', @@ -164,8 +174,10 @@ public static function swaggerTypes() 'permission_profile_id' => 'setPermissionProfileId', 'permission_profile_name' => 'setPermissionProfileName', 'profile_image_uri' => 'setProfileImageUri', + 'send_activation_email' => 'setSendActivationEmail', 'send_activation_on_invalid_login' => 'setSendActivationOnInvalidLogin', 'signature_image_uri' => 'setSignatureImageUri', + 'subscribe' => 'setSubscribe', 'suffix_name' => 'setSuffixName', 'title' => 'setTitle', 'uri' => 'setUri', @@ -186,6 +198,7 @@ public static function swaggerTypes() protected static $getters = [ 'account_management_granular' => 'getAccountManagementGranular', 'activation_access_code' => 'getActivationAccessCode', + 'country_code' => 'getCountryCode', 'created_date_time' => 'getCreatedDateTime', 'custom_settings' => 'getCustomSettings', 'email' => 'getEmail', @@ -197,6 +210,7 @@ public static function swaggerTypes() 'home_address' => 'getHomeAddress', 'initials_image_uri' => 'getInitialsImageUri', 'is_admin' => 'getIsAdmin', + 'job_title' => 'getJobTitle', 'last_login' => 'getLastLogin', 'last_name' => 'getLastName', 'login_status' => 'getLoginStatus', @@ -206,8 +220,10 @@ public static function swaggerTypes() 'permission_profile_id' => 'getPermissionProfileId', 'permission_profile_name' => 'getPermissionProfileName', 'profile_image_uri' => 'getProfileImageUri', + 'send_activation_email' => 'getSendActivationEmail', 'send_activation_on_invalid_login' => 'getSendActivationOnInvalidLogin', 'signature_image_uri' => 'getSignatureImageUri', + 'subscribe' => 'getSubscribe', 'suffix_name' => 'getSuffixName', 'title' => 'getTitle', 'uri' => 'getUri', @@ -253,6 +269,7 @@ public function __construct(array $data = null) { $this->container['account_management_granular'] = isset($data['account_management_granular']) ? $data['account_management_granular'] : null; $this->container['activation_access_code'] = isset($data['activation_access_code']) ? $data['activation_access_code'] : null; + $this->container['country_code'] = isset($data['country_code']) ? $data['country_code'] : null; $this->container['created_date_time'] = isset($data['created_date_time']) ? $data['created_date_time'] : null; $this->container['custom_settings'] = isset($data['custom_settings']) ? $data['custom_settings'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; @@ -264,6 +281,7 @@ public function __construct(array $data = null) $this->container['home_address'] = isset($data['home_address']) ? $data['home_address'] : null; $this->container['initials_image_uri'] = isset($data['initials_image_uri']) ? $data['initials_image_uri'] : null; $this->container['is_admin'] = isset($data['is_admin']) ? $data['is_admin'] : null; + $this->container['job_title'] = isset($data['job_title']) ? $data['job_title'] : null; $this->container['last_login'] = isset($data['last_login']) ? $data['last_login'] : null; $this->container['last_name'] = isset($data['last_name']) ? $data['last_name'] : null; $this->container['login_status'] = isset($data['login_status']) ? $data['login_status'] : null; @@ -273,8 +291,10 @@ public function __construct(array $data = null) $this->container['permission_profile_id'] = isset($data['permission_profile_id']) ? $data['permission_profile_id'] : null; $this->container['permission_profile_name'] = isset($data['permission_profile_name']) ? $data['permission_profile_name'] : null; $this->container['profile_image_uri'] = isset($data['profile_image_uri']) ? $data['profile_image_uri'] : null; + $this->container['send_activation_email'] = isset($data['send_activation_email']) ? $data['send_activation_email'] : null; $this->container['send_activation_on_invalid_login'] = isset($data['send_activation_on_invalid_login']) ? $data['send_activation_on_invalid_login'] : null; $this->container['signature_image_uri'] = isset($data['signature_image_uri']) ? $data['signature_image_uri'] : null; + $this->container['subscribe'] = isset($data['subscribe']) ? $data['subscribe'] : null; $this->container['suffix_name'] = isset($data['suffix_name']) ? $data['suffix_name'] : null; $this->container['title'] = isset($data['title']) ? $data['title'] : null; $this->container['uri'] = isset($data['uri']) ? $data['uri'] : null; @@ -352,6 +372,27 @@ public function setActivationAccessCode($activation_access_code) return $this; } + /** + * Gets country_code + * @return string + */ + public function getCountryCode() + { + return $this->container['country_code']; + } + + /** + * Sets country_code + * @param string $country_code + * @return $this + */ + public function setCountryCode($country_code) + { + $this->container['country_code'] = $country_code; + + return $this; + } + /** * Gets created_date_time * @return string @@ -468,7 +509,7 @@ public function getFirstName() /** * Sets first_name - * @param string $first_name The user’s first name. Maximum Length: 50 characters. + * @param string $first_name The user's first name. Maximum Length: 50 characters. * @return $this */ public function setFirstName($first_name) @@ -510,7 +551,7 @@ public function getGroupList() /** * Sets group_list - * @param \DocuSign\eSign\Model\Group[] $group_list A list of the group information for groups to add the user to. Group information can be found by calling [ML:GET group information]. The only required parameter is groupId. The parameters are: * groupId – The DocuSign group ID for the group. * groupName – The name of the group * permissionProfileId – The ID of the permission profile associated with the group. * groupType – The group type. + * @param \DocuSign\eSign\Model\Group[] $group_list A list of the group information for groups to add the user to. Group information can be found by calling [ML:GET group information]. The only required parameter is groupId. The parameters are: * groupId - The DocuSign group ID for the group. * groupName - The name of the group * permissionProfileId - The ID of the permission profile associated with the group. * groupType - The group type. * @return $this */ public function setGroupList($group_list) @@ -583,6 +624,27 @@ public function setIsAdmin($is_admin) return $this; } + /** + * Gets job_title + * @return string + */ + public function getJobTitle() + { + return $this->container['job_title']; + } + + /** + * Sets job_title + * @param string $job_title + * @return $this + */ + public function setJobTitle($job_title) + { + $this->container['job_title'] = $job_title; + + return $this; + } + /** * Gets last_login * @return string @@ -615,7 +677,7 @@ public function getLastName() /** * Sets last_name - * @param string $last_name The user’s last name. Maximum Length: 50 characters. + * @param string $last_name The user's last name. Maximum Length: 50 characters. * @return $this */ public function setLastName($last_name) @@ -636,7 +698,7 @@ public function getLoginStatus() /** * Sets login_status - * @param string $login_status Shows the current status of the user’s password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed + * @param string $login_status Shows the current status of the user's password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed * @return $this */ public function setLoginStatus($login_status) @@ -657,7 +719,7 @@ public function getMiddleName() /** * Sets middle_name - * @param string $middle_name The user’s middle name. Maximum Length: 50 characters. + * @param string $middle_name The user's middle name. Maximum Length: 50 characters. * @return $this */ public function setMiddleName($middle_name) @@ -772,6 +834,27 @@ public function setProfileImageUri($profile_image_uri) return $this; } + /** + * Gets send_activation_email + * @return string + */ + public function getSendActivationEmail() + { + return $this->container['send_activation_email']; + } + + /** + * Sets send_activation_email + * @param string $send_activation_email + * @return $this + */ + public function setSendActivationEmail($send_activation_email) + { + $this->container['send_activation_email'] = $send_activation_email; + + return $this; + } + /** * Gets send_activation_on_invalid_login * @return string @@ -814,6 +897,27 @@ public function setSignatureImageUri($signature_image_uri) return $this; } + /** + * Gets subscribe + * @return string + */ + public function getSubscribe() + { + return $this->container['subscribe']; + } + + /** + * Sets subscribe + * @param string $subscribe + * @return $this + */ + public function setSubscribe($subscribe) + { + $this->container['subscribe'] = $subscribe; + + return $this; + } + /** * Gets suffix_name * @return string diff --git a/src/Model/UserPasswordRules.php b/src/Model/UserPasswordRules.php new file mode 100644 index 00000000..aba6602d --- /dev/null +++ b/src/Model/UserPasswordRules.php @@ -0,0 +1,253 @@ + '\DocuSign\eSign\Model\AccountPasswordRules', + 'user_id' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'password_rules' => 'passwordRules', + 'user_id' => 'userId' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'password_rules' => 'setPasswordRules', + 'user_id' => 'setUserId' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'password_rules' => 'getPasswordRules', + 'user_id' => 'getUserId' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['password_rules'] = isset($data['password_rules']) ? $data['password_rules'] : null; + $this->container['user_id'] = isset($data['user_id']) ? $data['user_id'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets password_rules + * @return \DocuSign\eSign\Model\AccountPasswordRules + */ + public function getPasswordRules() + { + return $this->container['password_rules']; + } + + /** + * Sets password_rules + * @param \DocuSign\eSign\Model\AccountPasswordRules $password_rules + * @return $this + */ + public function setPasswordRules($password_rules) + { + $this->container['password_rules'] = $password_rules; + + return $this; + } + + /** + * Gets user_id + * @return string + */ + public function getUserId() + { + return $this->container['user_id']; + } + + /** + * Sets user_id + * @param string $user_id + * @return $this + */ + public function setUserId($user_id) + { + $this->container['user_id'] = $user_id; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/UserSignature.php b/src/Model/UserSignature.php index 064f20f0..a1bf6ebc 100644 --- a/src/Model/UserSignature.php +++ b/src/Model/UserSignature.php @@ -56,17 +56,25 @@ class UserSignature implements ArrayAccess protected static $swaggerTypes = [ 'adopted_date_time' => 'string', 'created_date_time' => 'string', + 'date_stamp_properties' => '\DocuSign\eSign\Model\DateStampProperties', 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', + 'external_id' => 'string', + 'image_type' => 'string', 'initials150_image_id' => 'string', 'initials_image_uri' => 'string', 'is_default' => 'string', + 'phonetic_name' => 'string', 'signature150_image_id' => 'string', 'signature_font' => 'string', 'signature_id' => 'string', 'signature_image_uri' => 'string', 'signature_initials' => 'string', 'signature_name' => 'string', - 'signature_type' => 'string' + 'signature_type' => 'string', + 'stamp_format' => 'string', + 'stamp_image_uri' => 'string', + 'stamp_size_mm' => 'string', + 'stamp_type' => 'string' ]; public static function swaggerTypes() @@ -81,17 +89,25 @@ public static function swaggerTypes() protected static $attributeMap = [ 'adopted_date_time' => 'adoptedDateTime', 'created_date_time' => 'createdDateTime', + 'date_stamp_properties' => 'dateStampProperties', 'error_details' => 'errorDetails', + 'external_id' => 'externalID', + 'image_type' => 'imageType', 'initials150_image_id' => 'initials150ImageId', 'initials_image_uri' => 'initialsImageUri', 'is_default' => 'isDefault', + 'phonetic_name' => 'phoneticName', 'signature150_image_id' => 'signature150ImageId', 'signature_font' => 'signatureFont', 'signature_id' => 'signatureId', 'signature_image_uri' => 'signatureImageUri', 'signature_initials' => 'signatureInitials', 'signature_name' => 'signatureName', - 'signature_type' => 'signatureType' + 'signature_type' => 'signatureType', + 'stamp_format' => 'stampFormat', + 'stamp_image_uri' => 'stampImageUri', + 'stamp_size_mm' => 'stampSizeMM', + 'stamp_type' => 'stampType' ]; @@ -102,17 +118,25 @@ public static function swaggerTypes() protected static $setters = [ 'adopted_date_time' => 'setAdoptedDateTime', 'created_date_time' => 'setCreatedDateTime', + 'date_stamp_properties' => 'setDateStampProperties', 'error_details' => 'setErrorDetails', + 'external_id' => 'setExternalId', + 'image_type' => 'setImageType', 'initials150_image_id' => 'setInitials150ImageId', 'initials_image_uri' => 'setInitialsImageUri', 'is_default' => 'setIsDefault', + 'phonetic_name' => 'setPhoneticName', 'signature150_image_id' => 'setSignature150ImageId', 'signature_font' => 'setSignatureFont', 'signature_id' => 'setSignatureId', 'signature_image_uri' => 'setSignatureImageUri', 'signature_initials' => 'setSignatureInitials', 'signature_name' => 'setSignatureName', - 'signature_type' => 'setSignatureType' + 'signature_type' => 'setSignatureType', + 'stamp_format' => 'setStampFormat', + 'stamp_image_uri' => 'setStampImageUri', + 'stamp_size_mm' => 'setStampSizeMm', + 'stamp_type' => 'setStampType' ]; @@ -123,17 +147,25 @@ public static function swaggerTypes() protected static $getters = [ 'adopted_date_time' => 'getAdoptedDateTime', 'created_date_time' => 'getCreatedDateTime', + 'date_stamp_properties' => 'getDateStampProperties', 'error_details' => 'getErrorDetails', + 'external_id' => 'getExternalId', + 'image_type' => 'getImageType', 'initials150_image_id' => 'getInitials150ImageId', 'initials_image_uri' => 'getInitialsImageUri', 'is_default' => 'getIsDefault', + 'phonetic_name' => 'getPhoneticName', 'signature150_image_id' => 'getSignature150ImageId', 'signature_font' => 'getSignatureFont', 'signature_id' => 'getSignatureId', 'signature_image_uri' => 'getSignatureImageUri', 'signature_initials' => 'getSignatureInitials', 'signature_name' => 'getSignatureName', - 'signature_type' => 'getSignatureType' + 'signature_type' => 'getSignatureType', + 'stamp_format' => 'getStampFormat', + 'stamp_image_uri' => 'getStampImageUri', + 'stamp_size_mm' => 'getStampSizeMm', + 'stamp_type' => 'getStampType' ]; public static function attributeMap() @@ -169,10 +201,14 @@ public function __construct(array $data = null) { $this->container['adopted_date_time'] = isset($data['adopted_date_time']) ? $data['adopted_date_time'] : null; $this->container['created_date_time'] = isset($data['created_date_time']) ? $data['created_date_time'] : null; + $this->container['date_stamp_properties'] = isset($data['date_stamp_properties']) ? $data['date_stamp_properties'] : null; $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; + $this->container['external_id'] = isset($data['external_id']) ? $data['external_id'] : null; + $this->container['image_type'] = isset($data['image_type']) ? $data['image_type'] : null; $this->container['initials150_image_id'] = isset($data['initials150_image_id']) ? $data['initials150_image_id'] : null; $this->container['initials_image_uri'] = isset($data['initials_image_uri']) ? $data['initials_image_uri'] : null; $this->container['is_default'] = isset($data['is_default']) ? $data['is_default'] : null; + $this->container['phonetic_name'] = isset($data['phonetic_name']) ? $data['phonetic_name'] : null; $this->container['signature150_image_id'] = isset($data['signature150_image_id']) ? $data['signature150_image_id'] : null; $this->container['signature_font'] = isset($data['signature_font']) ? $data['signature_font'] : null; $this->container['signature_id'] = isset($data['signature_id']) ? $data['signature_id'] : null; @@ -180,6 +216,10 @@ public function __construct(array $data = null) $this->container['signature_initials'] = isset($data['signature_initials']) ? $data['signature_initials'] : null; $this->container['signature_name'] = isset($data['signature_name']) ? $data['signature_name'] : null; $this->container['signature_type'] = isset($data['signature_type']) ? $data['signature_type'] : null; + $this->container['stamp_format'] = isset($data['stamp_format']) ? $data['stamp_format'] : null; + $this->container['stamp_image_uri'] = isset($data['stamp_image_uri']) ? $data['stamp_image_uri'] : null; + $this->container['stamp_size_mm'] = isset($data['stamp_size_mm']) ? $data['stamp_size_mm'] : null; + $this->container['stamp_type'] = isset($data['stamp_type']) ? $data['stamp_type'] : null; } /** @@ -247,6 +287,27 @@ public function setCreatedDateTime($created_date_time) return $this; } + /** + * Gets date_stamp_properties + * @return \DocuSign\eSign\Model\DateStampProperties + */ + public function getDateStampProperties() + { + return $this->container['date_stamp_properties']; + } + + /** + * Sets date_stamp_properties + * @param \DocuSign\eSign\Model\DateStampProperties $date_stamp_properties + * @return $this + */ + public function setDateStampProperties($date_stamp_properties) + { + $this->container['date_stamp_properties'] = $date_stamp_properties; + + return $this; + } + /** * Gets error_details * @return \DocuSign\eSign\Model\ErrorDetails @@ -268,6 +329,48 @@ public function setErrorDetails($error_details) return $this; } + /** + * Gets external_id + * @return string + */ + public function getExternalId() + { + return $this->container['external_id']; + } + + /** + * Sets external_id + * @param string $external_id + * @return $this + */ + public function setExternalId($external_id) + { + $this->container['external_id'] = $external_id; + + return $this; + } + + /** + * Gets image_type + * @return string + */ + public function getImageType() + { + return $this->container['image_type']; + } + + /** + * Sets image_type + * @param string $image_type + * @return $this + */ + public function setImageType($image_type) + { + $this->container['image_type'] = $image_type; + + return $this; + } + /** * Gets initials150_image_id * @return string @@ -331,6 +434,27 @@ public function setIsDefault($is_default) return $this; } + /** + * Gets phonetic_name + * @return string + */ + public function getPhoneticName() + { + return $this->container['phonetic_name']; + } + + /** + * Sets phonetic_name + * @param string $phonetic_name + * @return $this + */ + public function setPhoneticName($phonetic_name) + { + $this->container['phonetic_name'] = $phonetic_name; + + return $this; + } + /** * Gets signature150_image_id * @return string @@ -477,6 +601,90 @@ public function setSignatureType($signature_type) return $this; } + + /** + * Gets stamp_format + * @return string + */ + public function getStampFormat() + { + return $this->container['stamp_format']; + } + + /** + * Sets stamp_format + * @param string $stamp_format + * @return $this + */ + public function setStampFormat($stamp_format) + { + $this->container['stamp_format'] = $stamp_format; + + return $this; + } + + /** + * Gets stamp_image_uri + * @return string + */ + public function getStampImageUri() + { + return $this->container['stamp_image_uri']; + } + + /** + * Sets stamp_image_uri + * @param string $stamp_image_uri + * @return $this + */ + public function setStampImageUri($stamp_image_uri) + { + $this->container['stamp_image_uri'] = $stamp_image_uri; + + return $this; + } + + /** + * Gets stamp_size_mm + * @return string + */ + public function getStampSizeMm() + { + return $this->container['stamp_size_mm']; + } + + /** + * Sets stamp_size_mm + * @param string $stamp_size_mm + * @return $this + */ + public function setStampSizeMm($stamp_size_mm) + { + $this->container['stamp_size_mm'] = $stamp_size_mm; + + return $this; + } + + /** + * Gets stamp_type + * @return string + */ + public function getStampType() + { + return $this->container['stamp_type']; + } + + /** + * Sets stamp_type + * @param string $stamp_type + * @return $this + */ + public function setStampType($stamp_type) + { + $this->container['stamp_type'] = $stamp_type; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/src/Model/View.php b/src/Model/View.php index 66c8783c..bf08160e 100644 --- a/src/Model/View.php +++ b/src/Model/View.php @@ -80,11 +80,13 @@ class View implements ArrayAccess 'required' => 'string', 'required_read' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'width' => 'int', 'x_position' => 'string', @@ -127,11 +129,13 @@ public static function swaggerTypes() 'required' => 'required', 'required_read' => 'requiredRead', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'width' => 'width', 'x_position' => 'xPosition', @@ -170,11 +174,13 @@ public static function swaggerTypes() 'required' => 'setRequired', 'required_read' => 'setRequiredRead', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'width' => 'setWidth', 'x_position' => 'setXPosition', @@ -213,11 +219,13 @@ public static function swaggerTypes() 'required' => 'getRequired', 'required_read' => 'getRequiredRead', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'width' => 'getWidth', 'x_position' => 'getXPosition', @@ -281,11 +289,13 @@ public function __construct(array $data = null) $this->container['required'] = isset($data['required']) ? $data['required'] : null; $this->container['required_read'] = isset($data['required_read']) ? $data['required_read'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['width'] = isset($data['width']) ? $data['width'] : null; $this->container['x_position'] = isset($data['x_position']) ? $data['x_position'] : null; @@ -452,7 +462,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -473,7 +483,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -861,6 +871,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -966,6 +997,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string diff --git a/src/Model/Watermark.php b/src/Model/Watermark.php new file mode 100644 index 00000000..37de879e --- /dev/null +++ b/src/Model/Watermark.php @@ -0,0 +1,435 @@ + 'string', + 'enabled' => 'string', + 'font' => 'string', + 'font_color' => 'string', + 'font_size' => 'string', + 'id' => 'string', + 'image_base64' => 'string', + 'transparency' => 'string', + 'watermark_text' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'display_angle' => 'displayAngle', + 'enabled' => 'enabled', + 'font' => 'font', + 'font_color' => 'fontColor', + 'font_size' => 'fontSize', + 'id' => 'id', + 'image_base64' => 'imageBase64', + 'transparency' => 'transparency', + 'watermark_text' => 'watermarkText' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'display_angle' => 'setDisplayAngle', + 'enabled' => 'setEnabled', + 'font' => 'setFont', + 'font_color' => 'setFontColor', + 'font_size' => 'setFontSize', + 'id' => 'setId', + 'image_base64' => 'setImageBase64', + 'transparency' => 'setTransparency', + 'watermark_text' => 'setWatermarkText' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'display_angle' => 'getDisplayAngle', + 'enabled' => 'getEnabled', + 'font' => 'getFont', + 'font_color' => 'getFontColor', + 'font_size' => 'getFontSize', + 'id' => 'getId', + 'image_base64' => 'getImageBase64', + 'transparency' => 'getTransparency', + 'watermark_text' => 'getWatermarkText' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['display_angle'] = isset($data['display_angle']) ? $data['display_angle'] : null; + $this->container['enabled'] = isset($data['enabled']) ? $data['enabled'] : null; + $this->container['font'] = isset($data['font']) ? $data['font'] : null; + $this->container['font_color'] = isset($data['font_color']) ? $data['font_color'] : null; + $this->container['font_size'] = isset($data['font_size']) ? $data['font_size'] : null; + $this->container['id'] = isset($data['id']) ? $data['id'] : null; + $this->container['image_base64'] = isset($data['image_base64']) ? $data['image_base64'] : null; + $this->container['transparency'] = isset($data['transparency']) ? $data['transparency'] : null; + $this->container['watermark_text'] = isset($data['watermark_text']) ? $data['watermark_text'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets display_angle + * @return string + */ + public function getDisplayAngle() + { + return $this->container['display_angle']; + } + + /** + * Sets display_angle + * @param string $display_angle + * @return $this + */ + public function setDisplayAngle($display_angle) + { + $this->container['display_angle'] = $display_angle; + + return $this; + } + + /** + * Gets enabled + * @return string + */ + public function getEnabled() + { + return $this->container['enabled']; + } + + /** + * Sets enabled + * @param string $enabled + * @return $this + */ + public function setEnabled($enabled) + { + $this->container['enabled'] = $enabled; + + return $this; + } + + /** + * Gets font + * @return string + */ + public function getFont() + { + return $this->container['font']; + } + + /** + * Sets font + * @param string $font The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. + * @return $this + */ + public function setFont($font) + { + $this->container['font'] = $font; + + return $this; + } + + /** + * Gets font_color + * @return string + */ + public function getFontColor() + { + return $this->container['font_color']; + } + + /** + * Sets font_color + * @param string $font_color The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. + * @return $this + */ + public function setFontColor($font_color) + { + $this->container['font_color'] = $font_color; + + return $this; + } + + /** + * Gets font_size + * @return string + */ + public function getFontSize() + { + return $this->container['font_size']; + } + + /** + * Sets font_size + * @param string $font_size The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. + * @return $this + */ + public function setFontSize($font_size) + { + $this->container['font_size'] = $font_size; + + return $this; + } + + /** + * Gets id + * @return string + */ + public function getId() + { + return $this->container['id']; + } + + /** + * Sets id + * @param string $id + * @return $this + */ + public function setId($id) + { + $this->container['id'] = $id; + + return $this; + } + + /** + * Gets image_base64 + * @return string + */ + public function getImageBase64() + { + return $this->container['image_base64']; + } + + /** + * Sets image_base64 + * @param string $image_base64 + * @return $this + */ + public function setImageBase64($image_base64) + { + $this->container['image_base64'] = $image_base64; + + return $this; + } + + /** + * Gets transparency + * @return string + */ + public function getTransparency() + { + return $this->container['transparency']; + } + + /** + * Sets transparency + * @param string $transparency + * @return $this + */ + public function setTransparency($transparency) + { + $this->container['transparency'] = $transparency; + + return $this; + } + + /** + * Gets watermark_text + * @return string + */ + public function getWatermarkText() + { + return $this->container['watermark_text']; + } + + /** + * Sets watermark_text + * @param string $watermark_text + * @return $this + */ + public function setWatermarkText($watermark_text) + { + $this->container['watermark_text'] = $watermark_text; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Witness.php b/src/Model/Witness.php new file mode 100644 index 00000000..93ebbba4 --- /dev/null +++ b/src/Model/Witness.php @@ -0,0 +1,1839 @@ + 'string', + 'add_access_code_to_email' => 'string', + 'agent_can_edit_email' => 'string', + 'agent_can_edit_name' => 'string', + 'auto_navigation' => 'string', + 'bulk_recipients_uri' => 'string', + 'can_sign_offline' => 'string', + 'client_user_id' => 'string', + 'creation_reason' => 'string', + 'custom_fields' => 'string[]', + 'declined_date_time' => 'string', + 'declined_reason' => 'string', + 'default_recipient' => 'string', + 'delivered_date_time' => 'string', + 'delivery_method' => 'string', + 'document_visibility' => '\DocuSign\eSign\Model\DocumentVisibility[]', + 'email' => 'string', + 'email_notification' => '\DocuSign\eSign\Model\RecipientEmailNotification', + 'email_recipient_post_signing_url' => 'string', + 'embedded_recipient_start_url' => 'string', + 'error_details' => '\DocuSign\eSign\Model\ErrorDetails', + 'excluded_documents' => 'string[]', + 'fax_number' => 'string', + 'first_name' => 'string', + 'full_name' => 'string', + 'id_check_configuration_name' => 'string', + 'id_check_information_input' => '\DocuSign\eSign\Model\IdCheckInformationInput', + 'inherit_email_notification_configuration' => 'string', + 'is_bulk_recipient' => 'string', + 'last_name' => 'string', + 'name' => 'string', + 'note' => 'string', + 'offline_attributes' => '\DocuSign\eSign\Model\OfflineAttributes', + 'phone_authentication' => '\DocuSign\eSign\Model\RecipientPhoneAuthentication', + 'recipient_attachments' => '\DocuSign\eSign\Model\RecipientAttachment[]', + 'recipient_authentication_status' => '\DocuSign\eSign\Model\AuthenticationStatus', + 'recipient_id' => 'string', + 'recipient_id_guid' => 'string', + 'recipient_signature_providers' => '\DocuSign\eSign\Model\RecipientSignatureProvider[]', + 'recipient_supplies_tabs' => 'string', + 'require_id_lookup' => 'string', + 'require_signer_certificate' => 'string', + 'require_sign_on_paper' => 'string', + 'role_name' => 'string', + 'routing_order' => 'string', + 'saml_authentication' => '\DocuSign\eSign\Model\RecipientSAMLAuthentication', + 'sent_date_time' => 'string', + 'signature_info' => '\DocuSign\eSign\Model\RecipientSignatureInformation', + 'signed_date_time' => 'string', + 'sign_in_each_location' => 'string', + 'signing_group_id' => 'string', + 'signing_group_name' => 'string', + 'signing_group_users' => '\DocuSign\eSign\Model\UserInfo[]', + 'sms_authentication' => '\DocuSign\eSign\Model\RecipientSMSAuthentication', + 'social_authentications' => '\DocuSign\eSign\Model\SocialAuthentication[]', + 'status' => 'string', + 'tabs' => '\DocuSign\eSign\Model\Tabs', + 'template_locked' => 'string', + 'template_required' => 'string', + 'total_tab_count' => 'string', + 'user_id' => 'string', + 'witness_for' => 'string', + 'witness_for_guid' => 'string' + ]; + + public static function swaggerTypes() + { + return self::$swaggerTypes; + } + + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ + protected static $attributeMap = [ + 'access_code' => 'accessCode', + 'add_access_code_to_email' => 'addAccessCodeToEmail', + 'agent_can_edit_email' => 'agentCanEditEmail', + 'agent_can_edit_name' => 'agentCanEditName', + 'auto_navigation' => 'autoNavigation', + 'bulk_recipients_uri' => 'bulkRecipientsUri', + 'can_sign_offline' => 'canSignOffline', + 'client_user_id' => 'clientUserId', + 'creation_reason' => 'creationReason', + 'custom_fields' => 'customFields', + 'declined_date_time' => 'declinedDateTime', + 'declined_reason' => 'declinedReason', + 'default_recipient' => 'defaultRecipient', + 'delivered_date_time' => 'deliveredDateTime', + 'delivery_method' => 'deliveryMethod', + 'document_visibility' => 'documentVisibility', + 'email' => 'email', + 'email_notification' => 'emailNotification', + 'email_recipient_post_signing_url' => 'emailRecipientPostSigningURL', + 'embedded_recipient_start_url' => 'embeddedRecipientStartURL', + 'error_details' => 'errorDetails', + 'excluded_documents' => 'excludedDocuments', + 'fax_number' => 'faxNumber', + 'first_name' => 'firstName', + 'full_name' => 'fullName', + 'id_check_configuration_name' => 'idCheckConfigurationName', + 'id_check_information_input' => 'idCheckInformationInput', + 'inherit_email_notification_configuration' => 'inheritEmailNotificationConfiguration', + 'is_bulk_recipient' => 'isBulkRecipient', + 'last_name' => 'lastName', + 'name' => 'name', + 'note' => 'note', + 'offline_attributes' => 'offlineAttributes', + 'phone_authentication' => 'phoneAuthentication', + 'recipient_attachments' => 'recipientAttachments', + 'recipient_authentication_status' => 'recipientAuthenticationStatus', + 'recipient_id' => 'recipientId', + 'recipient_id_guid' => 'recipientIdGuid', + 'recipient_signature_providers' => 'recipientSignatureProviders', + 'recipient_supplies_tabs' => 'recipientSuppliesTabs', + 'require_id_lookup' => 'requireIdLookup', + 'require_signer_certificate' => 'requireSignerCertificate', + 'require_sign_on_paper' => 'requireSignOnPaper', + 'role_name' => 'roleName', + 'routing_order' => 'routingOrder', + 'saml_authentication' => 'samlAuthentication', + 'sent_date_time' => 'sentDateTime', + 'signature_info' => 'signatureInfo', + 'signed_date_time' => 'signedDateTime', + 'sign_in_each_location' => 'signInEachLocation', + 'signing_group_id' => 'signingGroupId', + 'signing_group_name' => 'signingGroupName', + 'signing_group_users' => 'signingGroupUsers', + 'sms_authentication' => 'smsAuthentication', + 'social_authentications' => 'socialAuthentications', + 'status' => 'status', + 'tabs' => 'tabs', + 'template_locked' => 'templateLocked', + 'template_required' => 'templateRequired', + 'total_tab_count' => 'totalTabCount', + 'user_id' => 'userId', + 'witness_for' => 'witnessFor', + 'witness_for_guid' => 'witnessForGuid' + ]; + + + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ + protected static $setters = [ + 'access_code' => 'setAccessCode', + 'add_access_code_to_email' => 'setAddAccessCodeToEmail', + 'agent_can_edit_email' => 'setAgentCanEditEmail', + 'agent_can_edit_name' => 'setAgentCanEditName', + 'auto_navigation' => 'setAutoNavigation', + 'bulk_recipients_uri' => 'setBulkRecipientsUri', + 'can_sign_offline' => 'setCanSignOffline', + 'client_user_id' => 'setClientUserId', + 'creation_reason' => 'setCreationReason', + 'custom_fields' => 'setCustomFields', + 'declined_date_time' => 'setDeclinedDateTime', + 'declined_reason' => 'setDeclinedReason', + 'default_recipient' => 'setDefaultRecipient', + 'delivered_date_time' => 'setDeliveredDateTime', + 'delivery_method' => 'setDeliveryMethod', + 'document_visibility' => 'setDocumentVisibility', + 'email' => 'setEmail', + 'email_notification' => 'setEmailNotification', + 'email_recipient_post_signing_url' => 'setEmailRecipientPostSigningUrl', + 'embedded_recipient_start_url' => 'setEmbeddedRecipientStartUrl', + 'error_details' => 'setErrorDetails', + 'excluded_documents' => 'setExcludedDocuments', + 'fax_number' => 'setFaxNumber', + 'first_name' => 'setFirstName', + 'full_name' => 'setFullName', + 'id_check_configuration_name' => 'setIdCheckConfigurationName', + 'id_check_information_input' => 'setIdCheckInformationInput', + 'inherit_email_notification_configuration' => 'setInheritEmailNotificationConfiguration', + 'is_bulk_recipient' => 'setIsBulkRecipient', + 'last_name' => 'setLastName', + 'name' => 'setName', + 'note' => 'setNote', + 'offline_attributes' => 'setOfflineAttributes', + 'phone_authentication' => 'setPhoneAuthentication', + 'recipient_attachments' => 'setRecipientAttachments', + 'recipient_authentication_status' => 'setRecipientAuthenticationStatus', + 'recipient_id' => 'setRecipientId', + 'recipient_id_guid' => 'setRecipientIdGuid', + 'recipient_signature_providers' => 'setRecipientSignatureProviders', + 'recipient_supplies_tabs' => 'setRecipientSuppliesTabs', + 'require_id_lookup' => 'setRequireIdLookup', + 'require_signer_certificate' => 'setRequireSignerCertificate', + 'require_sign_on_paper' => 'setRequireSignOnPaper', + 'role_name' => 'setRoleName', + 'routing_order' => 'setRoutingOrder', + 'saml_authentication' => 'setSamlAuthentication', + 'sent_date_time' => 'setSentDateTime', + 'signature_info' => 'setSignatureInfo', + 'signed_date_time' => 'setSignedDateTime', + 'sign_in_each_location' => 'setSignInEachLocation', + 'signing_group_id' => 'setSigningGroupId', + 'signing_group_name' => 'setSigningGroupName', + 'signing_group_users' => 'setSigningGroupUsers', + 'sms_authentication' => 'setSmsAuthentication', + 'social_authentications' => 'setSocialAuthentications', + 'status' => 'setStatus', + 'tabs' => 'setTabs', + 'template_locked' => 'setTemplateLocked', + 'template_required' => 'setTemplateRequired', + 'total_tab_count' => 'setTotalTabCount', + 'user_id' => 'setUserId', + 'witness_for' => 'setWitnessFor', + 'witness_for_guid' => 'setWitnessForGuid' + ]; + + + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ + protected static $getters = [ + 'access_code' => 'getAccessCode', + 'add_access_code_to_email' => 'getAddAccessCodeToEmail', + 'agent_can_edit_email' => 'getAgentCanEditEmail', + 'agent_can_edit_name' => 'getAgentCanEditName', + 'auto_navigation' => 'getAutoNavigation', + 'bulk_recipients_uri' => 'getBulkRecipientsUri', + 'can_sign_offline' => 'getCanSignOffline', + 'client_user_id' => 'getClientUserId', + 'creation_reason' => 'getCreationReason', + 'custom_fields' => 'getCustomFields', + 'declined_date_time' => 'getDeclinedDateTime', + 'declined_reason' => 'getDeclinedReason', + 'default_recipient' => 'getDefaultRecipient', + 'delivered_date_time' => 'getDeliveredDateTime', + 'delivery_method' => 'getDeliveryMethod', + 'document_visibility' => 'getDocumentVisibility', + 'email' => 'getEmail', + 'email_notification' => 'getEmailNotification', + 'email_recipient_post_signing_url' => 'getEmailRecipientPostSigningUrl', + 'embedded_recipient_start_url' => 'getEmbeddedRecipientStartUrl', + 'error_details' => 'getErrorDetails', + 'excluded_documents' => 'getExcludedDocuments', + 'fax_number' => 'getFaxNumber', + 'first_name' => 'getFirstName', + 'full_name' => 'getFullName', + 'id_check_configuration_name' => 'getIdCheckConfigurationName', + 'id_check_information_input' => 'getIdCheckInformationInput', + 'inherit_email_notification_configuration' => 'getInheritEmailNotificationConfiguration', + 'is_bulk_recipient' => 'getIsBulkRecipient', + 'last_name' => 'getLastName', + 'name' => 'getName', + 'note' => 'getNote', + 'offline_attributes' => 'getOfflineAttributes', + 'phone_authentication' => 'getPhoneAuthentication', + 'recipient_attachments' => 'getRecipientAttachments', + 'recipient_authentication_status' => 'getRecipientAuthenticationStatus', + 'recipient_id' => 'getRecipientId', + 'recipient_id_guid' => 'getRecipientIdGuid', + 'recipient_signature_providers' => 'getRecipientSignatureProviders', + 'recipient_supplies_tabs' => 'getRecipientSuppliesTabs', + 'require_id_lookup' => 'getRequireIdLookup', + 'require_signer_certificate' => 'getRequireSignerCertificate', + 'require_sign_on_paper' => 'getRequireSignOnPaper', + 'role_name' => 'getRoleName', + 'routing_order' => 'getRoutingOrder', + 'saml_authentication' => 'getSamlAuthentication', + 'sent_date_time' => 'getSentDateTime', + 'signature_info' => 'getSignatureInfo', + 'signed_date_time' => 'getSignedDateTime', + 'sign_in_each_location' => 'getSignInEachLocation', + 'signing_group_id' => 'getSigningGroupId', + 'signing_group_name' => 'getSigningGroupName', + 'signing_group_users' => 'getSigningGroupUsers', + 'sms_authentication' => 'getSmsAuthentication', + 'social_authentications' => 'getSocialAuthentications', + 'status' => 'getStatus', + 'tabs' => 'getTabs', + 'template_locked' => 'getTemplateLocked', + 'template_required' => 'getTemplateRequired', + 'total_tab_count' => 'getTotalTabCount', + 'user_id' => 'getUserId', + 'witness_for' => 'getWitnessFor', + 'witness_for_guid' => 'getWitnessForGuid' + ]; + + public static function attributeMap() + { + return self::$attributeMap; + } + + public static function setters() + { + return self::$setters; + } + + public static function getters() + { + return self::$getters; + } + + + + + + /** + * 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['access_code'] = isset($data['access_code']) ? $data['access_code'] : null; + $this->container['add_access_code_to_email'] = isset($data['add_access_code_to_email']) ? $data['add_access_code_to_email'] : null; + $this->container['agent_can_edit_email'] = isset($data['agent_can_edit_email']) ? $data['agent_can_edit_email'] : null; + $this->container['agent_can_edit_name'] = isset($data['agent_can_edit_name']) ? $data['agent_can_edit_name'] : null; + $this->container['auto_navigation'] = isset($data['auto_navigation']) ? $data['auto_navigation'] : null; + $this->container['bulk_recipients_uri'] = isset($data['bulk_recipients_uri']) ? $data['bulk_recipients_uri'] : null; + $this->container['can_sign_offline'] = isset($data['can_sign_offline']) ? $data['can_sign_offline'] : null; + $this->container['client_user_id'] = isset($data['client_user_id']) ? $data['client_user_id'] : null; + $this->container['creation_reason'] = isset($data['creation_reason']) ? $data['creation_reason'] : null; + $this->container['custom_fields'] = isset($data['custom_fields']) ? $data['custom_fields'] : null; + $this->container['declined_date_time'] = isset($data['declined_date_time']) ? $data['declined_date_time'] : null; + $this->container['declined_reason'] = isset($data['declined_reason']) ? $data['declined_reason'] : null; + $this->container['default_recipient'] = isset($data['default_recipient']) ? $data['default_recipient'] : null; + $this->container['delivered_date_time'] = isset($data['delivered_date_time']) ? $data['delivered_date_time'] : null; + $this->container['delivery_method'] = isset($data['delivery_method']) ? $data['delivery_method'] : null; + $this->container['document_visibility'] = isset($data['document_visibility']) ? $data['document_visibility'] : null; + $this->container['email'] = isset($data['email']) ? $data['email'] : null; + $this->container['email_notification'] = isset($data['email_notification']) ? $data['email_notification'] : null; + $this->container['email_recipient_post_signing_url'] = isset($data['email_recipient_post_signing_url']) ? $data['email_recipient_post_signing_url'] : null; + $this->container['embedded_recipient_start_url'] = isset($data['embedded_recipient_start_url']) ? $data['embedded_recipient_start_url'] : null; + $this->container['error_details'] = isset($data['error_details']) ? $data['error_details'] : null; + $this->container['excluded_documents'] = isset($data['excluded_documents']) ? $data['excluded_documents'] : null; + $this->container['fax_number'] = isset($data['fax_number']) ? $data['fax_number'] : null; + $this->container['first_name'] = isset($data['first_name']) ? $data['first_name'] : null; + $this->container['full_name'] = isset($data['full_name']) ? $data['full_name'] : null; + $this->container['id_check_configuration_name'] = isset($data['id_check_configuration_name']) ? $data['id_check_configuration_name'] : null; + $this->container['id_check_information_input'] = isset($data['id_check_information_input']) ? $data['id_check_information_input'] : null; + $this->container['inherit_email_notification_configuration'] = isset($data['inherit_email_notification_configuration']) ? $data['inherit_email_notification_configuration'] : null; + $this->container['is_bulk_recipient'] = isset($data['is_bulk_recipient']) ? $data['is_bulk_recipient'] : null; + $this->container['last_name'] = isset($data['last_name']) ? $data['last_name'] : null; + $this->container['name'] = isset($data['name']) ? $data['name'] : null; + $this->container['note'] = isset($data['note']) ? $data['note'] : null; + $this->container['offline_attributes'] = isset($data['offline_attributes']) ? $data['offline_attributes'] : null; + $this->container['phone_authentication'] = isset($data['phone_authentication']) ? $data['phone_authentication'] : null; + $this->container['recipient_attachments'] = isset($data['recipient_attachments']) ? $data['recipient_attachments'] : null; + $this->container['recipient_authentication_status'] = isset($data['recipient_authentication_status']) ? $data['recipient_authentication_status'] : null; + $this->container['recipient_id'] = isset($data['recipient_id']) ? $data['recipient_id'] : null; + $this->container['recipient_id_guid'] = isset($data['recipient_id_guid']) ? $data['recipient_id_guid'] : null; + $this->container['recipient_signature_providers'] = isset($data['recipient_signature_providers']) ? $data['recipient_signature_providers'] : null; + $this->container['recipient_supplies_tabs'] = isset($data['recipient_supplies_tabs']) ? $data['recipient_supplies_tabs'] : null; + $this->container['require_id_lookup'] = isset($data['require_id_lookup']) ? $data['require_id_lookup'] : null; + $this->container['require_signer_certificate'] = isset($data['require_signer_certificate']) ? $data['require_signer_certificate'] : null; + $this->container['require_sign_on_paper'] = isset($data['require_sign_on_paper']) ? $data['require_sign_on_paper'] : null; + $this->container['role_name'] = isset($data['role_name']) ? $data['role_name'] : null; + $this->container['routing_order'] = isset($data['routing_order']) ? $data['routing_order'] : null; + $this->container['saml_authentication'] = isset($data['saml_authentication']) ? $data['saml_authentication'] : null; + $this->container['sent_date_time'] = isset($data['sent_date_time']) ? $data['sent_date_time'] : null; + $this->container['signature_info'] = isset($data['signature_info']) ? $data['signature_info'] : null; + $this->container['signed_date_time'] = isset($data['signed_date_time']) ? $data['signed_date_time'] : null; + $this->container['sign_in_each_location'] = isset($data['sign_in_each_location']) ? $data['sign_in_each_location'] : null; + $this->container['signing_group_id'] = isset($data['signing_group_id']) ? $data['signing_group_id'] : null; + $this->container['signing_group_name'] = isset($data['signing_group_name']) ? $data['signing_group_name'] : null; + $this->container['signing_group_users'] = isset($data['signing_group_users']) ? $data['signing_group_users'] : null; + $this->container['sms_authentication'] = isset($data['sms_authentication']) ? $data['sms_authentication'] : null; + $this->container['social_authentications'] = isset($data['social_authentications']) ? $data['social_authentications'] : null; + $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tabs'] = isset($data['tabs']) ? $data['tabs'] : null; + $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; + $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['total_tab_count'] = isset($data['total_tab_count']) ? $data['total_tab_count'] : null; + $this->container['user_id'] = isset($data['user_id']) ? $data['user_id'] : null; + $this->container['witness_for'] = isset($data['witness_for']) ? $data['witness_for'] : null; + $this->container['witness_for_guid'] = isset($data['witness_for_guid']) ? $data['witness_for_guid'] : null; + } + + /** + * show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalid_properties = []; + return $invalid_properties; + } + + /** + * validate all the properties in the model + * return true if all passed + * + * @return bool True if all properteis are valid + */ + public function valid() + { + return true; + } + + + /** + * Gets access_code + * @return string + */ + public function getAccessCode() + { + return $this->container['access_code']; + } + + /** + * Sets access_code + * @param string $access_code If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. + * @return $this + */ + public function setAccessCode($access_code) + { + $this->container['access_code'] = $access_code; + + return $this; + } + + /** + * Gets add_access_code_to_email + * @return string + */ + public function getAddAccessCodeToEmail() + { + return $this->container['add_access_code_to_email']; + } + + /** + * Sets add_access_code_to_email + * @param string $add_access_code_to_email This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. + * @return $this + */ + public function setAddAccessCodeToEmail($add_access_code_to_email) + { + $this->container['add_access_code_to_email'] = $add_access_code_to_email; + + return $this; + } + + /** + * Gets agent_can_edit_email + * @return string + */ + public function getAgentCanEditEmail() + { + return $this->container['agent_can_edit_email']; + } + + /** + * Sets agent_can_edit_email + * @param string $agent_can_edit_email + * @return $this + */ + public function setAgentCanEditEmail($agent_can_edit_email) + { + $this->container['agent_can_edit_email'] = $agent_can_edit_email; + + return $this; + } + + /** + * Gets agent_can_edit_name + * @return string + */ + public function getAgentCanEditName() + { + return $this->container['agent_can_edit_name']; + } + + /** + * Sets agent_can_edit_name + * @param string $agent_can_edit_name + * @return $this + */ + public function setAgentCanEditName($agent_can_edit_name) + { + $this->container['agent_can_edit_name'] = $agent_can_edit_name; + + return $this; + } + + /** + * Gets auto_navigation + * @return string + */ + public function getAutoNavigation() + { + return $this->container['auto_navigation']; + } + + /** + * Sets auto_navigation + * @param string $auto_navigation + * @return $this + */ + public function setAutoNavigation($auto_navigation) + { + $this->container['auto_navigation'] = $auto_navigation; + + return $this; + } + + /** + * Gets bulk_recipients_uri + * @return string + */ + public function getBulkRecipientsUri() + { + return $this->container['bulk_recipients_uri']; + } + + /** + * Sets bulk_recipients_uri + * @param string $bulk_recipients_uri Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. + * @return $this + */ + public function setBulkRecipientsUri($bulk_recipients_uri) + { + $this->container['bulk_recipients_uri'] = $bulk_recipients_uri; + + return $this; + } + + /** + * Gets can_sign_offline + * @return string + */ + public function getCanSignOffline() + { + return $this->container['can_sign_offline']; + } + + /** + * Sets can_sign_offline + * @param string $can_sign_offline When set to **true**, specifies that the signer can perform the signing ceremony offline. + * @return $this + */ + public function setCanSignOffline($can_sign_offline) + { + $this->container['can_sign_offline'] = $can_sign_offline; + + return $this; + } + + /** + * Gets client_user_id + * @return string + */ + public function getClientUserId() + { + return $this->container['client_user_id']; + } + + /** + * Sets client_user_id + * @param string $client_user_id Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. + * @return $this + */ + public function setClientUserId($client_user_id) + { + $this->container['client_user_id'] = $client_user_id; + + return $this; + } + + /** + * Gets creation_reason + * @return string + */ + public function getCreationReason() + { + return $this->container['creation_reason']; + } + + /** + * Sets creation_reason + * @param string $creation_reason + * @return $this + */ + public function setCreationReason($creation_reason) + { + $this->container['creation_reason'] = $creation_reason; + + return $this; + } + + /** + * Gets custom_fields + * @return string[] + */ + public function getCustomFields() + { + return $this->container['custom_fields']; + } + + /** + * Sets custom_fields + * @param string[] $custom_fields An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. + * @return $this + */ + public function setCustomFields($custom_fields) + { + $this->container['custom_fields'] = $custom_fields; + + return $this; + } + + /** + * Gets declined_date_time + * @return string + */ + public function getDeclinedDateTime() + { + return $this->container['declined_date_time']; + } + + /** + * Sets declined_date_time + * @param string $declined_date_time The date and time the recipient declined the document. + * @return $this + */ + public function setDeclinedDateTime($declined_date_time) + { + $this->container['declined_date_time'] = $declined_date_time; + + return $this; + } + + /** + * Gets declined_reason + * @return string + */ + public function getDeclinedReason() + { + return $this->container['declined_reason']; + } + + /** + * Sets declined_reason + * @param string $declined_reason The reason the recipient declined the document. + * @return $this + */ + public function setDeclinedReason($declined_reason) + { + $this->container['declined_reason'] = $declined_reason; + + return $this; + } + + /** + * Gets default_recipient + * @return string + */ + public function getDefaultRecipient() + { + return $this->container['default_recipient']; + } + + /** + * Sets default_recipient + * @param string $default_recipient + * @return $this + */ + public function setDefaultRecipient($default_recipient) + { + $this->container['default_recipient'] = $default_recipient; + + return $this; + } + + /** + * Gets delivered_date_time + * @return string + */ + public function getDeliveredDateTime() + { + return $this->container['delivered_date_time']; + } + + /** + * Sets delivered_date_time + * @param string $delivered_date_time Reserved: For DocuSign use only. + * @return $this + */ + public function setDeliveredDateTime($delivered_date_time) + { + $this->container['delivered_date_time'] = $delivered_date_time; + + return $this; + } + + /** + * Gets delivery_method + * @return string + */ + public function getDeliveryMethod() + { + return $this->container['delivery_method']; + } + + /** + * Sets delivery_method + * @param string $delivery_method Reserved: For DocuSign use only. + * @return $this + */ + public function setDeliveryMethod($delivery_method) + { + $this->container['delivery_method'] = $delivery_method; + + return $this; + } + + /** + * Gets document_visibility + * @return \DocuSign\eSign\Model\DocumentVisibility[] + */ + public function getDocumentVisibility() + { + return $this->container['document_visibility']; + } + + /** + * Sets document_visibility + * @param \DocuSign\eSign\Model\DocumentVisibility[] $document_visibility + * @return $this + */ + public function setDocumentVisibility($document_visibility) + { + $this->container['document_visibility'] = $document_visibility; + + return $this; + } + + /** + * Gets email + * @return string + */ + public function getEmail() + { + return $this->container['email']; + } + + /** + * Sets email + * @param string $email + * @return $this + */ + public function setEmail($email) + { + $this->container['email'] = $email; + + return $this; + } + + /** + * Gets email_notification + * @return \DocuSign\eSign\Model\RecipientEmailNotification + */ + public function getEmailNotification() + { + return $this->container['email_notification']; + } + + /** + * Sets email_notification + * @param \DocuSign\eSign\Model\RecipientEmailNotification $email_notification + * @return $this + */ + public function setEmailNotification($email_notification) + { + $this->container['email_notification'] = $email_notification; + + return $this; + } + + /** + * Gets email_recipient_post_signing_url + * @return string + */ + public function getEmailRecipientPostSigningUrl() + { + return $this->container['email_recipient_post_signing_url']; + } + + /** + * Sets email_recipient_post_signing_url + * @param string $email_recipient_post_signing_url + * @return $this + */ + public function setEmailRecipientPostSigningUrl($email_recipient_post_signing_url) + { + $this->container['email_recipient_post_signing_url'] = $email_recipient_post_signing_url; + + return $this; + } + + /** + * Gets embedded_recipient_start_url + * @return string + */ + public function getEmbeddedRecipientStartUrl() + { + return $this->container['embedded_recipient_start_url']; + } + + /** + * Sets embedded_recipient_start_url + * @param string $embedded_recipient_start_url Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` + * @return $this + */ + public function setEmbeddedRecipientStartUrl($embedded_recipient_start_url) + { + $this->container['embedded_recipient_start_url'] = $embedded_recipient_start_url; + + return $this; + } + + /** + * Gets error_details + * @return \DocuSign\eSign\Model\ErrorDetails + */ + public function getErrorDetails() + { + return $this->container['error_details']; + } + + /** + * Sets error_details + * @param \DocuSign\eSign\Model\ErrorDetails $error_details + * @return $this + */ + public function setErrorDetails($error_details) + { + $this->container['error_details'] = $error_details; + + return $this; + } + + /** + * Gets excluded_documents + * @return string[] + */ + public function getExcludedDocuments() + { + return $this->container['excluded_documents']; + } + + /** + * Sets excluded_documents + * @param string[] $excluded_documents Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. + * @return $this + */ + public function setExcludedDocuments($excluded_documents) + { + $this->container['excluded_documents'] = $excluded_documents; + + return $this; + } + + /** + * Gets fax_number + * @return string + */ + public function getFaxNumber() + { + return $this->container['fax_number']; + } + + /** + * Sets fax_number + * @param string $fax_number Reserved: + * @return $this + */ + public function setFaxNumber($fax_number) + { + $this->container['fax_number'] = $fax_number; + + return $this; + } + + /** + * Gets first_name + * @return string + */ + public function getFirstName() + { + return $this->container['first_name']; + } + + /** + * Sets first_name + * @param string $first_name The user's first name. Maximum Length: 50 characters. + * @return $this + */ + public function setFirstName($first_name) + { + $this->container['first_name'] = $first_name; + + return $this; + } + + /** + * Gets full_name + * @return string + */ + public function getFullName() + { + return $this->container['full_name']; + } + + /** + * Sets full_name + * @param string $full_name + * @return $this + */ + public function setFullName($full_name) + { + $this->container['full_name'] = $full_name; + + return $this; + } + + /** + * Gets id_check_configuration_name + * @return string + */ + public function getIdCheckConfigurationName() + { + return $this->container['id_check_configuration_name']; + } + + /** + * Sets id_check_configuration_name + * @param string $id_check_configuration_name Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. + * @return $this + */ + public function setIdCheckConfigurationName($id_check_configuration_name) + { + $this->container['id_check_configuration_name'] = $id_check_configuration_name; + + return $this; + } + + /** + * Gets id_check_information_input + * @return \DocuSign\eSign\Model\IdCheckInformationInput + */ + public function getIdCheckInformationInput() + { + return $this->container['id_check_information_input']; + } + + /** + * Sets id_check_information_input + * @param \DocuSign\eSign\Model\IdCheckInformationInput $id_check_information_input + * @return $this + */ + public function setIdCheckInformationInput($id_check_information_input) + { + $this->container['id_check_information_input'] = $id_check_information_input; + + return $this; + } + + /** + * Gets inherit_email_notification_configuration + * @return string + */ + public function getInheritEmailNotificationConfiguration() + { + return $this->container['inherit_email_notification_configuration']; + } + + /** + * Sets inherit_email_notification_configuration + * @param string $inherit_email_notification_configuration When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. + * @return $this + */ + public function setInheritEmailNotificationConfiguration($inherit_email_notification_configuration) + { + $this->container['inherit_email_notification_configuration'] = $inherit_email_notification_configuration; + + return $this; + } + + /** + * Gets is_bulk_recipient + * @return string + */ + public function getIsBulkRecipient() + { + return $this->container['is_bulk_recipient']; + } + + /** + * Sets is_bulk_recipient + * @param string $is_bulk_recipient + * @return $this + */ + public function setIsBulkRecipient($is_bulk_recipient) + { + $this->container['is_bulk_recipient'] = $is_bulk_recipient; + + return $this; + } + + /** + * Gets last_name + * @return string + */ + public function getLastName() + { + return $this->container['last_name']; + } + + /** + * Sets last_name + * @param string $last_name + * @return $this + */ + public function setLastName($last_name) + { + $this->container['last_name'] = $last_name; + + return $this; + } + + /** + * Gets name + * @return string + */ + public function getName() + { + return $this->container['name']; + } + + /** + * Sets name + * @param string $name + * @return $this + */ + public function setName($name) + { + $this->container['name'] = $name; + + return $this; + } + + /** + * Gets note + * @return string + */ + public function getNote() + { + return $this->container['note']; + } + + /** + * Sets note + * @param string $note Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. + * @return $this + */ + public function setNote($note) + { + $this->container['note'] = $note; + + return $this; + } + + /** + * Gets offline_attributes + * @return \DocuSign\eSign\Model\OfflineAttributes + */ + public function getOfflineAttributes() + { + return $this->container['offline_attributes']; + } + + /** + * Sets offline_attributes + * @param \DocuSign\eSign\Model\OfflineAttributes $offline_attributes + * @return $this + */ + public function setOfflineAttributes($offline_attributes) + { + $this->container['offline_attributes'] = $offline_attributes; + + return $this; + } + + /** + * Gets phone_authentication + * @return \DocuSign\eSign\Model\RecipientPhoneAuthentication + */ + public function getPhoneAuthentication() + { + return $this->container['phone_authentication']; + } + + /** + * Sets phone_authentication + * @param \DocuSign\eSign\Model\RecipientPhoneAuthentication $phone_authentication + * @return $this + */ + public function setPhoneAuthentication($phone_authentication) + { + $this->container['phone_authentication'] = $phone_authentication; + + return $this; + } + + /** + * Gets recipient_attachments + * @return \DocuSign\eSign\Model\RecipientAttachment[] + */ + public function getRecipientAttachments() + { + return $this->container['recipient_attachments']; + } + + /** + * Sets recipient_attachments + * @param \DocuSign\eSign\Model\RecipientAttachment[] $recipient_attachments Reserved: + * @return $this + */ + public function setRecipientAttachments($recipient_attachments) + { + $this->container['recipient_attachments'] = $recipient_attachments; + + return $this; + } + + /** + * Gets recipient_authentication_status + * @return \DocuSign\eSign\Model\AuthenticationStatus + */ + public function getRecipientAuthenticationStatus() + { + return $this->container['recipient_authentication_status']; + } + + /** + * Sets recipient_authentication_status + * @param \DocuSign\eSign\Model\AuthenticationStatus $recipient_authentication_status + * @return $this + */ + public function setRecipientAuthenticationStatus($recipient_authentication_status) + { + $this->container['recipient_authentication_status'] = $recipient_authentication_status; + + return $this; + } + + /** + * Gets recipient_id + * @return string + */ + public function getRecipientId() + { + return $this->container['recipient_id']; + } + + /** + * Sets recipient_id + * @param string $recipient_id Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. + * @return $this + */ + public function setRecipientId($recipient_id) + { + $this->container['recipient_id'] = $recipient_id; + + return $this; + } + + /** + * Gets recipient_id_guid + * @return string + */ + public function getRecipientIdGuid() + { + return $this->container['recipient_id_guid']; + } + + /** + * Sets recipient_id_guid + * @param string $recipient_id_guid + * @return $this + */ + public function setRecipientIdGuid($recipient_id_guid) + { + $this->container['recipient_id_guid'] = $recipient_id_guid; + + return $this; + } + + /** + * Gets recipient_signature_providers + * @return \DocuSign\eSign\Model\RecipientSignatureProvider[] + */ + public function getRecipientSignatureProviders() + { + return $this->container['recipient_signature_providers']; + } + + /** + * Sets recipient_signature_providers + * @param \DocuSign\eSign\Model\RecipientSignatureProvider[] $recipient_signature_providers + * @return $this + */ + public function setRecipientSignatureProviders($recipient_signature_providers) + { + $this->container['recipient_signature_providers'] = $recipient_signature_providers; + + return $this; + } + + /** + * Gets recipient_supplies_tabs + * @return string + */ + public function getRecipientSuppliesTabs() + { + return $this->container['recipient_supplies_tabs']; + } + + /** + * Sets recipient_supplies_tabs + * @param string $recipient_supplies_tabs + * @return $this + */ + public function setRecipientSuppliesTabs($recipient_supplies_tabs) + { + $this->container['recipient_supplies_tabs'] = $recipient_supplies_tabs; + + return $this; + } + + /** + * Gets require_id_lookup + * @return string + */ + public function getRequireIdLookup() + { + return $this->container['require_id_lookup']; + } + + /** + * Sets require_id_lookup + * @param string $require_id_lookup When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. + * @return $this + */ + public function setRequireIdLookup($require_id_lookup) + { + $this->container['require_id_lookup'] = $require_id_lookup; + + return $this; + } + + /** + * Gets require_signer_certificate + * @return string + */ + public function getRequireSignerCertificate() + { + return $this->container['require_signer_certificate']; + } + + /** + * Sets require_signer_certificate + * @param string $require_signer_certificate + * @return $this + */ + public function setRequireSignerCertificate($require_signer_certificate) + { + $this->container['require_signer_certificate'] = $require_signer_certificate; + + return $this; + } + + /** + * Gets require_sign_on_paper + * @return string + */ + public function getRequireSignOnPaper() + { + return $this->container['require_sign_on_paper']; + } + + /** + * Sets require_sign_on_paper + * @param string $require_sign_on_paper + * @return $this + */ + public function setRequireSignOnPaper($require_sign_on_paper) + { + $this->container['require_sign_on_paper'] = $require_sign_on_paper; + + return $this; + } + + /** + * Gets role_name + * @return string + */ + public function getRoleName() + { + return $this->container['role_name']; + } + + /** + * Sets role_name + * @param string $role_name Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. + * @return $this + */ + public function setRoleName($role_name) + { + $this->container['role_name'] = $role_name; + + return $this; + } + + /** + * Gets routing_order + * @return string + */ + public function getRoutingOrder() + { + return $this->container['routing_order']; + } + + /** + * Sets routing_order + * @param string $routing_order Specifies the routing order of the recipient in the envelope. + * @return $this + */ + public function setRoutingOrder($routing_order) + { + $this->container['routing_order'] = $routing_order; + + return $this; + } + + /** + * Gets saml_authentication + * @return \DocuSign\eSign\Model\RecipientSAMLAuthentication + */ + public function getSamlAuthentication() + { + return $this->container['saml_authentication']; + } + + /** + * Sets saml_authentication + * @param \DocuSign\eSign\Model\RecipientSAMLAuthentication $saml_authentication + * @return $this + */ + public function setSamlAuthentication($saml_authentication) + { + $this->container['saml_authentication'] = $saml_authentication; + + return $this; + } + + /** + * Gets sent_date_time + * @return string + */ + public function getSentDateTime() + { + return $this->container['sent_date_time']; + } + + /** + * Sets sent_date_time + * @param string $sent_date_time The date and time the envelope was sent. + * @return $this + */ + public function setSentDateTime($sent_date_time) + { + $this->container['sent_date_time'] = $sent_date_time; + + return $this; + } + + /** + * Gets signature_info + * @return \DocuSign\eSign\Model\RecipientSignatureInformation + */ + public function getSignatureInfo() + { + return $this->container['signature_info']; + } + + /** + * Sets signature_info + * @param \DocuSign\eSign\Model\RecipientSignatureInformation $signature_info + * @return $this + */ + public function setSignatureInfo($signature_info) + { + $this->container['signature_info'] = $signature_info; + + return $this; + } + + /** + * Gets signed_date_time + * @return string + */ + public function getSignedDateTime() + { + return $this->container['signed_date_time']; + } + + /** + * Sets signed_date_time + * @param string $signed_date_time Reserved: For DocuSign use only. + * @return $this + */ + public function setSignedDateTime($signed_date_time) + { + $this->container['signed_date_time'] = $signed_date_time; + + return $this; + } + + /** + * Gets sign_in_each_location + * @return string + */ + public function getSignInEachLocation() + { + return $this->container['sign_in_each_location']; + } + + /** + * Sets sign_in_each_location + * @param string $sign_in_each_location When set to **true**, specifies that the signer must sign in all locations. + * @return $this + */ + public function setSignInEachLocation($sign_in_each_location) + { + $this->container['sign_in_each_location'] = $sign_in_each_location; + + return $this; + } + + /** + * Gets signing_group_id + * @return string + */ + public function getSigningGroupId() + { + return $this->container['signing_group_id']; + } + + /** + * Sets signing_group_id + * @param string $signing_group_id When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). + * @return $this + */ + public function setSigningGroupId($signing_group_id) + { + $this->container['signing_group_id'] = $signing_group_id; + + return $this; + } + + /** + * Gets signing_group_name + * @return string + */ + public function getSigningGroupName() + { + return $this->container['signing_group_name']; + } + + /** + * Sets signing_group_name + * @param string $signing_group_name The display name for the signing group. Maximum Length: 100 characters. + * @return $this + */ + public function setSigningGroupName($signing_group_name) + { + $this->container['signing_group_name'] = $signing_group_name; + + return $this; + } + + /** + * Gets signing_group_users + * @return \DocuSign\eSign\Model\UserInfo[] + */ + public function getSigningGroupUsers() + { + return $this->container['signing_group_users']; + } + + /** + * Sets signing_group_users + * @param \DocuSign\eSign\Model\UserInfo[] $signing_group_users A complex type that contains information about users in the signing group. + * @return $this + */ + public function setSigningGroupUsers($signing_group_users) + { + $this->container['signing_group_users'] = $signing_group_users; + + return $this; + } + + /** + * Gets sms_authentication + * @return \DocuSign\eSign\Model\RecipientSMSAuthentication + */ + public function getSmsAuthentication() + { + return $this->container['sms_authentication']; + } + + /** + * Sets sms_authentication + * @param \DocuSign\eSign\Model\RecipientSMSAuthentication $sms_authentication + * @return $this + */ + public function setSmsAuthentication($sms_authentication) + { + $this->container['sms_authentication'] = $sms_authentication; + + return $this; + } + + /** + * Gets social_authentications + * @return \DocuSign\eSign\Model\SocialAuthentication[] + */ + public function getSocialAuthentications() + { + return $this->container['social_authentications']; + } + + /** + * Sets social_authentications + * @param \DocuSign\eSign\Model\SocialAuthentication[] $social_authentications Lists the social ID type that can be used for recipient authentication. + * @return $this + */ + public function setSocialAuthentications($social_authentications) + { + $this->container['social_authentications'] = $social_authentications; + + return $this; + } + + /** + * Gets status + * @return string + */ + public function getStatus() + { + return $this->container['status']; + } + + /** + * Sets status + * @param string $status Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. + * @return $this + */ + public function setStatus($status) + { + $this->container['status'] = $status; + + return $this; + } + + /** + * Gets tabs + * @return \DocuSign\eSign\Model\Tabs + */ + public function getTabs() + { + return $this->container['tabs']; + } + + /** + * Sets tabs + * @param \DocuSign\eSign\Model\Tabs $tabs + * @return $this + */ + public function setTabs($tabs) + { + $this->container['tabs'] = $tabs; + + return $this; + } + + /** + * Gets template_locked + * @return string + */ + public function getTemplateLocked() + { + return $this->container['template_locked']; + } + + /** + * Sets template_locked + * @param string $template_locked When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. + * @return $this + */ + public function setTemplateLocked($template_locked) + { + $this->container['template_locked'] = $template_locked; + + return $this; + } + + /** + * Gets template_required + * @return string + */ + public function getTemplateRequired() + { + return $this->container['template_required']; + } + + /** + * Sets template_required + * @param string $template_required When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. + * @return $this + */ + public function setTemplateRequired($template_required) + { + $this->container['template_required'] = $template_required; + + return $this; + } + + /** + * Gets total_tab_count + * @return string + */ + public function getTotalTabCount() + { + return $this->container['total_tab_count']; + } + + /** + * Sets total_tab_count + * @param string $total_tab_count + * @return $this + */ + public function setTotalTabCount($total_tab_count) + { + $this->container['total_tab_count'] = $total_tab_count; + + return $this; + } + + /** + * Gets user_id + * @return string + */ + public function getUserId() + { + return $this->container['user_id']; + } + + /** + * Sets user_id + * @param string $user_id + * @return $this + */ + public function setUserId($user_id) + { + $this->container['user_id'] = $user_id; + + return $this; + } + + /** + * Gets witness_for + * @return string + */ + public function getWitnessFor() + { + return $this->container['witness_for']; + } + + /** + * Sets witness_for + * @param string $witness_for + * @return $this + */ + public function setWitnessFor($witness_for) + { + $this->container['witness_for'] = $witness_for; + + return $this; + } + + /** + * Gets witness_for_guid + * @return string + */ + public function getWitnessForGuid() + { + return $this->container['witness_for_guid']; + } + + /** + * Sets witness_for_guid + * @param string $witness_for_guid + * @return $this + */ + public function setWitnessForGuid($witness_for_guid) + { + $this->container['witness_for_guid'] = $witness_for_guid; + + return $this; + } + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + 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 + */ + 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 + */ + 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(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); + } + + return json_encode(\DocuSign\eSign\ObjectSerializer::sanitizeForSerialization($this)); + } +} + + diff --git a/src/Model/Zip.php b/src/Model/Zip.php index 61c41607..6e29cb76 100644 --- a/src/Model/Zip.php +++ b/src/Model/Zip.php @@ -87,11 +87,13 @@ class Zip implements ArrayAccess 'sender_required' => 'string', 'shared' => 'string', 'status' => 'string', + 'tab_group_labels' => 'string[]', 'tab_id' => 'string', 'tab_label' => 'string', 'tab_order' => 'string', 'template_locked' => 'string', 'template_required' => 'string', + 'tooltip' => 'string', 'underline' => 'string', 'use_dash4' => 'string', 'validation_message' => 'string', @@ -145,11 +147,13 @@ public static function swaggerTypes() 'sender_required' => 'senderRequired', 'shared' => 'shared', 'status' => 'status', + 'tab_group_labels' => 'tabGroupLabels', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_order' => 'tabOrder', 'template_locked' => 'templateLocked', 'template_required' => 'templateRequired', + 'tooltip' => 'tooltip', 'underline' => 'underline', 'use_dash4' => 'useDash4', 'validation_message' => 'validationMessage', @@ -199,11 +203,13 @@ public static function swaggerTypes() 'sender_required' => 'setSenderRequired', 'shared' => 'setShared', 'status' => 'setStatus', + 'tab_group_labels' => 'setTabGroupLabels', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_order' => 'setTabOrder', 'template_locked' => 'setTemplateLocked', 'template_required' => 'setTemplateRequired', + 'tooltip' => 'setTooltip', 'underline' => 'setUnderline', 'use_dash4' => 'setUseDash4', 'validation_message' => 'setValidationMessage', @@ -253,11 +259,13 @@ public static function swaggerTypes() 'sender_required' => 'getSenderRequired', 'shared' => 'getShared', 'status' => 'getStatus', + 'tab_group_labels' => 'getTabGroupLabels', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_order' => 'getTabOrder', 'template_locked' => 'getTemplateLocked', 'template_required' => 'getTemplateRequired', + 'tooltip' => 'getTooltip', 'underline' => 'getUnderline', 'use_dash4' => 'getUseDash4', 'validation_message' => 'getValidationMessage', @@ -332,11 +340,13 @@ public function __construct(array $data = null) $this->container['sender_required'] = isset($data['sender_required']) ? $data['sender_required'] : null; $this->container['shared'] = isset($data['shared']) ? $data['shared'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; + $this->container['tab_group_labels'] = isset($data['tab_group_labels']) ? $data['tab_group_labels'] : null; $this->container['tab_id'] = isset($data['tab_id']) ? $data['tab_id'] : null; $this->container['tab_label'] = isset($data['tab_label']) ? $data['tab_label'] : null; $this->container['tab_order'] = isset($data['tab_order']) ? $data['tab_order'] : null; $this->container['template_locked'] = isset($data['template_locked']) ? $data['template_locked'] : null; $this->container['template_required'] = isset($data['template_required']) ? $data['template_required'] : null; + $this->container['tooltip'] = isset($data['tooltip']) ? $data['tooltip'] : null; $this->container['underline'] = isset($data['underline']) ? $data['underline'] : null; $this->container['use_dash4'] = isset($data['use_dash4']) ? $data['use_dash4'] : null; $this->container['validation_message'] = isset($data['validation_message']) ? $data['validation_message'] : null; @@ -507,7 +517,7 @@ public function getAnchorXOffset() /** * Sets anchor_x_offset - * @param string $anchor_x_offset Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_x_offset Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorXOffset($anchor_x_offset) @@ -528,7 +538,7 @@ public function getAnchorYOffset() /** * Sets anchor_y_offset - * @param string $anchor_y_offset Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. + * @param string $anchor_y_offset Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. * @return $this */ public function setAnchorYOffset($anchor_y_offset) @@ -1063,6 +1073,27 @@ public function setStatus($status) return $this; } + /** + * Gets tab_group_labels + * @return string[] + */ + public function getTabGroupLabels() + { + return $this->container['tab_group_labels']; + } + + /** + * Sets tab_group_labels + * @param string[] $tab_group_labels + * @return $this + */ + public function setTabGroupLabels($tab_group_labels) + { + $this->container['tab_group_labels'] = $tab_group_labels; + + return $this; + } + /** * Gets tab_id * @return string @@ -1168,6 +1199,27 @@ public function setTemplateRequired($template_required) return $this; } + /** + * Gets tooltip + * @return string + */ + public function getTooltip() + { + return $this->container['tooltip']; + } + + /** + * Sets tooltip + * @param string $tooltip + * @return $this + */ + public function setTooltip($tooltip) + { + $this->container['tooltip'] = $tooltip; + + return $this; + } + /** * Gets underline * @return string @@ -1242,7 +1294,7 @@ public function getValidationPattern() /** * Sets validation_pattern - * @param string $validation_pattern A regular expressionn used to validate input for the tab. + * @param string $validation_pattern A regular expression used to validate input for the tab. * @return $this */ public function setValidationPattern($validation_pattern) diff --git a/src/Swagger/Client/Tests/AccountInformationTest.php b/src/Swagger/Client/Tests/AccountInformationTest.php deleted file mode 100644 index e7c993ca..00000000 --- a/src/Swagger/Client/Tests/AccountInformationTest.php +++ /dev/null @@ -1,70 +0,0 @@ -setApiClient(new DocuSign\eSign\Client\ApiClient()); + + $this->config = $testConfig; + + $oAuth = $this->config->getApiClient()->getOAuth(); + $oAuth->setBasePath($testConfig->getHost()); + $this->scope = [ + DocuSign\eSign\Client\ApiClient::$SCOPE_SIGNATURE, + DocuSign\eSign\Client\ApiClient::$SCOPE_IMPERSONATION + ]; + } + + public function testOauthUri() + { + $uri = $this->config->getApiClient()->getAuthorizationURI($this->config->getIntegratorKey(), $this->scope, $this->config->getReturnUrl(), 'code'); + $this->assertStringEndsWith($this->config->getReturnUrl(), $uri); + echo $uri; + } + + public function testJwtUser() + { + $token = $this->config->getApiClient()->requestJWTUserToken($this->config->getIntegratorKey(), $this->config->getUserId(), $this->config->getClientKey(), $this->scope); + $this->assertInstanceOf('DocuSign\eSign\Client\Auth\OAuthToken', $token[0]); + } + + public function testJwtApplication() + { + $token = $this->config->getApiClient()->requestJWTApplicationToken($this->config->getIntegratorKey(), $this->config->getClientKey(), $this->scope); + $this->assertInstanceOf('DocuSign\eSign\Client\Auth\OAuthToken', $token[0]); + } + + /** + * @depends testOauthUri + */ + public function testAuthorizationCodeLogin() + { + # Use printed URL to navigate through browser for authentication + # IMPORTANT: after the login, DocuSign will send back a fresh + # # authorization code as a query param of the redirect URI. + # # You should set up a route that handles the redirect call to get + # # that code and pass it to token endpoint as shown in the next + # # lines: + # # + # $code = ''; + # $token = $this->config->getApiClient()->generateAccessToken($this->config->getIntegratorKey(), $this->config->getClientSecret(), $code); + + # $this->assertInstanceOf('DocuSign\eSign\Client\Auth\OAuthToken', $token[0]); + + # echo $token[0]; + + # $user = $this->config->getApiClient()->getUserInfo($token[0]['access_token']); + # $this->assertInstanceOf('DocuSign\eSign\Client\Auth\UserInfo', $user[0]); + # $this->assertSame(200, $user[1]); + + # $loginAccount = $user[0]['accounts'][0]; + # if (isset($loginInformation)) { + # $accountId = $loginAccount->getAccountId(); + # if (!empty($accountId)) { + # $this->config->setAccountId($accountId); + # } + # } + } + + +} + +?> \ No newline at end of file diff --git a/test/TestConfig.php b/test/TestConfig.php index 9858d8c9..135f366e 100644 --- a/test/TestConfig.php +++ b/test/TestConfig.php @@ -2,18 +2,6 @@ class TestConfig { - /** - * $username Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - * @var string - */ - protected $username; - - /** - * $password - * @var string - */ - protected $password; - /** * $integratorKey * @var string @@ -28,7 +16,7 @@ class TestConfig /** * $apiClient - * @var DocuSign\eSign\ApiClient + * @var DocuSign\eSign\Client\ApiClient */ protected $apiClient; @@ -86,63 +74,40 @@ class TestConfig */ protected $clientUserId; - public function __construct($username = null, $password = null, $integratorKey = null, $host = null, $returnUrl = null) + /** + * $clientSecret + * @var string + */ + protected $clientSecret; + + /** + * $clientKey + * @var string + */ + protected $clientKey; + + protected $userId; + + public function __construct($integratorKey = null, $host = null, $returnUrl = null, $envelopeId = null, $secret = null, $key = null, $userId = null) { $this->host = !empty($host) ? $host : "https://demo.docusign.net/restapi"; - $this->username = !empty($username) ? $username : 'node_sdk@mailinator.com'; - $this->password = !empty($password) ? $password : '{PASSWORD}'; $this->integratorKey = !empty($integratorKey) ? $integratorKey : 'ae30ea4e-xxxx-xxxx-xxxx-fcb57d2dc4df'; + $this->clientSecret = !empty($secret) ? $secret : 'b4dccdbe-xxxx-xxxx-xxxx-b2f0f7448f8f'; + $this->clientKey = !empty($key) ? $key : 'Docs/private.pem'; $this->recipientEmail = !empty($recipientEmail) ? $recipientEmail : 'node_sdk@mailinator.com'; - $this->recipientName = !empty($recipientName) ? $recipientName : 'Pat Developer'; + $this->recipientName = !empty($recipientName) ? $recipientName : 'PHP SDK'; - $this->templateRoleName = !empty($templateRoleName) ? $templateRoleName : 'Needs to sign'; + $this->templateRoleName = !empty($templateRoleName) ? $templateRoleName : 'Manager'; $this->templateId = !empty($templateId) ? $templateId : 'cf2a46c2-xxxx-xxxx-xxxx-752547b1a419'; - $this->returnUrl = !empty($returnUrl) ? $returnUrl : 'https://www.docusign.com/devcenter'; + $this->returnUrl = !empty($returnUrl) ? $returnUrl : 'https://www.docusign.com/api'; - $this->clientUserId = "1234"; - } + $this->envelopeId = !empty($envelopeId) ? $envelopeId : ''; + $this->userId = !empty($userId) ? $userId : 'fcc5726c-xxxx-xxxx-xxxx-40bbbe6ca126'; //can be taken from generateAccessToken returned result - /** - * Gets username - * @return string - */ - public function getUsername() - { - return $this->username; + $this->clientUserId = "1234"; } - - /** - * Sets username - * @param string $username - * @return $this - */ - public function setUsername($username) - { - $this->username = $username; - return $this; - } - - /** - * Gets password - * @return string - */ - public function getPassword() - { - return $this->password; - } - - /** - * Sets password - * @param string $password - * @return $this - */ - public function setPassword($password) - { - $this->password = $password; - return $this; - } /** * Gets integratorKey @@ -186,7 +151,7 @@ public function setHost($host) /** * Gets apiClient - * @return DocuSign\eSign\ApiClient + * @return DocuSign\eSign\Client\ApiClient */ public function getApiClient() { @@ -195,7 +160,7 @@ public function getApiClient() /** * Sets apiClient - * @param DocuSign\eSign\ApiClient $apiClient + * @param DocuSign\eSign\Client\ApiClient $apiClient * @return $this */ public function setApiClient($apiClient) @@ -383,6 +348,66 @@ public function setClientUserId($clientUserId) $this->clientUserId = $clientUserId; return $this; } + + /** + * Gets client secret + * @return string + */ + public function getClientSecret() + { + return $this->clientSecret; + } + + /** + * Sets client secret + * @param string $clientSecret + * @return $this + */ + public function setClientSecret($clientSecret) + { + $this->clientSecret = $clientSecret; + return $this; + } + + /** + * Gets client key + * @return string + */ + public function getClientKey() + { + return file_get_contents($this->clientKey); + } + + /** + * Sets client key + * @param string $clientKey + * @return $this + */ + public function setClientKey($clientKey) + { + $this->clientKey = $clientKey; + return $this; + } + + /** + * Gets client key + * @return string + */ + public function getUserId() + { + return $this->userId; + } + + /** + * UserId + * @param string $userId + * @return $this + */ + public function setUserId($userId) + { + $this->userId = $userId; + return $this; + } } ?> diff --git a/test/TestConfig.php-sample b/test/TestConfig.php-sample index a1d6dde7..49a94d3b 100644 --- a/test/TestConfig.php-sample +++ b/test/TestConfig.php-sample @@ -28,7 +28,7 @@ class TestConfig /** * $apiClient - * @var DocuSign\eSign\ApiClient + * @var DocuSign\eSign\Client\ApiClient */ protected $apiClient; @@ -186,7 +186,7 @@ class TestConfig /** * Gets apiClient - * @return DocuSign\eSign\ApiClient + * @return DocuSign\eSign\Client\ApiClient */ public function getApiClient() { @@ -195,7 +195,7 @@ class TestConfig /** * Sets apiClient - * @param DocuSign\eSign\ApiClient $apiClient + * @param DocuSign\eSign\Client\ApiClient $apiClient * @return $this */ public function setApiClient($apiClient) diff --git a/test/UnitTests.php b/test/UnitTests.php index 5ec99fa2..310e77f5 100644 --- a/test/UnitTests.php +++ b/test/UnitTests.php @@ -4,136 +4,166 @@ * Date: 1/25/16 * Time: 4:58 PM */ + +use PHPUnit\Framework\TestCase; -class UnitTests extends PHPUnit_Framework_TestCase +class UnitTests extends TestCase { - /* + + /* * Test 0 - login */ - public function testLogin() - { - $username = null; - $password = null; - $integratorKey = null; - $host = null; + public function testLogin() + { + $testConfig = new TestConfig(); - $testConfig = new TestConfig($username, $password, $integratorKey, $host); + $config = new DocuSign\eSign\Configuration(); + $config->setHost($testConfig->getHost()); - $config = new DocuSign\eSign\Configuration(); - $config->setHost($testConfig->getHost()); - $config->addDefaultHeader("X-DocuSign-Authentication", "{\"Username\":\"" . $testConfig->getUsername() . "\",\"Password\":\"" . $testConfig->getPassword() . "\",\"IntegratorKey\":\"" . $testConfig->getIntegratorKey() . "\"}"); + $testConfig->setApiClient(new DocuSign\eSign\Client\ApiClient($config)); + $testConfig->getApiClient()->getOAuth()->setBasePath($testConfig->getHost()); - $testConfig->setApiClient(new DocuSign\eSign\ApiClient($config)); + $token = $testConfig->getApiClient()->requestJWTUserToken($testConfig->getIntegratorKey(),$testConfig->getUserId(), $testConfig->getClientKey()); + $this->assertInstanceOf('DocuSign\eSign\Client\Auth\OAuthToken', $token[0]); + $this->assertArrayHasKey('access_token', $token[0]); - $authenticationApi = new DocuSign\eSign\Api\AuthenticationApi($testConfig->getApiClient()); + $user = $testConfig->getApiClient()->getUserInfo($token[0]['access_token']); - $options = new \DocuSign\eSign\Api\AuthenticationApi\LoginOptions(); + $this->assertNotEmpty($user); + $this->assertEquals($user[1], 200); - $loginInformation = $authenticationApi->login($options); - if(isset($loginInformation) && count($loginInformation) > 0) - { - $loginAccount = $loginInformation->getLoginAccounts()[0]; - if(isset($loginInformation)) - { - $accountId = $loginAccount->getAccountId(); - if(!empty($accountId)) - { - $testConfig->setAccountId($accountId); - } - } - } + $this->assertInstanceOf('DocuSign\eSign\Client\Auth\UserInfo', $user[0]); + $this->assertNotEmpty($user[0]); + + $this->assertArrayHasKey('accounts', $user[0]); + $loginAccount = $user[0]['accounts'][0]; + $accountId = $loginAccount->getAccountId(); + + $this->assertNotEmpty($accountId); + + $testConfig->setAccountId($accountId); + + return $testConfig; + } + + /** + * + * Test creating envelop process + * + * @param $testConfig + * @return mixed + * @throws \DocuSign\eSign\Client\ApiException + * @depends testLogin + */ + function testCreateEnvelope($testConfig) + { + $templateRole = new DocuSign\eSign\Model\TemplateRole(); + $templateRole->setEmail($testConfig->getRecipientEmail()); + $templateRole->setName($testConfig->getRecipientName()); + $templateRole->setRoleName($testConfig->getTemplateRoleName()); + + $definitionData = [ + 'email_subject' => 'Please Sign my PHP SDK Envelope', + 'email_blurb' => 'Hello, Please sign my PHP SDK Envelope.', + 'template_id' => $testConfig->getTemplateId(), + 'status' => 'sent' //send the envelope by setting |status| to "sent". To save as a draft set to "created" + ]; + $envelopeDefinition = new DocuSign\eSign\Model\EnvelopeDefinition($definitionData); + $envelopeDefinition->setTemplateRoles(array($templateRole)); + + $envelopeApi = new DocuSign\eSign\Api\EnvelopesApi($testConfig->getApiClient()); + $envelopeSummary = $envelopeApi->createEnvelope($testConfig->getAccountId(), $envelopeDefinition); + + $this->assertNotEmpty($envelopeSummary); + $this->assertInstanceOf('DocuSign\eSign\Model\EnvelopeSummary', $envelopeSummary); + $this->assertNotEmpty($envelopeSummary->getEnvelopeId()); + + $testConfig->setEnvelopeId($envelopeSummary->getEnvelopeId()); + + return $testConfig; + } - return $testConfig; - } - function signatureRequestOnDocument($testConfig, $status = "sent", $embeddedSigning = false) + /** + * @depends testLogin + */ + public function testSignatureRequestOnDocument($testConfig, $embeddedSigning = false) + { + return $this->signatureRequestOnDocument($testConfig, "sent", $embeddedSigning); + } + + /** + * @depends testLogin + */ + public function testSignatureRequestOnDocumentCreated($testConfig, $embeddedSigning = false) + { + return $this->signatureRequestOnDocument($testConfig, "created", $embeddedSigning); + } + + function signatureRequestOnDocument($testConfig, $status = "sent", $embeddedSigning = false) { $documentFileName = "/Docs/SignTest1.pdf"; $documentName = "SignTest1.docx"; $envelop_summary = null; - if(!empty($testConfig->getAccountId())) - { - $envelopeApi = new DocuSign\eSign\Api\EnvelopesApi($testConfig->getApiClient()); - - // Add a document to the envelope - $document = new DocuSign\eSign\Model\Document(); - $document->setDocumentBase64(base64_encode(file_get_contents(__DIR__ . $documentFileName))); - $document->setName($documentName); - $document->setDocumentId("1"); - - // Create a |SignHere| tab somewhere on the document for the recipient to sign - $signHere = new \DocuSign\eSign\Model\SignHere(); - $signHere->setXPosition("100"); - $signHere->setYPosition("100"); - $signHere->setDocumentId("1"); - $signHere->setPageNumber("1"); - $signHere->setRecipientId("1"); - - $tabs = new DocuSign\eSign\Model\Tabs(); - $tabs->setSignHereTabs(array($signHere)); - - $signer = new \DocuSign\eSign\Model\Signer(); - $signer->setEmail($testConfig->getRecipientEmail()); - $signer->setName($testConfig->getRecipientName()); - $signer->setRecipientId("1"); - if($embeddedSigning) { - $signer->setClientUserId($testConfig->getClientUserId()); - } - - $signer->setTabs($tabs); + $envelopeApi = new DocuSign\eSign\Api\EnvelopesApi($testConfig->getApiClient()); - // Add a recipient to sign the document - $recipients = new DocuSign\eSign\Model\Recipients(); - $recipients->setSigners(array($signer)); + // Add a document to the envelope + $document = new DocuSign\eSign\Model\Document(); + $document->setDocumentBase64(base64_encode(file_get_contents(__DIR__ . $documentFileName))); + $document->setName($documentName); + $document->setDocumentId("1"); - $envelop_definition = new DocuSign\eSign\Model\EnvelopeDefinition(); - $envelop_definition->setEmailSubject("[DocuSign PHP SDK] - Please sign this doc"); + // Create a |SignHere| tab somewhere on the document for the recipient to sign + $signHere = new \DocuSign\eSign\Model\SignHere(); + $signHere->setXPosition("100"); + $signHere->setYPosition("100"); + $signHere->setDocumentId("1"); + $signHere->setPageNumber("1"); + $signHere->setRecipientId("1"); - // set envelope status to "sent" to immediately send the signature request - $envelop_definition->setStatus($status); - $envelop_definition->setRecipients($recipients); - $envelop_definition->setDocuments(array($document)); + $tabs = new DocuSign\eSign\Model\Tabs(); + $tabs->setSignHereTabs(array($signHere)); - $options = new \DocuSign\eSign\Api\EnvelopesApi\CreateEnvelopeOptions(); - $options->setCdseMode(null); - $options->setMergeRolesOnDraft(null); + $signer = new \DocuSign\eSign\Model\Signer(); + $signer->setEmail($testConfig->getRecipientEmail()); + $signer->setName($testConfig->getRecipientName()); + $signer->setRecipientId("1"); + if ($embeddedSigning) { + $signer->setClientUserId($testConfig->getClientUserId()); + } - $envelop_summary = $envelopeApi->createEnvelope($testConfig->getAccountId(), $envelop_definition, $options); - if(!empty($envelop_summary)) - { - if($status == "created") - { - $testConfig->setCreatedEnvelopeId($envelop_summary->getEnvelopeId()); - } - else - { - $testConfig->setEnvelopeId($envelop_summary->getEnvelopeId()); - } - } - } + $signer->setTabs($tabs); -// $this->assertNotEmpty($envelop_summary); - return $testConfig; - } + // Add a recipient to sign the document + $recipients = new DocuSign\eSign\Model\Recipients(); + $recipients->setSigners(array($signer)); - - /** - * @depends testLogin - */ - public function testSignatureRequestOnDocument($testConfig, $embeddedSigning = false) - { - return $this->signatureRequestOnDocument($testConfig, "sent", $embeddedSigning); - } + $envelop_definition = new DocuSign\eSign\Model\EnvelopeDefinition(); + $envelop_definition->setEmailSubject("[DocuSign PHP SDK] - Please sign this doc"); - /** - * @depends testLogin - */ - public function testSignatureRequestOnDocumentCreated($testConfig, $embeddedSigning = false) - { - return $this->signatureRequestOnDocument($testConfig, "created", $embeddedSigning); + // set envelope status to "sent" to immediately send the signature request + $envelop_definition->setStatus($status); + $envelop_definition->setRecipients($recipients); + $envelop_definition->setDocuments(array($document)); + + $options = new \DocuSign\eSign\Api\EnvelopesApi\CreateEnvelopeOptions(); + $options->setCdseMode(null); + $options->setMergeRolesOnDraft(null); + + $envelop_summary = $envelopeApi->createEnvelope($testConfig->getAccountId(), $envelop_definition, $options); + + $this->assertNotEmpty($envelop_summary); + + if ($status == "created") { + $testConfig->setCreatedEnvelopeId($envelop_summary->getEnvelopeId()); + } else { + $testConfig->setEnvelopeId($envelop_summary->getEnvelopeId()); + } + + return $testConfig; } /** @@ -143,37 +173,35 @@ public function testRequestSignatureFromTemplate($testConfig) { $envelop_summary = null; - if(!empty($testConfig->getAccountId())) - { - $envelopeApi = new DocuSign\eSign\Api\EnvelopesApi($testConfig->getApiClient()); - // assign recipient to template role by setting name, email, and role name. Note that the - // template role name must match the placeholder role name saved in your account template. - $templateRole = new DocuSign\eSign\Model\TemplateRole(); - $templateRole->setEmail($testConfig->getRecipientEmail()); - $templateRole->setName($testConfig->getRecipientName()); - $templateRole->setRoleName($testConfig->getTemplateRoleName()); + $envelopeApi = new DocuSign\eSign\Api\EnvelopesApi($testConfig->getApiClient()); - $envelop_definition = new DocuSign\eSign\Model\EnvelopeDefinition(); - $envelop_definition->setEmailSubject("[DocuSign PHP SDK] - Please sign this template doc"); + // assign recipient to template role by setting name, email, and role name. Note that the + // template role name must match the placeholder role name saved in your account template. + $templateRole = new DocuSign\eSign\Model\TemplateRole(); + $templateRole->setEmail($testConfig->getRecipientEmail()); + $templateRole->setName($testConfig->getRecipientName()); + $templateRole->setRoleName($testConfig->getTemplateRoleName()); - // add the role to the envelope and assign valid templateId from your account - $envelop_definition->setTemplateRoles(array($templateRole)); - $envelop_definition->setTemplateId($testConfig->getTemplateId()); + $envelop_definition = new DocuSign\eSign\Model\EnvelopeDefinition(); + $envelop_definition->setEmailSubject("[DocuSign PHP SDK] - Please sign this template doc"); - // set envelope status to "sent" to immediately send the signature request - $envelop_definition->setStatus("sent"); + // add the role to the envelope and assign valid templateId from your account + $envelop_definition->setTemplateRoles(array($templateRole)); + $envelop_definition->setTemplateId($testConfig->getTemplateId()); - $options = new \DocuSign\eSign\Api\EnvelopesApi\CreateEnvelopeOptions(); - $options->setCdseMode(null); - $options->setMergeRolesOnDraft(null); + // set envelope status to "sent" to immediately send the signature request + $envelop_definition->setStatus("sent"); - $envelop_summary = $envelopeApi->createEnvelope($testConfig->getAccountId(), $envelop_definition, $options); - if(!empty($envelop_summary)) - { + $options = new \DocuSign\eSign\Api\EnvelopesApi\CreateEnvelopeOptions(); + $options->setCdseMode(null); + $options->setMergeRolesOnDraft(null); + + $envelop_summary = $envelopeApi->createEnvelope($testConfig->getAccountId(), $envelop_definition, $options); + if(!empty($envelop_summary)) + { // $testConfig->setEnvelopeId($envelop_summary->getEnvelopeId()); - } - } + } $this->assertNotEmpty($envelop_summary); @@ -220,29 +248,29 @@ public function testListStatusChanges($testConfig) $envelopeApi = new DocuSign\eSign\Api\EnvelopesApi($testConfig->getApiClient()); $options = new \DocuSign\eSign\Api\EnvelopesApi\ListStatusChangesOptions(); - $options->setInclude(null); - $options->setPowerformids(null); +// $options->setInclude(null); +// $options->setPowerformids(null); $options->setAcStatus(null); $options->setBlock(null); - $options->setSearchText(null); +// $options->setSearchText(null); $options->setStartPosition(null); $options->setStatus(null); $options->setToDate(null); $options->setTransactionIds(null); - $options->setUserFilter(null); - $options->setFolderTypes(null); - $options->setUserId(null); +// $options->setUserFilter(null); +// $options->setFolderTypes(null); +// $options->setUserId(null); $options->setCount(10); $options->setEmail(null); $options->setEnvelopeIds(null); - $options->setExclude(null); - $options->setFolderIds(null); +// $options->setExclude(null); +// $options->setFolderIds(null); $options->setFromDate(date("Y-m-d", strtotime("-30 days"))); $options->setCustomField(null); $options->setFromToStatus(null); - $options->setIntersectingFolderIds(null); - $options->setOrder(null); - $options->setOrderBy(null); +// $options->setIntersectingFolderIds(null); +// $options->setOrder(null); +// $options->setOrderBy(null); $options->setUserName(null); $envelopesInformation = $envelopeApi->listStatusChanges($testConfig->getAccountId(), $options); diff --git a/test/bootstrap.php b/test/bootstrap.php index 5bd48af4..9b65b7ba 100644 --- a/test/bootstrap.php +++ b/test/bootstrap.php @@ -1,4 +1,4 @@ - - - ./ - - - + + + + + ./ + + + + + + ./src/Api + ./src/Client + ./src/Model + +